Container registry protection tag rules API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed

Use this API to manage protected container tags.

List container registry protection tag rules

Gets a list of container registry protection tag rules for a project.

GET /api/v4/projects/:id/registry/protection/tag/rules

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	Yes	ID or URL-encoded path of the project.

If successful, returns 200 OK and the following response attributes:

Attribute	Type	Description
`id`	integer	The ID of the protected container tag rule.
`minimum_access_level_for_delete`	string	The minimum access level required to delete the tag. Possible values: `maintainer`, `owner`, or `admin`.
`minimum_access_level_for_push`	string	The minimum access level required to push to the tag. Possible values: `maintainer`, `owner`, or `admin`.
`project_id`	integer	The ID of the project.
`tag_name_pattern`	string	The tag name pattern. For example, `v*-release` or `latest`.

Can return the following status codes:

200 OK: A list of protection rules.
401 Unauthorized: The access token is invalid.
403 Forbidden: The user does not have permission to list protection rules for this project.
404 Not Found: The project was not found.

Example request:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/7/registry/protection/tag/rules"

Example response:

[
  {
    "id": 1,
    "project_id": 7,
    "tag_name_pattern": "v*-release",
    "minimum_access_level_for_push": "maintainer",
    "minimum_access_level_for_delete": "maintainer"
  },
  {
    "id": 2,
    "project_id": 7,
    "tag_name_pattern": "latest",
    "minimum_access_level_for_push": "owner",
    "minimum_access_level_for_delete": "owner"
  }
]

Create a container registry protection tag rule

Creates a container registry protection tag rule for a project.

POST /api/v4/projects/:id/registry/protection/tag/rules

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	Yes	ID or URL-encoded path of the project.
`tag_name_pattern`	string	Yes	Container tag name pattern protected by the protection rule. For example, `v-release`. Wildcard character `` allowed.
`minimum_access_level_for_push`	string	Yes	Minimum GitLab access level required to push container tags. Possible values: `maintainer`, `owner`, or `admin`.
`minimum_access_level_for_delete`	string	Yes	Minimum GitLab access level required to delete container tags. Possible values: `maintainer`, `owner`, or `admin`.

If successful, returns 201 Created and the following response attributes:

Attribute	Type	Description
`id`	integer	The unique identifier of the container tag rule.
`project_id`	integer	The ID of the project this container tag rule belongs to.
`tag_name_pattern`	string	The glob pattern used to match container tag names. For example, `v*-release`.
`minimum_access_level_for_push`	string	The minimum access level required to push container tags matching this pattern. Possible values: `maintainer`, `owner`, or `admin`.
`minimum_access_level_for_delete`	string	The minimum access level required to delete container tags matching this pattern. Possible values: `maintainer`, `owner`, or `admin`.

Can return the following status codes:

201 Created: The protection rule was created successfully.
400 Bad Request: The protection rule is invalid.
401 Unauthorized: The access token is invalid.
403 Forbidden: The user does not have permission to create a protection rule.
404 Not Found: The project was not found.
422 Unprocessable Entity: The protection rule could not be created. For example, because the tag_name_pattern is already taken.

Example request:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/projects/7/registry/protection/tag/rules" \
  --data '{
        "tag_name_pattern": "v*-release",
        "minimum_access_level_for_push": "maintainer",
        "minimum_access_level_for_delete": "maintainer"
    }'

Example response:

{
  "id": 1,
  "project_id": 7,
  "tag_name_pattern": "v*-release",
  "minimum_access_level_for_push": "maintainer",
  "minimum_access_level_for_delete": "maintainer"
}

Update a container registry protection tag rule

Updates a container registry protection tag rule for a project.

PATCH /api/v4/projects/:id/registry/protection/tag/rules/:protection_rule_id

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	Yes	ID or URL-encoded path of the project.
`protection_rule_id`	integer	Yes	ID of the protection tag rule to be updated.
`minimum_access_level_for_delete`	string	No	Minimum access level required to delete container tags. Possible values: `maintainer`, `owner`, or `admin`. To unset the value, use an empty string (`""`).
`minimum_access_level_for_push`	string	No	Minimum access level required to push container tags. Possible values: `maintainer`, `owner`, or `admin`. To unset the value, use an empty string (`""`).
`tag_name_pattern`	string	No	Container tag name pattern protected by the protection rule. For example, `v-release`. Wildcard character `` allowed.

If successful, returns 200 OK and the following response attributes:

Attribute	Type	Description
`id`	integer	The unique identifier of the container tag rule.
`project_id`	integer	The ID of the project this container tag rule belongs to.
`tag_name_pattern`	string	The glob pattern used to match container tag names. For example, `v*-release`.
`minimum_access_level_for_push`	string	The minimum access level required to push container tags matching this pattern. Possible values: `maintainer`, `owner`, or `admin`.
`minimum_access_level_for_delete`	string	The minimum access level required to delete container tags matching this pattern. Possible values: `maintainer`, `owner`, or `admin`.

Can return the following status codes:

200 OK: The protection rule was updated successfully.
400 Bad Request: The protection rule is invalid.
401 Unauthorized: The access token is invalid.
403 Forbidden: The user does not have permission to update the protection rule.
404 Not Found: The project was not found.
422 Unprocessable Entity: The protection rule could not be updated. For example, because the tag_name_pattern is already taken.

Example request:

curl --request PATCH \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/projects/7/registry/protection/tag/rules/1" \
  --data '{
       "tag_name_pattern": "v*-stable"
    }'

Example response:

{
  "id": 1,
  "project_id": 7,
  "tag_name_pattern": "v*-stable",
  "minimum_access_level_for_push": "maintainer",
  "minimum_access_level_for_delete": "maintainer"
}

Delete a container registry protection tag rule

Deletes a container registry protection tag rule from a project.

DELETE /api/v4/projects/:id/registry/protection/tag/rules/:protection_rule_id

Supported attributes:

Attribute	Type	Required	Description
`id`	integer or string	Yes	ID or URL-encoded path of the project.
`protection_rule_id`	integer	Yes	ID of the container registry protection tag rule to be deleted.

If successful, returns 204 No Content.

Can return the following status codes:

204 No Content: The protection rule was deleted successfully.
400 Bad Request: The id or the protection_rule_id are missing or are invalid.
401 Unauthorized: The access token is invalid.
403 Forbidden: The user does not have permission to delete the protection rule.
404 Not Found: The project or the protection rule was not found.

Example request:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/7/registry/protection/tag/rules/1"