Chapter 27. immutability_policy
Immutability policy.
27.1. createOrgImmutabilityPolicy
Create Org Immutability Policy.
27.1.1. POST /api/v1/organization/{orgname}/immutabilitypolicy/
Authorizations: oauth2_implicit (org:admin)
27.1.2. Request body schema (application/json)
The immutability policy configuration
| Name | Description | Schema |
|---|---|---|
| tagPattern optional | Regex pattern to match tag names | string |
| tagPatternMatches optional | If true, matching tags are immutable. If false, non-matching tags are immutable. | boolean |
27.1.3. Responses
27.1.4. Example command
$ curl -X POST "https://<quay-server.example.com>/api/v1/organization/<orgname>/immutabilitypolicy/" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"tagPattern": ".*", "tagPatternMatches": true}'27.2. createRepositoryImmutabilityPolicy
Create Repository Immutability Policy.
27.2.1. POST /api/v1/repository/{repository}/immutabilitypolicy/
Authorizations: oauth2_implicit (repo:admin)
27.2.2. Request body schema (application/json)
The immutability policy configuration
| Name | Description | Schema |
|---|---|---|
| tagPattern optional | Regex pattern to match tag names | string |
| tagPatternMatches optional | If true, matching tags are immutable. If false, non-matching tags are immutable. | boolean |
27.2.3. Responses
27.2.4. Example command
$ curl -X POST "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/immutabilitypolicy/" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"tagPattern": ".*", "tagPatternMatches": true}'27.3. deleteOrgImmutabilityPolicy
Delete Org Immutability Policy.
27.3.1. DELETE /api/v1/organization/{orgname}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
27.3.2. Responses
27.3.3. Example command
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/organization/<orgname>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>"27.4. deleteRepositoryImmutabilityPolicy
Delete Repository Immutability Policy.
27.4.1. DELETE /api/v1/repository/{repository}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
27.4.2. Responses
27.4.3. Example command
$ curl -X DELETE "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>"27.5. getOrgImmutabilityPolicy
Get Org Immutability Policy.
27.5.1. GET /api/v1/organization/{orgname}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
27.5.2. Responses
27.5.3. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>"27.6. getRepositoryImmutabilityPolicy
Get Repository Immutability Policy.
27.6.1. GET /api/v1/repository/{repository}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
27.6.2. Responses
27.6.3. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>"27.7. listOrgImmutabilityPolicies
List Org Immutability Policies.
27.7.1. GET /api/v1/organization/{orgname}/immutabilitypolicy/
Authorizations: oauth2_implicit (org:admin)
27.7.2. Responses
27.7.3. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/organization/<orgname>/immutabilitypolicy/" \
-H "Authorization: Bearer <access_token>"27.8. listRepositoryImmutabilityPolicies
List Repository Immutability Policies.
27.8.1. GET /api/v1/repository/{repository}/immutabilitypolicy/
Authorizations: oauth2_implicit (repo:admin)
27.8.2. Responses
27.8.3. Example command
$ curl -X GET "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/immutabilitypolicy/" \
-H "Authorization: Bearer <access_token>"27.9. updateOrgImmutabilityPolicy
Update Org Immutability Policy.
27.9.1. PUT /api/v1/organization/{orgname}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
27.9.2. Request body schema (application/json)
The immutability policy configuration
| Name | Description | Schema |
|---|---|---|
| tagPattern optional | Regex pattern to match tag names | string |
| tagPatternMatches optional | If true, matching tags are immutable. If false, non-matching tags are immutable. | boolean |
27.9.3. Responses
27.9.4. Example command
$ curl -X PUT "https://<quay-server.example.com>/api/v1/organization/<orgname>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"tagPattern": ".*", "tagPatternMatches": true}'27.10. updateRepositoryImmutabilityPolicy
Update Repository Immutability Policy.
27.10.1. PUT /api/v1/repository/{repository}/immutabilitypolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
27.10.2. Request body schema (application/json)
The immutability policy configuration
| Name | Description | Schema |
|---|---|---|
| tagPattern optional | Regex pattern to match tag names | string |
| tagPatternMatches optional | If true, matching tags are immutable. If false, non-matching tags are immutable. | boolean |
27.10.3. Responses
27.10.4. Example command
$ curl -X PUT "https://<quay-server.example.com>/api/v1/repository/<namespace>/<repo>/immutabilitypolicy/<policy_uuid>" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"tagPattern": ".*", "tagPatternMatches": true}'
'%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}