8.11.5. Listing an immutability policy by using the Red Hat Quay API

Prerequisites

• You have created an OAuth access token.
• You have set FEATURE_IMMUTABLE_TAGS to True in your config.yaml file.

Procedure

• Retrieve all immutability policies for an organization by using the GET /api/v1/organization/{orgname}/immutabilitypolicy/ endpoint. For example:

  $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/immutabilitypolicy/

  Example output

  {"policies": [{"uuid": "3aae3390-de53-4b82-a2b7-4da8fe5dbe11", "tagPattern": ".*", "tagPatternMatches": true}]}

• Retrieve all immutability policies for a repository by using the GET /api/v1/repository/{repository}/immutabilitypolicy/ endpoint. For example:

  $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/immutabilitypolicy/

  Example output

  {"policies": [{"uuid": "87f75fb5-d023-4054-87b4-469f37a59638", "tagPattern": ".*", "tagPatternMatches": true}]}

• List information about a specific immutability policy for an organization by using the GET /api/v1/organization/{orgname}/immutabilitypolicy/{policy_uuid}/ endpoint. For example:

  $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/organization/<organization_name>/immutabilitypolicy/<policy_uuid>/

  Example output

  {"policies": [{"uuid": "87f75fb5-d023-4054-87b4-469f37a59638", "tagPattern": ".*", "tagPatternMatches": true}]}

• List information about a specific immutability policy for a repository by using the GET /api/v1/repository/{repository}/immutabilitypolicy/{policy_uuid}/ endpoint. For example:

  $ curl -X GET -H "Authorization: Bearer <access_token>" http://<quay-server.example.com>/api/v1/repository/<namespace>/<repository_name>/immutabilitypolicy/<policy_uuid>/

  Example output

  {"uuid": "87f75fb5-d023-4054-87b4-469f37a59638", "tagPattern": ".*", "tagPatternMatches": true}