6.13. Creating and configuring repositories by using the Red Hat Quay API

Procedure

1. Enter the following command to create a repository using the POST /api/v1/repository endpoint:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "repository": "<new_repository_name>",
       "visibility": "<private>",
       "description": "<This is a description of the new repository>."
     }' \
     "https://quay-server.example.com/api/v1/repository"

   Example output

   {"namespace": "quayadmin", "name": "<new_repository_name>", "kind": "image"}

2. You can list a repositories with the GET /api/v1/repository endpoint. For example:

   $ curl -X GET \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     "https://quay-server.example.com/api/v1/repository?public=true&starred=false&namespace=<NAMESPACE>"

   Example output

   {"repositories": [{"namespace": "quayadmin", "name": "busybox", "description": null, "is_public": false, "kind": "image", "state": "MIRROR", "is_starred": false, "quota_report": {"quota_bytes": 2280675, "configured_quota": 2199023255552}}]}

3. Visibility can be changed from public to private with the POST /api/v1/repository/{repository}/changevisibility endpoint:

   $ curl -X POST \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "Content-Type: application/json" \
     -d '{
           "visibility": "private"
         }' \
     "https://quay-server.example.com/api/v1/repository/<NAMESPACE>/<REPO_NAME>/changevisibility"

   Example output

   {"success": true}

4. You can check the Red Hat Quay UI, or you can enter the following GET /api/v1/repository/{repository} command to return details about a repository:

   $ curl -X GET -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

   Example output

   {"detail": "Not Found", "error_message": "Not Found", "error_type": "not_found", "title": "not_found", "type": "http://quay-server.example.com/api/v1/error/not_found", "status": 404}

5. Repository descriptions can be updated with the PUT /api/v1/repository/{repository} endpoint:

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "description": "This is an updated description for the repository."
         }' \
     "https://quay-server.example.com/api/v1/repository/<NAMESPACE>/<REPOSITORY>"

   Example output

   {"success": true}

6. Enter the following command to delete a repository using the DELETE /api/v1/repository/{repository} endpoint:

   $ curl -X DELETE   -H "Authorization: Bearer <bearer_token>" "<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>"

   This command does not return output in the CLI.