Disable a custom protection rule for an environment

4 parameters

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`.

repostringrequired

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

ownerstringrequired

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

protection_rule_idintegerrequired

The unique identifier of the protection rule.

1 status code

204Response

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.deploymentProtectionRules.delete({
  owner: "octocat",
  repo: "hello-world",
  environmentName: "Untitled",
  protectionRuleId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});