Delete a repository Actions policy | GitHub API (unofficial showcase)

3 parameters

ownerstringrequired

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

repostringrequired

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

policy_idintegerrequired

The ID of the policy to delete.

3 status codes

204Returns no content after the Actions policy is deleted.

404Returned when the repository or policy cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

500Returned when an internal server error occurs.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the repository or policy cannot be found. A 500 indicates an internal server error; the policy_id path parameter must identify the policy to delete.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.policies.delete({
  owner: "octocat",
  repo: "hello-world",
  policyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors