Skip to content
forgit api docs

Update a deployment branch policy

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

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.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

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

repo
required
string

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

environment_name
required
string

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_id
required
integer

The unique identifier of the branch policy.

Request Body required

Section titled “ Request Body required ”
Media type application/json
Deployment branch policy name pattern
object
name
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.

string
Examples
Example default 
{
  "name": "release/*"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Deployment branch policy

Details of a deployment branch or tag policy.

object
id

The unique identifier of the branch or tag policy.

integer
node_id
string
name

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

string
type

Whether this rule targets a branch or tag.

string
Allowed values: branch tag
Examples
Example default 
{
  "id": 364662,
  "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
  "name": "release/*"
}