v56

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

repos

Get a custom deployment protection rule

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "Using environments for deployment."

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

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

get/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}

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.

protection_rule_idinteger required

The unique identifier of the protection rule.

Response

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="
  }
}