v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-01-0382859610.0 MB

repos

Create a deployment branch policy

Creates a deployment branch policy for an environment.

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration:write permission for the repository to use this endpoint.

post/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. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

Request body

namestring required

The name pattern that branches or tags must match in order to deploy to the environment.

Wildcard characters will not match /. For example, to match branches that begin with release/ and contain an additional single slash, use release/*/*. For more information about pattern matching syntax, see the Ruby File.fnmatch documentation.

Example request

{
  "name": "release/*"
}

Response

idinteger

The unique identifier of the branch policy.

node_idstring

namestring

The name pattern that branches must match in order to deploy to the environment.

Example response

{
  "id": 361471,
  "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
  "name": "release/*"
}