Sample - GitHub REST API
GET/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}

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.

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

4 parameters
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`.
protection_rule_idintegerrequired
The unique identifier of the protection rule.

1 status code
200Response
idintegerrequired
The unique identifier for the deployment protection rule.
node_idstringrequired
The node ID for the deployment protection rule.
enabledbooleanrequired
Whether the deployment protection rule is enabled for the environment.
appobjectrequired
A GitHub App that is providing a custom deployment protection rule.