Delete attestations by subject digest | GitHub API (unofficial showcase)

2 parameters

usernamestringrequired

The handle for the GitHub user account whose attestation you want to delete.

subject_digeststringrequired

The digest identifying the subject of the attestation to delete.

3 status codes

200Returns a response confirming the attestation was deleted.

204Returns no response body and confirms the attestation was deleted.

404Returned when the requested resource is not found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when the user account or an attestation for the specified subject digest cannot be found. The username path parameter must identify the GitHub user account, and the subject_digest path parameter must identify the attestation subject.

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

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

const result = await client.digest.delete({
  username: "octocat",
  subjectDigest: "example",
});

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

Request

Response

Errors