use-quay-export-logs-api.adoc

Exporting logs by using the API

Detailed logs can be exported to a callback URL or to an email address.

Prerequisites

• You have Created an OAuth access token.

• You have set BROWSER_API_CALLS_XHR_ONLY: false in your config.yaml file.

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"