Chapter 6. Red Hat Quay API examples

Procedure

1. Use the GET /api/v1/user/aggregatelogs API endpoint to return the aggregated (or grouped) logs for the current user:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "https://<quay-server.example.com>/api/v1/user/aggregatelogs"

   Example output

   {"aggregated": [{"kind": "create_tag", "count": 1, "datetime": "Tue, 18 Jun 2024 00:00:00 -0000"}, {"kind": "manifest_label_add", "count": 1, "datetime": "Tue, 18 Jun 2024 00:00:00 -0000"}, {"kind": "push_repo", "count": 2, "datetime": "Tue, 18 Jun 2024 00:00:00 -0000"}, {"kind": "revert_tag", "count": 1, "datetime": "Tue, 18 Jun 2024 00:00:00 -0000"}]}

   You can also pass in the performer and starttime/endtime queries to obtain aggregated logs for a specific user between a specific time period. For example:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "<quay-server.example.com>/api/v1/user/aggregatelogs?performer=<username>&starttime=<MM/DD/YYYY>&endtime=<MM/DD/YYYY>"

2. Aggregated logs can also be viewed by Organization by using the GET /api/v1/organization/{orgname}/aggregatelogs. For example:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"

3. Aggregated logs can also be viewed by repository by using the GET /api/v1/repository/{repository}/aggregatelogs command. The following example includes the starttime/endtime fields:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "<quay-server.example.com>/api/v1/repository/<repository_name>/<namespace>/aggregatelogs?starttime=2024-01-01&endtime=2024-06-18""

Procedure

1. Use the GET /api/v1/user/logs API endpoint to return a list of log entries for a user. For example:

   $ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "<quay-server.example.com>/api/v1/user/logs"

   You can also pass in the performer and startime/endtime queries to obtain logs for a specific user between a specific time period. For example:

   $ curl -X GET   -H "Authorization: Bearer <bearer_token>"   -H "Accept: application/json"   "http://quay-server.example.com/api/v1/user/logs?performer=quayuser&starttime=01/01/2024&endtime=06/18/2024"

   Example output

   ---
   {"start_time": "Mon, 01 Jan 2024 00:00:00 -0000", "end_time": "Wed, 19 Jun 2024 00:00:00 -0000", "logs": [{"kind": "revert_tag", "metadata": {"username": "quayuser", "repo": "busybox", "tag": "test-two", "manifest_digest": "sha256:57583a1b9c0a7509d3417387b4f43acf80d08cdcf5266ac87987be3f8f919d5d"}, "ip": "192.168.1.131", "datetime": "Tue, 18 Jun 2024 18:59:13 -0000", "performer": {"kind": "user", "name": "quayuser", "is_robot": false, "avatar": {"name": "quayuser", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}}}, {"kind": "push_repo", "metadata": {"repo": "busybox", "namespace": "quayuser", "user-agent": "containers/5.30.1 (github.com/containers/image)", "tag": "test-two", "username": "quayuser", }
   ---

2. Use the GET /api/v1/organization/{orgname}/logs endpoint to return logs for a specified organization:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"

3. Use the GET /api/v1/repository/{repository}/logs endpoint to return logs for a specified repository:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     "http://<quay-server.example.com>/api/v1/repository/{repository}/logs"

Procedure

1. To set a quota for an organization, you can use the POST /api/v1/organization/{orgname}/quota endpoint:

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota" \
        -H "Authorization: Bearer <access_token>" \
        -H "Content-Type: application/json" \
        -d '{
            "limit_bytes": 10737418240,
            "limits": "10 Gi"
        }'

   Example output

   "Created"

2. Use the GET /api/v1/organization/{orgname}/quota command to return information about the policy, including the ID number, which is required for other organization quota endpoints. For example:

   $ curl -k -X GET -H "Authorization: Bearer <token>" -H 'Content-Type: application/json'  https://example-registry-quay-quay-enterprise.apps.docs.gcp.quaydev.org/api/v1/organization/testorg/quota  | jq

   Example output

   [{"id": 1, "limit_bytes": 10737418240, "limit": "10.0 GiB", "default_config": false, "limits": [], "default_config_exists": false}]

   After you obtain the ID number, you can use the GET /api/v1/organization/{orgname}/quota/{quota_id} command to list the quota policy. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
        -H "Authorization: Bearer <access_token>"

   Example output

   {"id": 1, "limit_bytes": 10737418240, "limit": "10.0 GiB", "default_config": false, "limits": [], "default_config_exists": false}

3. You can use the PUT /api/v1/organization/{orgname}/quota/{quota_id} command to modify the existing quota limitation. Note that this requires the policy ID. For example:

   $ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
        -H "Authorization: Bearer <access_token>" \
        -H "Content-Type: application/json" \
        -d '{
            "limit_bytes": <limit_in_bytes>
        }'

   Example output

   {"id": 1, "limit_bytes": 21474836480, "limit": "20.0 GiB", "default_config": false, "limits": [], "default_config_exists": false}

4. An organization’s quota can be deleted with the DELETE /api/v1/organization/{orgname}/quota/{quota_id} command. For example:

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
        -H "Authorization: Bearer <access_token>"

   This command does not return output.

Procedure

1. Use the POST /api/v1/organization/{orgname}/quota/{quota_id}/limit command to create a quota policy that rejects images if they exceeded the allotted quota. For example:

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit" \
        -H "Authorization: Bearer <access_token>" \
        -H "Content-Type: application/json" \
        -d '{
              "limit_bytes": 21474836480,
              "type": "Reject", 1
              "threshold_percent": 90 2
            }'

   1

   One of Reject or Warning.

   2

   Quota threshold, in percent of quota.

   Example output

   "Created"

2. Use the GET /api/v1/organization/{orgname}/quota/{quota_id}/limit to obtain the ID of the quota limit. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit" \
        -H "Authorization: Bearer <access_token>"

   Example output

   [{"id": 2, "type": "Reject", "limit_percent": 90}]

1. Update the policy with the PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id} endpoint. For example:

   $ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
        -H "Authorization: Bearer <access_token>" \
        -H "Content-Type: application/json" \
        -d '{
              "type": "<type>",
              "threshold_percent": <threshold_percent>
            }'

   Example output

   {"id": 3, "limit_bytes": 10737418240, "limit": "10.0 GiB", "default_config": false, "limits": [{"id": 2, "type": "Warning", "limit_percent": 80}], "default_config_exists": false}

2. You can delete the quota limit with the DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id} endpoint:

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
        -H "Authorization: Bearer <access_token>"

   This command does not return output.

Procedure

1. Use the GET /api/v1/user/quota command to return information about the quota limitations:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota" \
     -H "Authorization: Bearer <access_token>"

   Example output

   [{"id": 4, "limit_bytes": 2199023255552, "limit": "2.0 TiB", "default_config": false, "limits": [], "default_config_exists": false}]

2. After you have received the quota ID, you can pass it in with the GET /api/v1/user/quota/{quota_id} endpoint to return information about the limitation:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"id": 4, "limit_bytes": 2199023255552, "limit": "2.0 TiB", "default_config": false, "limits": [], "default_config_exists": false}

3. The limitations can be viewed by using the GET /api/v1/user/quota/{quota_id}/limit endpoint. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}/limit" \
     -H "Authorization: Bearer <access_token>"

   Example output

   [{"id": 3, "type": "Reject", "limit_percent": 100}]

4. Additional information about the entire policy can be returned using the GET /api/v1/user/quota/{quota_id}/limit/{limit_id} endpoint:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}/limit/{limit_id}" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"id": 4, "limit_bytes": 2199023255552, "limit": "2.0 TiB", "default_config": false, "limits": [{"id": 3, "type": "Reject", "limit_percent": 100}], "default_config_exists": false}

Procedure

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

   $ curl -X POST   -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json"   -d '{
       "name": "<new_organization_name>"
     }'   "https://<quay-server.example.com>/api/v1/organization/"

   Example output

   "Created"

2. After creation, organization details can be changed, such as adding an email address, with the PUT /api/v1/organization/{orgname} command. For example:

   $ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>" \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "email": "<org_email>",
           "invoice_email": <true/false>,
           "invoice_email_address": "<billing_email>"
         }'

   Example output

   {"name": "test", "email": "new-contact@test-org.com", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "user"}, "is_admin": true, "is_member": true, "teams": {"owners": {"name": "owners", "description": "", "role": "admin", "avatar": {"name": "owners", "hash": "6f0e3a8c0eb46e8834b43b03374ece43a030621d92a7437beb48f871e90f8d90", "color": "#c7c7c7", "kind": "team"}, "can_view": true, "repo_count": 0, "member_count": 1, "is_synced": false}}, "ordered_teams": ["owners"], "invoice_email": true, "invoice_email_address": "billing@test-org.com", "tag_expiration_s": 1209600, "is_free_account": true, "quotas": [{"id": 2, "limit_bytes": 10737418240, "limits": [{"id": 1, "type": "Reject", "limit_percent": 90}]}], "quota_report": {"quota_bytes": 0, "configured_quota": 10737418240, "running_backfill": "complete", "backfill_status": "complete"}}

Procedure

1. Enter the following command to delete an organization using the DELETE /api/v1/organization/{orgname} endpoint:

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     "https://<quay-server.example.com>/api/v1/organization/<organization_name>"

2. The CLI does not return information when deleting an organization from the CLI. To confirm deletion, you can check the Red Hat Quay UI, or you can enter the GET /api/v1/organization/{orgname} command to see if details are returned for the deleted organization:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     "<quay-server.example.com>/api/v1/organization/<organization_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}

Procedure

1. Use the GET /api/v1/organization/{orgname}/members to return a list of organization members:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"members": [{"name": "quayadmin", "kind": "user", "avatar": {"name": "quayadmin", "hash": "6d640d802fe23b93779b987c187a4b7a4d8fbcbd4febe7009bdff58d84498fba", "color": "#f7b6d2", "kind": "user"}, "teams": [{"name": "owners", "avatar": {"name": "owners", "hash": "6f0e3a8c0eb46e8834b43b03374ece43a030621d92a7437beb48f871e90f8d90", "color": "#c7c7c7", "kind": "team"}}], "repositories": ["testrepo"]}, {"name": "testuser", "kind": "user", "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}, "teams": [{"name": "owners", "avatar": {"name": "owners", "hash": "6f0e3a8c0eb46e8834b43b03374ece43a030621d92a7437beb48f871e90f8d90", "color": "#c7c7c7", "kind": "team"}}], "repositories": []}]}

2. You can use the GET /api/v1/organization/{orgname}/collaborators to return a list of organization collaborators:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/collaborators" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"collaborators": [user-test]}

3. Use the GET /api/v1/organization/{orgname}/members/{membername} endpoint to obtain more specific information about a user:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"name": "quayadmin", "kind": "user", "avatar": {"name": "quayadmin", "hash": "6d640d802fe23b93779b987c187a4b7a4d8fbcbd4febe7009bdff58d84498fba", "color": "#f7b6d2", "kind": "user"}, "teams": [{"name": "owners", "avatar": {"name": "owners", "hash": "6f0e3a8c0eb46e8834b43b03374ece43a030621d92a7437beb48f871e90f8d90", "color": "#c7c7c7", "kind": "team"}}], "repositories": ["testrepo"]}

4. Use the DELETE /api/v1/organization/{orgname}/members/{membername} endpoint to delete a team member.

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/members/<membername>" \
     -H "Authorization: Bearer <access_token>"

   This command does not return output.

Procedure

1. Use the POST /api/v1/organization/{orgname}/applications endpoint to create a new application for your organization. For example:

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications" \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "<app_name>",
           "redirect_uri": "<redirect_uri>",
           "application_uri": "<application_uri>",
           "description": "<app_description>",
           "avatar_email": "<avatar_email>"
         }'

   Example output

   {"name": "new-application", "description": "", "application_uri": "", "client_id": "E6GJSHOZMFBVNHTHNB53", "client_secret": "SANSWCWSGLVAUQ60L4Q4CEO3C1QAYGEXZK2VKJNI", "redirect_uri": "", "avatar_email": null}

2. Use the GET /api/v1/organization/{orgname}/applications endpoint to return a list of all organization applications. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"applications": [{"name": "test", "description": "", "application_uri": "", "client_id": "MCJ61D8KQBFS2DXM56S2", "client_secret": "J5G7CCX5QCA8Q5XZLWGI7USJPSM4M5MQHJED46CF", "redirect_uri": "", "avatar_email": null}, {"name": "new-token", "description": "", "application_uri": "", "client_id": "IG58PX2REEY9O08IZFZE", "client_secret": "2LWTWO89KH26P2CO4TWFM7PGCX4V4SUZES2CIZMR", "redirect_uri": "", "avatar_email": null}, {"name": "second-token", "description": "", "application_uri": "", "client_id": "6XBK7QY7ACSCN5XBM3GS", "client_secret": "AVKBOUXTFO3MXBBK5UJD5QCQRN2FWL3O0XPZZT78", "redirect_uri": "", "avatar_email": null}, {"name": "new-application", "description": "", "application_uri": "", "client_id": "E6GJSHOZMFBVNHTHNB53", "client_secret": "SANSWCWSGLVAUQ60L4Q4CEO3C1QAYGEXZK2VKJNI", "redirect_uri": "", "avatar_email": null}]}

   Applications can also be returned for a specific client using the GET /api/v1/organization/{orgname}/applications/{client_id} endpoint. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/applications/<client_id>" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"name": "test", "description": "", "application_uri": "", "client_id": "MCJ61D8KQBFS2DXM56S2", "client_secret": "J5G7CCX5QCA8Q5XZLWGI7USJPSM4M5MQHJED46CF", "redirect_uri": "", "avatar_email": null}

3. After creation, organization applications can be updated, for example, if you want to add a redirect URI or a new description, using the PUT /api/v1/organization/{orgname}/applications/{client_id} endpoint:

   $ curl -X PUT "https://quay-server.example.com/api/v1/organization/test/applications/12345" \
     -H "Authorization: Bearer wplKtAuAX6DzAJwtB3X77nc18RFj2TKE5gTEk5K2" \
     -H "Content-Type: application/json" \
     -d '{
           "name": "Updated Application Name",
           "redirect_uri": "https://example.com/oauth/callback",
           "application_uri": "https://example.com",
           "description": "Updated description for the application",
           "avatar_email": "avatar@example.com"
         }'

4. After creation, application information can be returned by using the GET /api/v1/app/{client_id} endpoint:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/app/<client_id>" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"name": "new-application3", "description": "", "uri": "", "avatar": {"name": "new-application3", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "app"}, "organization": {"name": "test", "email": "new-contact@test-org.com", "avatar": {"name": "test", "hash": "a15d479002b20f211568fd4419e76686d2b88a4980a5b4c4bc10420776c5f6fe", "color": "#aec7e8", "kind": "user"}, "is_admin": true, "is_member": true, "teams": {}, "ordered_teams": [], "invoice_email": true, "invoice_email_address": "billing@test-org.com", "tag_expiration_s": 1209600, "is_free_account": true, "quotas": [{"id": 2, "limit_bytes": 10737418240, "limits": [{"id": 1, "type": "Reject", "limit_percent": 90}]}], "quota_report": {"quota_bytes": 0, "configured_quota": 10737418240, "running_backfill": "complete", "backfill_status": "complete"}}}

5. Organization applications can be deleted with the DELETE /api/v1/organization/{orgname}/applications/{client_id} endpoint. For example:

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/applications/{client_id}" \
     -H "Authorization: Bearer <access_token>"

   This command does not return output.

Procedure

1. Use the POST /api/v1/organization/{orgname}/proxycache endpoint to create a proxy cache configuration for the organization.

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/proxycache" \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "upstream_registry": "<upstream_registry>"
         }'

2. Use the POST /api/v1/organization/{orgname}/validateproxycache endpoint to validate the proxy configuration:

   $ curl -X POST "https://<quay-server.example.com>/api/v1/organization/{orgname}/validateproxycache" \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{
           "upstream_registry": "<upstream_registry>"
         }'

3. Use the GET /api/v1/organization/{orgname}/proxycache endpoint to obtain information about the proxcy cache. For example:

   $ curl -X GET "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \
     -H "Authorization: Bearer <access_token>"

   Example output

   {"upstream_registry": "quay.io", "expiration_s": 86400, "insecure": false}

4. Use the DELETE /api/v1/organization/{orgname}/proxycache endpoint to

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/{orgname}/proxycache" \
     -H "Authorization: Bearer <access_token>"

   Example output

   "Deleted"

Procedure

1. Use the GET /api/v1/repository/{repository}/permissions/user/{username} endpoint to obtain repository permissions for a user. For example:

   $ curl -X GET \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<repository_path>/permissions/user/<username>"

   Example output

   $ {"role": "read", "name": "testuser", "is_robot": false, "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}, "is_org_member": false}

2. All user permissions can be returned with the GET /api/v1/repository/{repository}/permissions/user/ endpoint:

   $ curl -X GET \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/user/"

   Example output

   {"permissions": {"quayadmin": {"role": "admin", "name": "quayadmin", "is_robot": false, "avatar": {"name": "quayadmin", "hash": "6d640d802fe23b93779b987c187a4b7a4d8fbcbd4febe7009bdff58d84498fba", "color": "#f7b6d2", "kind": "user"}, "is_org_member": true}, "test+example": {"role": "admin", "name": "test+example", "is_robot": true, "avatar": {"name": "test+example", "hash": "3b03050c26e900500437beee4f7f2a5855ca7e7c5eab4623a023ee613565a60e", "color": "#a1d99b", "kind": "robot"}, "is_org_member": true}}}

3. Alternatively, you can use the GET /api/v1/repository/{repository}/permissions/user/{username}/transitive endpoint to return only the repository permission for the user:

   $ curl -X GET \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<repository_path>/permissions/user/<username>/transitive"

   Example output

   {"permissions": [{"role": "admin"}]}

4. You can change the user’s permissions, such as making the user an admin by using the PUT /api/v1/repository/{repository}/permissions/user/{username} endpoint. For example:

   $ curl -X PUT \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{"role": "<role>"}' \
     "https://quay-server.example.com/api/v1/repository/<repository_path>/permissions/user/<username>"

   Example output

   {"role": "admin", "name": "testuser", "is_robot": false, "avatar": {"name": "testuser", "hash": "f660ab912ec121d1b1e928a0bb4bc61b15f5ad44d5efdc4e1c92a25e99b8e44a", "color": "#6b6ecf", "kind": "user"}, "is_org_member": false}

5. User permissions can be deleted by using the DELETE /api/v1/repository/{repository}/permissions/user/{username} endpoint. For example:

   $ curl -X DELETE \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/user/<username>"

   This command does not return output.

1. Permissions for a specified team can be returned by using the GET /api/v1/repository/{repository}/permissions/team/{teamname} endpoint:

   $ curl -X GET \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"

   Example output

   {"role": "write"}

2. Permissions for all teams can be returned with the GET /api/v1/repository/{repository}/permissions/team/ endpoint. For example:

   $ curl -X GET \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/"

   Example output

   {"permissions": {"ironmanteam": {"role": "read", "name": "ironmanteam", "avatar": {"name": "ironmanteam", "hash": "8045b2361613622183e87f33a7bfc54e100a41bca41094abb64320df29ef458d", "color": "#969696", "kind": "team"}}, "sillyteam": {"role": "read", "name": "sillyteam", "avatar": {"name": "sillyteam", "hash": "f275d39bdee2766d2404e2c6dbff28fe290969242e9fcf1ffb2cde36b83448ff", "color": "#17becf", "kind": "team"}}}}

3. Permissions for a specified team can be changed by using the PUT /api/v1/repository/{repository}/permissions/team/{teamname} command. For example:

   $ curl -X PUT \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{"role": "<role>"}' \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"

   Example output

   {"role": "admin", "name": "superteam", "avatar": {"name": "superteam", "hash": "48cb6d114200039fed5c601480653ae7371d5a8849521d4c3bf2418ea013fc0f", "color": "#9467bd", "kind": "team"}}

4. Team permissions can be deleted with the DELETE /api/v1/repository/{repository}/permissions/team/{teamname} command. For example:

   $ curl -X DELETE \
     -H "Authorization: Bearer <access_token>" \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repository>/permissions/team/<teamname>"

   This command does not return output in the CLI.

Procedure

1. Enter the following POST /api/v1/organization/{orgname}/autoprunepolicy/ command create a new policy that limits the number of tags allowed in an organization:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags", "value": 10}' http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/

   Alternatively, you can can set tags to expire for a specified time after their creation date:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{
   "method": "creation_date", "value": "7d"}' http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/

   Example output

   {"uuid": "73d64f05-d587-42d9-af6d-e726a4a80d6e"}

2. Optional. You can add an additional policy to an organization and pass in the tagPattern and tagPatternMatches fields to prune only tags that match the given regex pattern. For example:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "method": "creation_date",
       "value": "7d",
       "tagPattern": "^v*",
       "tagPatternMatches": <true> 1
     }' \
     "https://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/"

   1

   Setting tagPatternMatches to true makes it so that tags that match the given regex pattern will be pruned. In this example, tags that match ^v* are pruned.

   Example output

   {"uuid": "ebf7448b-93c3-4f14-bf2f-25aa6857c7b0"}

3. You can update your organization’s auto-prune policy by using the PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid} command. For example:

   $ curl -X PUT   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   -d '{
       "method": "creation_date",
       "value": "4d",
       "tagPattern": "^v*",
       "tagPatternMatches": true
     }'   "<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/<uuid>"

   This command does not return output. Continue to the next step.

4. Check your auto-prune policy by entering the following command:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/

   Example output

   {"policies": [{"uuid": "ebf7448b-93c3-4f14-bf2f-25aa6857c7b0", "method": "creation_date", "value": "4d", "tagPattern": "^v*", "tagPatternMatches": true}, {"uuid": "da4d0ad7-3c2d-4be8-af63-9c51f9a501bc", "method": "number_of_tags", "value": 10, "tagPattern": null, "tagPatternMatches": true}, {"uuid": "17b9fd96-1537-4462-a830-7f53b43f94c2", "method": "creation_date", "value": "7d", "tagPattern": "^v*", "tagPatternMatches": true}]}

5. You can delete the auto-prune policy for your organization by entering the following command. Note that deleting the policy requires the UUID.

   $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/73d64f05-d587-42d9-af6d-e726a4a80d6e

Procedure

1. Enter the following POST command create a new policy that limits the number of tags for the current user:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags", "value": 10}' http://<quay-server.example.com>/api/v1/user/autoprunepolicy/

   Example output

   {"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859"}

2. Check your auto-prune policy by entering the following command:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/

   Alternatively, you can include the UUID:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/8c03f995-ca6f-4928-b98d-d75ed8c14859

   Example output

   {"policies": [{"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859", "method": "number_of_tags", "value": 10}]}

3. You can delete the auto-prune policy by entering the following command. Note that deleting the policy requires the UUID.

   $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/user/autoprunepolicy/8c03f995-ca6f-4928-b98d-d75ed8c14859

   Example output

   {"uuid": "8c03f995-ca6f-4928-b98d-d75ed8c14859"}

Procedure

1. Enter the following POST /api/v1/repository/{repository}/autoprunepolicy/ command create a new policy that limits the number of tags allowed in an organization:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags","value": 2}' http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/

   Alternatively, you can can set tags to expire for a specified time after their creation date:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "creation_date", "value": "7d"}' http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/

   Example output

   {"uuid": "ce2bdcc0-ced2-4a1a-ac36-78a9c1bed8c7"}

2. Optional. You can add an additional policy and pass in the tagPattern and tagPatternMatches fields to prune only tags that match the given regex pattern. For example:

   $ curl -X POST \
     -H "Authorization: Bearer <access_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "method": "<creation_date>",
       "value": "<7d>",
       "tagPattern": "<^test.>*",
       "tagPatternMatches": <false> 1
     }' \
     "https://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/"

   1

   Setting tagPatternMatches to false makes it so that tags that all tags that do not match the given regex pattern are pruned. In this example, all tags but ^test. are pruned.

   Example output

   {"uuid": "b53d8d3f-2e73-40e7-96ff-736d372cd5ef"}

3. You can update your policy for the repository by using the PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid} command and passing in the UUID. For example:

   $ curl -X PUT \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "method": "number_of_tags",
       "value": "5",
       "tagPattern": "^test.*",
       "tagPatternMatches": true
     }' \
     "https://quay-server.example.com/api/v1/repository/<namespace>/<repo_name>/autoprunepolicy/<uuid>"

   This command does not return output. Continue to the next step to check your auto-prune policy.

4. Check your auto-prune policy by entering the following command:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/

   Alternatively, you can include the UUID:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/ce2bdcc0-ced2-4a1a-ac36-78a9c1bed8c7

   Example output

   {"policies": [{"uuid": "ce2bdcc0-ced2-4a1a-ac36-78a9c1bed8c7", "method": "number_of_tags", "value": 10}]}

5. You can delete the auto-prune policy by entering the following command. Note that deleting the policy requires the UUID.

   $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/ce2bdcc0-ced2-4a1a-ac36-78a9c1bed8c7

   Example output

   {"uuid": "ce2bdcc0-ced2-4a1a-ac36-78a9c1bed8c7"}

Procedure

1. Enter the following POST /api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/ command create a new policy that limits the number of tags for the user:

   $ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags","value": 2}' https://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/

   Example output

   {"uuid": "7726f79c-cbc7-490e-98dd-becdc6fefce7"}

2. Optional. You can add an additional policy for the current user and pass in the tagPattern and tagPatternMatches fields to prune only tags that match the given regex pattern. For example:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -d '{
       "method": "creation_date",
       "value": "7d",
       "tagPattern": "^v*",
       "tagPatternMatches": true
     }' \
     "http://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/"

   Example output

   {"uuid": "b3797bcd-de72-4b71-9b1e-726dabc971be"}

3. You can update your policy for the current user by using the PUT /api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/<policy_uuid> command. For example:

   $ curl -X PUT   -H "Authorization: Bearer <bearer_token>"   -H "Content-Type: application/json"   -d '{
       "method": "creation_date",
       "value": "4d",
       "tagPattern": "^test.",
       "tagPatternMatches": true
     }'   "https://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/<policy_uuid>"

   Updating a policy does not return output in the CLI.

4. Check your auto-prune policy by entering the following command:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/

   Alternatively, you can include the UUID:

   $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/7726f79c-cbc7-490e-98dd-becdc6fefce7

   Example output

   {"uuid": "81ee77ec-496a-4a0a-9241-eca49437d15b", "method": "creation_date", "value": "7d", "tagPattern": "^v*", "tagPatternMatches": true}

5. You can delete the auto-prune policy by entering the following command. Note that deleting the policy requires the UUID.

   $ curl -X DELETE -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<user_account>/<user_repository>/autoprunepolicy/<policy_uuid>

   Example output

   {"uuid": "7726f79c-cbc7-490e-98dd-becdc6fefce7"}

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.

Procedure

1. Enter the following POST /api/v1/repository/{repository}/notification command to create a notification on your repository:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "event": "<event>",
       "method": "<method>",
       "config": {
         "<config_key>": "<config_value>"
       },
       "eventConfig": {
         "<eventConfig_key>": "<eventConfig_value>"
       }
     }' \
     https://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/notification/

   This command does not return output in the CLI. Instead, you can enter the following GET /api/v1/repository/{repository}/notification/{uuid} command to obtain information about the repository notification:

   {"uuid": "240662ea-597b-499d-98bb-2b57e73408d6", "title": null, "event": "repo_push", "method": "quay_notification", "config": {"target": {"name": "quayadmin", "kind": "user", "is_robot": false, "avatar": {"name": "quayadmin", "hash": "b28d563a6dc76b4431fc7b0524bbff6b810387dac86d9303874871839859c7cc", "color": "#17becf", "kind": "user"}}}, "event_config": {}, "number_of_failures": 0}

2. You can test your repository notification by entering the following POST /api/v1/repository/{repository}/notification/{uuid}/test command:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>/test

   Example output

   {}

3. You can reset repository notification failures to 0 by entering the following POST /api/v1/repository/{repository}/notification/{uuid} command:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/notification/<uuid>

4. Enter the following DELETE /api/v1/repository/{repository}/notification/{uuid} command to delete a repository notification:

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

   This command does not return output in the CLI. Instead, you can enter the following GET /api/v1/repository/{repository}/notification/ command to retrieve a list of all notifications:

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

   Example output

   {"notifications": []}