Runners

Delete (or drain) a runner pool

Changed on

Deletes a runner pool, or moves it to draining when jobs are still active or queued. The response status says which: deleted or draining. A delete cancels the pool's subscription. A draining pool keeps its subscription until you call delete again once its jobs finish.

Requires the runner.write permission. See Permissions for the roles and API key permissions that include it.

delete/v1/orgs/{orgId}/runner-pools/{id}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/runner-pools/{id}
  • Auth
    HTTP bearer

Path parameters

orgIdstring required
idstring required

Response

OK

statusstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status