Unstar a gist | Sample - GitHub REST API

1 parameter

gist_idstringrequired

The unique identifier of the gist from which to remove the authenticated user's star.

4 status codes

204Confirms that the authenticated user's star was removed from the gist.

304Returned when the requested representation has not changed.

403Returned when removing the gist star is forbidden.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Returned when the specified gist cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned when the authenticated user is not permitted to remove the gist star. A 404 is returned when the gist identified by gist_id cannot be found. gist_id must identify the gist whose star you want to remove.

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