repos
List 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.
get/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
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.
Query parameters
per_pageinteger
The number of results per page (max 100).
pageinteger
Page number of the results to fetch.
Response
Response
Example response
{
"total_count": 2,
"branch_policies": [
{
"id": 361471,
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
"name": "release/*"
}
]
}