apicheats.dev github/llms.txt Raw .md
PUT

PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id} — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Update a deployment branch policy

Base URL
https://api.github.com
Auth
Authorization: Bearer <GITHUB_API_KEY>
Last verified
2026-10-20 · upstream hash matched
Actions Try in browser→
Agents: curl -H "Accept: text/markdown" this URL
→ 302 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X PUT 'https://api.github.com/repos/example-owner/example-repo/environments/example-environment-name/deployment-branch-policies/10' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "name": "release/*"}'

Parameters

Name In Type Required Description
owner path string Yes The account owner of the repository. The name is not case sensitive.
repo path string Yes The name of the repository without the `.git` extension. The name is not case sensitive.
environment_name path string Yes 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_id path integer Yes The unique identifier of the branch policy.
name body string Yes The name pattern that branches 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).

Response 200 OK

{
  "id": 361471,
  "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
  "name": "release/*",
  "type": "branch"
}
Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.