Skip to content

Disable a custom protection rule for an environment

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

Disables a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

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

API method documentation

environment_name
required
string

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

repo
required
string

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

owner
required
string

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

protection_rule_id
required
integer

The unique identifier of the protection rule.

Response