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

Create a deployment branch policy

Creates a deployment branch or tag policy for an environment.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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

3 parameters · 2 body fields
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`.
namestringrequired
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](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
typestringoptional
Whether this rule targets a branch or tag
Allowed:branchtag

3 status codes
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
303Response if the same branch name pattern already exists
404Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false

Error handling

A 404 is returned: Not Found or deployment_branch_policy.custom_branch_policies property for the environment is set to false.