v68

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,21696712.3 MB

repos

Update a deployment branch policy

Updates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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

Path parameters

ownerstring required

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

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

environment_namestring required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

branch_policy_idinteger required

The unique identifier of the branch policy.

Request body

namestring 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 request

{
  "name": "release/*"
}

Response

idinteger

The unique identifier of the branch or tag policy.

node_idstring

namestring

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

type'branch' | 'tag'

Whether this rule targets a branch or tag.

Example response

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