Chapter 6. Red Hat Quay API examples

Procedure

1. Create a message by using the `POST /api/v1/message endpoint:

   $ curl -X POST "https://quay-server.example.com/api/v1/messages" \
       -H "Authorization: Bearer wplKtAuAX6DzAJwtB3X77nc18RFj2TKE5gTEk5K2" \
       -H "Content-Type: application/json" \
       -d '{
           "message": {
               "content": "Hi",
               "media_type": "text/plain",
               "severity": "info"
           }
       }'

   This command does not return output.

2. Use the link:https://docs.redhat.com/en/documentation/red_hat_quay/Red Hat Quay/html-single/red_hat_quay_api_guide/index#getglobalmessages[GET /api/v1/messages] command to return the list of global messages:

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

   Example output

   {"messages": [{"uuid": "ecababd4-3451-4458-b5db-801684137444", "content": "Hi", "severity": "info", "media_type": "text/plain"}]}

3. Delete the global message by using the link:https://docs.redhat.com/en/documentation/red_hat_quay/Red Hat Quay/html-single/red_hat_quay_api_guide/index#deleteglobalmessage[DELETE /api/v1/message/{uuid}] endpoint:

   $ curl -X DELETE "https://<quay-server.example.com>/api/v1/message/<uuid>" \
       -H "Authorization: Bearer <access_token>"

   This command does not return output.

Procedure

1. Use the POST /api/v1/user/exportlogs endpoint to export logs for the current user:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "<MM/DD/YYYY>",
           "endtime": "<MM/DD/YYYY>",
           "callback_email": "your.email@example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/user/exportlogs"

   Example output

   {"export_id": "6a0b9ea9-444c-4a19-9db8-113201c38cd4"}

2. Use the POST /api/v1/organization/{orgname}/exportlogs endpoint to export logs for an Organization:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "<MM/DD/YYYY>",
           "endtime": "<MM/DD/YYYY>",
           "callback_email": "org.logs@example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/organization/{orgname}/exportlogs"

3. Use the POST /api/v1/repository/{repository}/exportlogs endpoint to export logs for a repository:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -d '{
           "starttime": "2024-01-01",
           "endtime": "2024-06-18",
           "callback_url": "http://your-callback-url.example.com"
         }' \
     "http://<quay-server.example.com>/api/v1/repository/{repository}/exportlogs"

Procedure

1. Use the GET /api/v1/repository/{repository}/manifest/{manifestref} command to retrieve the details of a specific manifest in a repository:

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

2. Use the GET /api/v1/repository/{repository}/manifest/{manifestref}/labels command to retrieve a list of labels for a specific manifest:

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

   Example output

   {"labels": [{"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}, {"id": "2d34ec64-4051-43ad-ae06-d5f81003576a", "key": "org.opencontainers.image.version", "value": "1.36.1-glibc", "source_type": "manifest", "media_type": "text/plain"}]}

3. Use the GET /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid} command to obtain information about a specific manifest:

   $ curl -X GET \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Accept: application/json" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<label_id>

   Example output

   {"id": "e9f717d2-c1dd-4626-802d-733a029d17ad", "key": "org.opencontainers.image.url", "value": "https://github.com/docker-library/busybox", "source_type": "manifest", "media_type": "text/plain"}

4. You can add an additional label to a manifest in a given repository with the POST /api/v1/repository/{repository}/manifest/{manifestref}/labels command. For example:

   $ curl -X POST \
     -H "Authorization: Bearer <bearer_token>" \
     -H "Content-Type: application/json" \
     --data '{
       "key": "<key>",
       "value": "<value>",
       "media_type": "<media_type>"
     }' \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels

   Example output

   {"label": {"id": "346593fd-18c8-49db-854f-4cb1fb76ff9c", "key": "example-key", "value": "example-value", "source_type": "api", "media_type": "text/plain"}}

5. You can delete a label using the DELETE /api/v1/repository/{repository}/manifest/{manifestref}/labels/{labelid} command:

   $ curl -X DELETE \
     -H "Authorization: Bearer <bearer_token>" \
     https://<quay-server.example.com>/api/v1/repository/<repository>/manifest/<manifestref>/labels/<labelid>

   This command does not return output in the CLI. You can use one of the commands above to ensure that it was successfully removed.