DELETE/orgs/{org}/actions/runners/{runner_id}

Delete a self-hosted runner from an organization

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

Authenticated users must have admin access to the organization to use this endpoint.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

orgstringrequired

The organization name. 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({
  org: "acme-inc",
  runnerId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
});

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

Request

Response

Errors