Chapter 13. namespacequota
Namespacequota.
13.1. listUserQuota
List User Quota.
13.1.1. GET /api/v1/user/quota
Authorizations: oauth2_implicit (user:admin)
13.1.2. Responses
13.1.3. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota" \
-H "Authorization: Bearer <access_token>"13.2. getOrganizationQuotaLimit
Get Organization Quota Limit.
13.2.1. GET /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
Authorizations:
13.2.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | limit_id required | string | |
| path | orgname required | string |
13.2.3. Responses
13.2.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
-H "Authorization: Bearer <access_token>"13.3. changeOrganizationQuotaLimit
Change Organization Quota Limit.
13.3.1. PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
Authorizations: oauth2_implicit (super:user)
13.3.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | limit_id required | string | |
| path | orgname required | string |
13.3.3. Request body schema (application/json)
Description of changing organization quota limit
| Name | Description | Schema |
|---|---|---|
| type optional | Type of quota limit: "Warning" or "Reject" | string |
| threshold_percent optional | Quota threshold, in percent of quota | integer |
13.3.4. Responses
13.3.5. Example command
$ 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>
}'13.4. deleteOrganizationQuotaLimit
Delete Organization Quota Limit.
13.4.1. DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}
Authorizations: oauth2_implicit (super:user)
13.4.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | limit_id required | string | |
| path | orgname required | string |
13.4.3. Responses
13.4.4. Example command
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit/<limit_id>" \
-H "Authorization: Bearer <access_token>"13.5. createOrganizationQuotaLimit
Create Organization Quota Limit.
13.5.1. POST /api/v1/organization/{orgname}/quota/{quota_id}/limit
Authorizations: oauth2_implicit (super:user)
13.5.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | orgname required | string |
13.5.3. Request body schema (application/json)
Description of a new organization quota limit
| Name | Description | Schema |
|---|---|---|
| type required | Type of quota limit: "Warning" or "Reject" | string |
| threshold_percent required | Quota threshold, in percent of quota | integer |
13.5.4. Responses
13.5.5. Example command
$ 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",
"threshold_percent": 90
}'13.6. listOrganizationQuotaLimit
List Organization Quota Limit.
13.6.1. GET /api/v1/organization/{orgname}/quota/{quota_id}/limit
Authorizations:
13.6.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | orgname required | string |
13.6.3. Responses
13.6.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>/limit" \
-H "Authorization: Bearer <access_token>"13.7. getUserQuotaLimit
Get User Quota Limit.
13.7.1. GET /api/v1/user/quota/{quota_id}/limit/{limit_id}
Authorizations: oauth2_implicit (user:admin)
13.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | limit_id required | string |
13.7.3. Responses
13.7.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}/limit/{limit_id}" \
-H "Authorization: Bearer <access_token>"13.8. listUserQuotaLimit
List User Quota Limit.
13.8.1. GET /api/v1/user/quota/{quota_id}/limit
Authorizations: oauth2_implicit (user:admin)
13.8.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string |
13.8.3. Responses
13.8.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}/limit" \
-H "Authorization: Bearer <access_token>"13.9. getOrganizationQuota
Get Organization Quota.
13.9.1. GET /api/v1/organization/{orgname}/quota/{quota_id}
Authorizations:
13.9.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | orgname required | string |
13.9.3. Responses
13.9.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
-H "Authorization: Bearer <access_token>"S13.10. changeOrganizationQuota
Change Organization Quota.
13.10.1. PUT /api/v1/organization/{orgname}/quota/{quota_id}
Authorizations: oauth2_implicit (super:user)
13.10.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | orgname required | string |
13.10.3. Request body schema (application/json)
Description of a new organization quota
| Name | Description | Schema |
|---|---|---|
| limit_bytes optional | Number of bytes the organization is allowed | integer |
| limits optional |
Human readable storage capacity of the organization. Accepts SI units like Mi, Gi, or Ti, as well as non-standard units like GB or MB. Must be mutually exclusive with | string |
13.10.4. Responses
13.10.5. Example command
$ 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>
}'13.11. deleteOrganizationQuota
Delete Organization Quota.
13.11.1. DELETE /api/v1/organization/{orgname}/quota/{quota_id}
Authorizations: oauth2_implicit (super:user)
13.11.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string | |
| path | orgname required | string |
13.11.3. Responses
13.11.4. Example command
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/quota/<quota_id>" \
-H "Authorization: Bearer <access_token>"13.12. createOrganizationQuota
Create a new organization quota.
13.12.1. POST /api/v1/organization/{orgname}/quota
Authorizations: oauth2_implicit (super:user)
13.12.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | string |
13.12.3. Request body schema (application/json)
Description of a new organization quota
| Name | Description | Schema |
|---|---|---|
| limit_bytes required | Number of bytes the organization is allowed | integer |
| limits optional |
Human readable storage capacity of the organization. Accepts SI units like Mi, Gi, or Ti, as well as non-standard units like GB or MB. Must be mutually exclusive with | string |
13.12.4. Responses
13.12.5. Example command
$ 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"
}'13.13. listOrganizationQuota
List Organization Quota.
13.13.1. GET /api/v1/organization/{orgname}/quota
Authorizations:
13.13.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | string |
13.13.3. Responses
13.13.4. Example command
$ curl -k -X GET -H "Authorization: Bearer <token>" -H 'Content-Type: application/json' https://<quay-server.example.com>/api/v1/organization/<organization_name>/quota13.14. getUserQuota
Get User Quota.
13.14.1. GET /api/v1/user/quota/{quota_id}
Authorizations: oauth2_implicit (user:admin)
13.14.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | quota_id required | string |
13.14.3. Responses
13.14.4. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/user/quota/{quota_id}" \
-H "Authorization: Bearer <access_token>"
'%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}