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. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///environments//deployment-branch-policies'

Response Example

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

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.

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

branch_policies

array[object (Deployment branch policy) {3}]

required

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=

total_count

integer

required

The number of deployment branch policies for the environment.

Example:

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

Create or update an environment

Create a deployment branch policy