Chapter 8. logs
Access usage logs for organizations or repositories.
8.1. getAggregateUserLogs
Returns the aggregated logs for the current user.
8.1.1. GET /api/v1/user/aggregatelogs
Authorizations: oauth2_implicit (user:admin)
8.1.2. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | performer optional | Username for which to filter logs. | string |
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.1.3. Responses
8.1.4. Example command
$ 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>"8.2. exportUserLogs
Returns the aggregated logs for the current user.
8.2.1. POST /api/v1/user/exportlogs
Authorizations: oauth2_implicit (user:admin)
8.2.2. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.2.3. Request body schema (application/json)
Configuration for an export logs operation
| Name | Description | Schema |
|---|---|---|
| callback_url optional | The callback URL to invoke with a link to the exported logs | string |
| callback_email optional | The e-mail address at which to e-mail a link to the exported logs | string |
8.2.4. Responses
8.2.5. Example command
$ 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"8.3. listUserLogs
List the logs for the current user.
8.3.1. GET /api/v1/user/logs
Authorizations: oauth2_implicit (user:admin)
8.3.2. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | next_page optional | The page token for the next page | string |
| query | performer optional | Username for which to filter logs. | string |
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.3.3. Responses
8.3.4. Example command
$ curl -X GET -H "Authorization: Bearer <bearer_token>" -H "Accept: application/json" "<quay-server.example.com>/api/v1/user/logs"8.4. getAggregateOrgLogs
Gets the aggregated logs for the specified organization.
8.4.1. GET /api/v1/organization/{orgname}/aggregatelogs
Authorizations: oauth2_implicit (org:admin)
8.4.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | The name of the organization | string |
8.4.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | performer optional | Username for which to filter logs. | string |
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.4.4. Responses
8.4.5. Example command
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
-H "Accept: application/json" \
"<quay-server.example.com>/api/v1/organization/{orgname}/aggregatelogs"8.5. exportOrgLogs
Exports the logs for the specified organization.
8.5.1. POST /api/v1/organization/{orgname}/exportlogs
Authorizations: oauth2_implicit (org:admin)
8.5.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | The name of the organization | string |
8.5.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.5.4. Request body schema (application/json)
Configuration for an export logs operation
| Name | Description | Schema |
|---|---|---|
| callback_url optional | The callback URL to invoke with a link to the exported logs | string |
| callback_email optional | The e-mail address at which to e-mail a link to the exported logs | string |
8.5.5. Responses
8.5.6. Example command
$ 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"8.6. listOrgLogs
List the logs for the specified organization.
8.6.1. GET /api/v1/organization/{orgname}/logs
Authorizations: oauth2_implicit (org:admin)
8.6.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | The name of the organization | string |
8.6.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | next_page optional | The page token for the next page | string |
| query | performer optional | Username for which to filter logs. | string |
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.6.4. Responses
8.6.5. Example command
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
-H "Accept: application/json" \
"http://<quay-server.example.com>/api/v1/organization/{orgname}/logs"8.7. getAggregateRepoLogs
Returns the aggregated logs for the specified repository.
8.7.1. GET /api/v1/repository/{repository}/aggregatelogs
Authorizations: oauth2_implicit (repo:admin)
8.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
8.7.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.7.4. Responses
8.7.5. Example command
$ 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""8.8. exportRepoLogs
Queues an export of the logs for the specified repository.
8.8.1. POST /api/v1/repository/{repository}/exportlogs
Authorizations: oauth2_implicit (repo:admin)
8.8.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
8.8.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.8.4. Request body schema (application/json)
Configuration for an export logs operation
| Name | Description | Schema |
|---|---|---|
| callback_url optional | The callback URL to invoke with a link to the exported logs | string |
| callback_email optional | The e-mail address at which to e-mail a link to the exported logs | string |
8.8.5. Responses
8.8.6. Example command
$ 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"8.9. listRepoLogs
List the logs for the specified repository.
8.9.1. GET /api/v1/repository/{repository}/logs
Authorizations: oauth2_implicit (repo:admin)
8.9.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
8.9.3. Query parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| query | next_page optional | The page token for the next page | string |
| query | endtime optional | Latest time for logs. Format: "%m/%d/%Y" in UTC. | string |
| query | starttime optional | Earliest time for logs. Format: "%m/%d/%Y" in UTC. | string |
8.9.4. Responses
8.9.5. Example command
$ curl -X GET \
-H "Authorization: Bearer <bearer_token>" \
-H "Accept: application/json" \
"http://<quay-server.example.com>/api/v1/repository/{repository}/logs"
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}