Sample - GitHub REST API
GET/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

4 parameters
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.

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