GIgitcafe
Actions

Remove a runner

Retires a runner and invalidates its credential; a busy runner's attempt is settled as lost. Idempotent. Requires authenticated authority and enforces current resource policy.

delete/api/orgs/{slug}/actions/pools/{poolId}/runners/{runnerId}

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token

Path parameters

slugstring required
poolIdstring required
runnerIdstring required

Response

Response for status 200

idstring required
poolIdstring required
namestring required
labelsstring[] required
os'linux' | 'macos' | 'windows' required
arch'x64' | 'arm64' required
agentVersionstring required
ephemeralboolean required
source'registration' | 'jit' required
state'idle' | 'busy' | 'offline' | 'retired' required
boundJobIdstring nullable required
lastSeenAtstring date-time nullable required
retiredAtstring date-time nullable required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.