Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
repos

Create a custom deployment protection rule on an environment

Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

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

post/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules

Path parameters

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.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

ownerstring required

The account owner of the repository. The name is not case sensitive.

Request body

integration_idinteger

The ID of the custom app that will be enabled on the environment.

Response

The enabled custom deployment protection rule

idinteger required

The unique identifier for the deployment protection rule.

node_idstring required

The node ID for the deployment protection rule.

enabledboolean required

Whether the deployment protection rule is enabled for the environment.

Example response

{
  "id": 3515,
  "node_id": "MDQ6R2F0ZTM1MTU=",
  "enabled": true,
  "app": {
    "id": 3515,
    "slug": "my-custom-app",
    "integration_url": "https://api.github.com/apps/custom-app-slug",
    "node_id": "MDQ6R2F0ZTM1MTU="
  }
}