Create a tag protection state for a repository

POST

/repos/{owner}/{repo}/tags/protection

This creates a tag protection state for a repository.
This endpoint is only available to repository administrators.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///tags/protection' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pattern": "v1.*"
}'

Response Example

201 - Example 1

{
    "created_at": "2011-01-26T19:01:12.000Z",
    "enabled": true,
    "id": 2,
    "pattern": "v1.*",
    "updated_at": "2011-01-26T19:01:12.000Z"
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Body Params application/json

pattern

string

required

An optional glob pattern to match against when enforcing tag protection.

Examples

Responses

🟢201Response

application/json

Body

Tag protection

created_at

string

optional

Example:

2011-01-26T19:01:12.000Z

enabled

boolean

optional

Example:

true

integer

optional

Example:

pattern

string

required

Example:

v1.*

updated_at

string

optional

Example:

2011-01-26T19:01:12.000Z

🟠403403

🟠404404

Modified at 2023-08-15 02:59:24

List tag protection states for a repository

Delete a tag protection state for a repository