provider repos POST /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
@utdk/github /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
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](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
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.createDeploymentProtectionRule
POST/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules
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](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.

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.

Input

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

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.createDeploymentProtectionRule()