Chapter 17. policy
Policy.
17.1. createOrganizationAutoPrunePolicy
Creates an auto-prune policy for the organization
17.1.1. POST /api/v1/organization/{orgname}/autoprunepolicy/
Authorizations: oauth2_implicit (org:admin)
17.1.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | The name of the organization | string |
17.1.3. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.1.4. Responses
17.1.5. Example command
$ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags", "value": 10}' http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/17.2. listOrganizationAutoPrunePolicies
Lists the auto-prune policies for the organization
17.2.1. GET /api/v1/organization/{orgname}/autoprunepolicy/
Authorizations: oauth2_implicit (org:admin)
17.2.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | orgname required | The name of the organization | string |
17.2.3. Responses
17.2.4. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/organization/example_org/autoprunepolicy/" \
-H "Authorization: Bearer <your_access_token>"17.3. getOrganizationAutoPrunePolicy
Fetches the auto-prune policy for the organization
17.3.1. GET /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
17.3.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | orgname required | The name of the organization | string |
17.3.3. Responses
17.3.4. Example command
$ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/<policy_uuid>17.4. deleteOrganizationAutoPrunePolicy
Deletes the auto-prune policy for the organization
17.4.1. DELETE /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
17.4.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | orgname required | The name of the organization | string |
17.4.3. Responses
17.4.4. Example command
$ curl -X DELETE "https://quay-server.example.com/api/v1/organization/example_org/autoprunepolicy/example_policy_uuid" \
-H "Authorization: Bearer <your_access_token>"17.5. updateOrganizationAutoPrunePolicy
Updates the auto-prune policy for the organization
17.5.1. PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (org:admin)
17.5.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | orgname required | The name of the organization | string |
17.5.3. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.5.4. Responses
17.5.5. Example command
$ curl -X PUT -H "Authorization: Bearer <bearer_token>" -H "Content-Type: application/json" -d '{
"method": "creation_date",
"value": "4d",
"tagPattern": "^v*",
"tagPatternMatches": true
}' "<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/<uuid>"17.6. createRepositoryAutoPrunePolicy
Creates an auto-prune policy for the repository
17.6.1. POST /api/v1/repository/{repository}/autoprunepolicy/
Authorizations: oauth2_implicit (repo:admin)
17.6.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
17.6.3. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.6.4. Responses
17.6.5. Example command
$ curl -X POST -H "Authorization: Bearer <access_token>" -H "Content-Type: application/json" -d '{"method": "number_of_tags","value": 2}' http://<quay-server.example.com>/api/v1/repository/<organization_name>/<repository_name>/autoprunepolicy/17.7. listRepositoryAutoPrunePolicies
Lists the auto-prune policies for the repository
17.7.1. GET /api/v1/repository/{repository}/autoprunepolicy/
Authorizations: oauth2_implicit (repo:admin)
17.7.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | repository required | The full path of the repository. e.g. namespace/name | string |
17.7.3. Responses
17.7.4. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/autoprunepolicy/" \
-H "Authorization: Bearer <your_access_token>"17.8. getRepositoryAutoPrunePolicy
Fetches the auto-prune policy for the repository
17.8.1. GET /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
17.8.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
17.8.3. Responses
17.8.4. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/autoprunepolicy/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer <your_access_token>"17.9. deleteRepositoryAutoPrunePolicy
Deletes the auto-prune policy for the repository
17.9.1. DELETE /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
17.9.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
17.9.3. Responses
17.9.4. Example command
$ curl -X DELETE "https://quay-server.example.com/api/v1/repository/example_namespace/example_repo/autoprunepolicy/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer <your_access_token>"17.10. updateRepositoryAutoPrunePolicy
Updates the auto-prune policy for the repository
17.10.1. PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (repo:admin)
17.10.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
| path | repository required | The full path of the repository. e.g. namespace/name | string |
17.10.3. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.10.4. Responses
17.10.5. Example command
$ curl -X PUT \
-H "Authorization: Bearer <bearer_token>" \
-H "Content-Type: application/json" \
-d '{
"method": "number_of_tags",
"value": "5",
"tagPattern": "^test.*",
"tagPatternMatches": true
}' \
"https://quay-server.example.com/api/v1/repository/<namespace>/<repo_name>/autoprunepolicy/<uuid>"17.11. createUserAutoPrunePolicy
Creates the auto-prune policy for the currently logged in user
17.11.1. POST /api/v1/user/autoprunepolicy/
Authorizations: oauth2_implicit (user:admin)
17.11.2. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.11.3. Responses
17.11.4. Example command
$ curl -X POST "https://quay-server.example.com/api/v1/user/autoprunepolicy/" \
-H "Authorization: Bearer <your_access_token>" \
-H "Content-Type: application/json" \
-d '{
"method": "number_of_tags",
"value": 10,
"tagPattern": "v*",
"tagPatternMatches": true
}'17.12. listUserAutoPrunePolicies
Lists the auto-prune policies for the currently logged in user
17.12.1. GET /api/v1/user/autoprunepolicy/
Authorizations: oauth2_implicit (user:admin)
17.12.2. Responses
17.12.3. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/user/autoprunepolicy/" \
-H "Authorization: Bearer <your_access_token>"17.13. getUserAutoPrunePolicy
Fetches the auto-prune policy for the currently logged in user
17.13.1. GET /api/v1/user/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (user:admin)
17.13.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
17.13.3. Responses
17.13.4. Example command
$ curl -X GET "https://quay-server.example.com/api/v1/user/autoprunepolicy/{policy_uuid}" \
-H "Authorization: Bearer <your_access_token>"17.14. deleteUserAutoPrunePolicy
Deletes the auto-prune policy for the currently logged in user
17.14.1. DELETE /api/v1/user/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (user:admin)
17.14.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
17.14.3. Responses
17.14.4. Example command
$ curl -X DELETE "https://quay-server.example.com/api/v1/user/autoprunepolicy/<policy_uuid>" \
-H "Authorization: Bearer <your_access_token>"17.15. updateUserAutoPrunePolicy
Updates the auto-prune policy for the currently logged in user
17.15.1. PUT /api/v1/user/autoprunepolicy/{policy_uuid}
Authorizations: oauth2_implicit (user:admin)
17.15.2. Path parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| path | policy_uuid required | The unique ID of the policy | string |
17.15.3. Request body schema (application/json)
The policy configuration that is to be applied to the user namespace
| Name | Description | Schema |
|---|---|---|
| method required | The method to use for pruning tags (number_of_tags, creation_date) | string |
| value required | The value to use for the pruning method (number of tags e.g. 10, time delta e.g. 7d (7 days)) | |
| tagPattern optional | Tags only matching this pattern will be pruned | string |
| tagPatternMatches optional | Determine whether pruned tags should or should not match the tagPattern | boolean |
17.15.4. Responses
17.15.5. Example command
$ curl -X PUT "https://quay-server.example.com/api/v1/user/autoprunepolicy/<policy_uuid>" \
-H "Authorization: Bearer <your_access_token>" \
-H "Content-Type: application/json" \
-d '{
"method": "number_of_tags",
"value": "10",
"tagPattern": ".*-old",
"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}