Delete a Git reference | Sample

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.

refstringrequired

The Git reference to delete, such as a branch or tag reference.

3 status codes

204Returns no response body after successfully deleting the Git reference.

409Returned when the reference cannot be deleted because of a conflict.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

422Returned when validation fails, an attempt is made to delete the default branch, or the endpoint has been spammed.

Error handling

A 409 is returned when the reference cannot be deleted because of a conflict. A 422 is returned when validation fails, when ref identifies the default branch, or when the endpoint has been spammed.

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.refs.delete({
  owner: "octocat",
  repo: "hello-world",
  ref: "main",
});

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

Request

Response

Errors