Chapter 10. namespacequota

10.1. listUserQuota
Copy link

GET /api/v1/user/quota

Authorizations: oauth2_implicit (user:admin)

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.2. getOrganizationQuotaLimit
Copy link

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Authorizations:

Path parameters

Expand

Type	Name	Schema
path	quota_id required	string
path	limit_id required	string
path	orgname required	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

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

Copy to Clipboard

Toggle word wrap

10.3. changeOrganizationQuotaLimit
Copy link

PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Schema
path	quota_id required	string
path	limit_id required	string
path	orgname required	string

Request body schema (application/json)

Description of changing organization quota limit

Expand

Name	Description	Schema
type optional	Type of quota limit: "Warning" or "Reject"	string
threshold_percent optional	Quota threshold, in percent of quota	integer

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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 '{

$ 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>
         }'

Copy to Clipboard

Toggle word wrap

10.4. deleteOrganizationQuotaLimit
Copy link

DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Schema
path	quota_id required	string
path	limit_id required	string
path	orgname required	string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>"

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

Copy to Clipboard

Toggle word wrap

10.5. createOrganizationQuotaLimit
Copy link

POST /api/v1/organization/{orgname}/quota/{quota_id}/limit

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	orgname required		string

Request body schema (application/json)

Description of a new organization quota limit

Expand

Name	Description	Schema
type required	Type of quota limit: "Warning" or "Reject"	string
threshold_percent required	Quota threshold, in percent of quota	integer

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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 '{

$ 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

}'

Copy to Clipboard

Toggle word wrap

10.6. listOrganizationQuotaLimit
Copy link

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	orgname required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.7. getUserQuotaLimit
Copy link

GET /api/v1/user/quota/{quota_id}/limit/{limit_id}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	limit_id required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.8. listUserQuotaLimit
Copy link

GET /api/v1/user/quota/{quota_id}/limit

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.9. getOrganizationQuota
Copy link

GET /api/v1/organization/{orgname}/quota/{quota_id}

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	orgname required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.10. changeOrganizationQuota
Copy link

PUT /api/v1/organization/{orgname}/quota/{quota_id}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	orgname required		string

Request body schema (application/json)

Description of a new organization quota

Expand

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 `limit_bytes`.	string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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 '{

$ 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>
     }'

Copy to Clipboard

Toggle word wrap

10.11. deleteOrganizationQuota
Copy link

DELETE /api/v1/organization/{orgname}/quota/{quota_id}

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string
path	orgname required		string

Responses

Expand

HTTP Code	Description	Schema
204	Deleted
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.12. createOrganizationQuota
Copy link

Create a new organization quota.

POST /api/v1/organization/{orgname}/quota

Authorizations: oauth2_implicit (super:user)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required		string

Request body schema (application/json)

Description of a new organization quota

Expand

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 `limit_bytes`.	string

Responses

Expand

HTTP Code	Description	Schema
201	Successful creation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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 '{

$ 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"
     }'

Copy to Clipboard

Toggle word wrap

10.13. listOrganizationQuota
Copy link

GET /api/v1/organization/{orgname}/quota

Authorizations:

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

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>/quota

$ curl -k -X GET -H "Authorization: Bearer <token>" -H 'Content-Type: application/json'  https://<quay-server.example.com>/api/v1/organization/<organization_name>/quota

Copy to Clipboard

Toggle word wrap

10.14. getUserQuota
Copy link

GET /api/v1/user/quota/{quota_id}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	quota_id required		string

Responses

Expand

HTTP Code	Description	Schema
200	Successful invocation
400	Bad Request	ApiError
401	Session required	ApiError
403	Unauthorized access	ApiError
404	Not found	ApiError

Example command

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

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

Copy to Clipboard

Toggle word wrap

10.1. listUserQuotaCopy linkLink copied to clipboard!

GET /api/v1/user/quota

Responses

Example command

10.2. getOrganizationQuotaLimitCopy linkLink copied to clipboard!

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Path parameters

Responses

Example command

10.3. changeOrganizationQuotaLimitCopy linkLink copied to clipboard!

PUT /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Path parameters

Request body schema (application/json)

Responses

Example command

10.4. deleteOrganizationQuotaLimitCopy linkLink copied to clipboard!

DELETE /api/v1/organization/{orgname}/quota/{quota_id}/limit/{limit_id}

Path parameters

Responses

Example command

10.5. createOrganizationQuotaLimitCopy linkLink copied to clipboard!

POST /api/v1/organization/{orgname}/quota/{quota_id}/limit

Path parameters

Request body schema (application/json)

Responses

Example command

10.6. listOrganizationQuotaLimitCopy linkLink copied to clipboard!

GET /api/v1/organization/{orgname}/quota/{quota_id}/limit

Path parameters

Responses

Example command

10.7. getUserQuotaLimitCopy linkLink copied to clipboard!

GET /api/v1/user/quota/{quota_id}/limit/{limit_id}

Path parameters

Responses

Example command

10.8. listUserQuotaLimitCopy linkLink copied to clipboard!

GET /api/v1/user/quota/{quota_id}/limit

Path parameters

Responses

Example command

10.9. getOrganizationQuotaCopy linkLink copied to clipboard!

GET /api/v1/organization/{orgname}/quota/{quota_id}

Path parameters

Responses

Example command

10.10. changeOrganizationQuotaCopy linkLink copied to clipboard!

PUT /api/v1/organization/{orgname}/quota/{quota_id}

Path parameters

Request body schema (application/json)

Responses

Example command

10.11. deleteOrganizationQuotaCopy linkLink copied to clipboard!

DELETE /api/v1/organization/{orgname}/quota/{quota_id}

Path parameters

Responses

Example command

10.12. createOrganizationQuotaCopy linkLink copied to clipboard!

POST /api/v1/organization/{orgname}/quota

Path parameters

Request body schema (application/json)

Responses

Example command

10.13. listOrganizationQuotaCopy linkLink copied to clipboard!

GET /api/v1/organization/{orgname}/quota

Path parameters

Responses

Example command

10.14. getUserQuotaCopy linkLink copied to clipboard!

GET /api/v1/user/quota/{quota_id}

Path parameters

Responses

Example command

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

Making open source more inclusive

About Red Hat

10.1. listUserQuota
Copy link

10.2. getOrganizationQuotaLimit
Copy link

10.3. changeOrganizationQuotaLimit
Copy link

10.4. deleteOrganizationQuotaLimit
Copy link

10.5. createOrganizationQuotaLimit
Copy link

10.6. listOrganizationQuotaLimit
Copy link

10.7. getUserQuotaLimit
Copy link

10.8. listUserQuotaLimit
Copy link

10.9. getOrganizationQuota
Copy link

10.10. changeOrganizationQuota
Copy link

10.11. deleteOrganizationQuota
Copy link

10.12. createOrganizationQuota
Copy link

10.13. listOrganizationQuota
Copy link

10.14. getUserQuota
Copy link