provider repos GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
@utdk/github /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
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](https://docs.github.com/actions/deployment/targeting-different-environments/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](https://docs.github.com/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
environment_name path required
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string
owner path required
The account owner of the repository. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

repos.getAllDeploymentProtectionRules
GET/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
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](https://docs.github.com/actions/deployment/targeting-different-environments/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](https://docs.github.com/rest/apps/apps#get-an-app). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.

Parameters

required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

required

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

required

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.repos.getAllDeploymentProtectionRules()