Delete a gist | GitHub API (unofficial showcase)

1 parameter

gist_idstringrequired

The unique identifier of the gist to delete.

4 status codes

204Returns no response body after deleting the gist.

304Returned when the resource has not been modified.

403Returned when the request is forbidden.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when the requested gist cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when the authenticated user is not permitted to delete the gist. A 404 is returned when no gist matches the gist_id path parameter.

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

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

const result = await client.gists.delete({ gistId: "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