Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
repos

Get a deployment branch policy

Gets a deployment branch or tag policy 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.

get/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.

Response

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"
}