List deployment branch policies

GET

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

Lists the deployment branch policies for an environment.

Anyone with read access to the repository can use this endpoint.

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

API method documentation

Parameters

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.

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

200

Response

Media type application/json

object

total_count

required

The number of deployment branch policies for the environment.

integer

branch_policies

required

Array<object>

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

{
  "total_count": 2,
  "branch_policies": [
    {
      "id": 361471,
      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
      "name": "release/*"
    },
    {
      "id": 361472,
      "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
      "name": "main"
    }
  ]
}