Delete runner

View as Markdown
DELETE /platform/infrastructure/runners/{runner_id}
Basic auth Api key

Delete a runner by id.

Path parameters

  • runner_id string Required

    The identifier for the runner

Responses

  • 200 application/json

    The runner specified by {runner_id} was deleted.
  • 400 application/json

    The runner specified by {runner_id} could not be deleted. (code: runners.runner_deletion_failed)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is runners.runner_deletion_failed.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
  • 404 application/json

    The runner specified by {runner_id} cannot be found. (code: runners.runner_not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is runners.runner_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
DELETE /platform/infrastructure/runners/{runner_id} 
curl \
 --request DELETE 'https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id}' \
 --user "username:password"