Chapter 15. policy

15.1. createOrganizationAutoPrunePolicy
リンクのコピー

Creates an auto-prune policy for the organization

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	string

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

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

15.2. listOrganizationAutoPrunePolicies
リンクのコピー

Lists the auto-prune policies for the organization

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

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	orgname required	The name of the organization	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/example_org/autoprunepolicy/" \
  -H "Authorization: Bearer <your_access_token>"

15.3. getOrganizationAutoPrunePolicy
リンクのコピー

Fetches the auto-prune policy for the organization

GET /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	string
path	orgname required	The name of the organization	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 -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/autoprunepolicy/<policy_uuid>

15.4. deleteOrganizationAutoPrunePolicy
リンクのコピー

Deletes the auto-prune policy for the organization

DELETE /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	string
path	orgname required	The name of the organization	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/example_org/autoprunepolicy/example_policy_uuid" \
  -H "Authorization: Bearer <your_access_token>"

15.5. updateOrganizationAutoPrunePolicy
リンクのコピー

Updates the auto-prune policy for the organization

PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (org:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	string
path	orgname required	The name of the organization	string

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

Responses

Expand

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

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

15.6. createRepositoryAutoPrunePolicy
リンクのコピー

Creates an auto-prune policy for the repository

POST /api/v1/repository/{repository}/autoprunepolicy/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	string

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

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

15.7. listRepositoryAutoPrunePolicies
リンクのコピー

Lists the auto-prune policies for the repository

GET /api/v1/repository/{repository}/autoprunepolicy/

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	repository required	The full path of the repository. e.g. namespace/name	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/repository/example_namespace/example_repo/autoprunepolicy/" \
  -H "Authorization: Bearer <your_access_token>"

15.8. getRepositoryAutoPrunePolicy
リンクのコピー

Fetches the auto-prune policy for the repository

GET /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

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/repository/example_namespace/example_repo/autoprunepolicy/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer <your_access_token>"

15.9. deleteRepositoryAutoPrunePolicy
リンクのコピー

Deletes the auto-prune policy for the repository

DELETE /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

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/repository/example_namespace/example_repo/autoprunepolicy/123e4567-e89b-12d3-a456-426614174000" \
  -H "Authorization: Bearer <your_access_token>"

15.10. updateRepositoryAutoPrunePolicy
リンクのコピー

Updates the auto-prune policy for the repository

PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (repo:admin)

Path parameters

Expand

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

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

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

15.11. createUserAutoPrunePolicy
リンクのコピー

Creates the auto-prune policy for the currently logged in user

POST /api/v1/user/autoprunepolicy/

Authorizations: oauth2_implicit (user:admin)

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

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/user/autoprunepolicy/" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "method": "number_of_tags",
    "value": 10,
    "tagPattern": "v*",
    "tagPatternMatches": true
  }'

15.12. listUserAutoPrunePolicies
リンクのコピー

Lists the auto-prune policies for the currently logged in user

GET /api/v1/user/autoprunepolicy/

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/autoprunepolicy/" \
  -H "Authorization: Bearer <your_access_token>"

15.13. getUserAutoPrunePolicy
リンクのコピー

Fetches the auto-prune policy for the currently logged in user

GET /api/v1/user/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	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/autoprunepolicy/{policy_uuid}" \
  -H "Authorization: Bearer <your_access_token>"

15.14. deleteUserAutoPrunePolicy
リンクのコピー

Deletes the auto-prune policy for the currently logged in user

DELETE /api/v1/user/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	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/user/autoprunepolicy/<policy_uuid>" \
  -H "Authorization: Bearer <your_access_token>"

15.15. updateUserAutoPrunePolicy
リンクのコピー

Updates the auto-prune policy for the currently logged in user

PUT /api/v1/user/autoprunepolicy/{policy_uuid}

Authorizations: oauth2_implicit (user:admin)

Path parameters

Expand

Type	Name	Description	Schema
path	policy_uuid required	The unique ID of the policy	string

Request body schema (application/json)

The policy configuration that is to be applied to the user namespace

Expand

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

Responses

Expand

HTTP Code	Description	Schema
204	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/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
  }'

このコンテンツは選択した言語では利用できません。

15.1. createOrganizationAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

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

Path parameters

Request body schema (application/json)

Responses

Example command

15.2. listOrganizationAutoPrunePoliciesリンクのコピーリンクがクリップボードにコピーされました!

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

Path parameters

Responses

Example command

15.3. getOrganizationAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.4. deleteOrganizationAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.5. updateOrganizationAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

PUT /api/v1/organization/{orgname}/autoprunepolicy/{policy_uuid}

Path parameters

Request body schema (application/json)

Responses

Example command

15.6. createRepositoryAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

POST /api/v1/repository/{repository}/autoprunepolicy/

Path parameters

Request body schema (application/json)

Responses

Example command

15.7. listRepositoryAutoPrunePoliciesリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/autoprunepolicy/

Path parameters

Responses

Example command

15.8. getRepositoryAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.9. deleteRepositoryAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.10. updateRepositoryAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

PUT /api/v1/repository/{repository}/autoprunepolicy/{policy_uuid}

Path parameters

Request body schema (application/json)

Responses

Example command

15.11. createUserAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

POST /api/v1/user/autoprunepolicy/

Request body schema (application/json)

Responses

Example command

15.12. listUserAutoPrunePoliciesリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/user/autoprunepolicy/

Responses

Example command

15.13. getUserAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

GET /api/v1/user/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.14. deleteUserAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

DELETE /api/v1/user/autoprunepolicy/{policy_uuid}

Path parameters

Responses

Example command

15.15. updateUserAutoPrunePolicyリンクのコピーリンクがクリップボードにコピーされました!

PUT /api/v1/user/autoprunepolicy/{policy_uuid}

Path parameters

Request body schema (application/json)

Responses

15.1. createOrganizationAutoPrunePolicy
リンクのコピー

15.2. listOrganizationAutoPrunePolicies
リンクのコピー

15.3. getOrganizationAutoPrunePolicy
リンクのコピー

15.4. deleteOrganizationAutoPrunePolicy
リンクのコピー

15.5. updateOrganizationAutoPrunePolicy
リンクのコピー

15.6. createRepositoryAutoPrunePolicy
リンクのコピー

15.7. listRepositoryAutoPrunePolicies
リンクのコピー

15.8. getRepositoryAutoPrunePolicy
リンクのコピー

15.9. deleteRepositoryAutoPrunePolicy
リンクのコピー

15.10. updateRepositoryAutoPrunePolicy
リンクのコピー

15.11. createUserAutoPrunePolicy
リンクのコピー

15.12. listUserAutoPrunePolicies
リンクのコピー

15.13. getUserAutoPrunePolicy
リンクのコピー

15.14. deleteUserAutoPrunePolicy
リンクのコピー

15.15. updateUserAutoPrunePolicy
リンクのコピー