Sign in

v56

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

Get all deployment protection rules for an environment

Gets all custom deployment protection rules that are enabled 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 the documentation for the GET /apps/{app_slug} endpoint.

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

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.

Response

List of deployment protection rules

total_countinteger

The number of enabled custom deployment protection rules for this environment

Example response

{
  "$ref": "#/components/examples/deployment-protection-rules"
}