GitHub API (unofficial showcase)
PUT/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}

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.

4 parameters · 1 body field
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
environment_namestringrequired
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_idintegerrequired
The unique identifier of the branch policy.
namestringrequired
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](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).

1 status code
200Response
idintegeroptional
The unique identifier of the branch or tag policy.
node_idstringoptional
namestringoptional
The name pattern that branches or tags must match in order to deploy to the environment.
typestringoptional
Whether this rule targets a branch or tag.
Allowed:branchtag