POST

Try POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies — GitHub API

GitHub playground

Create a deployment branch policy

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository without the `.git` extension. The name is not case sensitive. environment_name · required · string The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Body application/json

2 body fields

name · required · string — 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).
type · optional · string — Whether this rule targets a branch or tag