Update a deployment branch policy

PUT

/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}

Updates a deployment branch policy for an environment.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///environments//deployment-branch-policies/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "release/*"
}'

Response Example

{
    "id": 361471,
    "name": "release/*",
    "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
}

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.

environment_name

string

required

The name of the environment.

branch_policy_id

integer

required

The unique identifier of the branch policy.

Body Params application/json

name

string

required

The name pattern that branches must match in order to deploy to the environment.

Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*.
For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

Example:

release/*

Examples

Responses

🟢200Response

application/json

Body

Details of a deployment branch policy.

integer

optional

The unique identifier of the branch policy.

Example:

361471

name

string

optional

The name pattern that branches must match in order to deploy to the environment.

Example:

release/*

node_id

string

optional

Example:

MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=

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

Get a deployment branch policy

List forks