IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Search runners Get runner »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.13] ›RESTful API ›API reference ›Platform - Runners

Delete runner

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete runner

edit

Delete a runner by id.

Request

edit

DELETE /api/v1/platform/infrastructure/runners/{runner_id}

Path parameters

edit
Name Type Required Description

runner_id

string

Y

The identifier for the runner

Responses

edit
200

(EmptyResponse)

The runner specified by {runner_id} was deleted.

400

(BasicFailedReply)

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

Headers

x-cloud-error-codes (string; allowed values: [runners.runner_deletion_failed])
The error codes associated with the response
404

(BasicFailedReply)

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

Headers

x-cloud-error-codes (string; allowed values: [runners.runner_not_found])
The error codes associated with the response
449

(BasicFailedReply)

Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request example

edit
curl -XDELETE https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Search runners Get runner »