Delete a self-hosted runner from a repository

3 parameters

ownerstringrequired

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

repostringrequired

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

runner_idintegerrequired

Unique identifier of the self-hosted runner.

2 status codes

204Response

422Validation failed, or the endpoint has been spammed.

messagestringrequired

documentation_urlstringrequired

errorsarray<string>optional

Error handling

A 422 is returned: Validation failed, or 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.runners.delete({
  owner: "octocat",
  repo: "hello-world",
  runnerId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "errors": [
    "example_value"
  ]
}

Request

Response

Errors