It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.
The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Delete runner
editDelete runner
editDelete a runner by id.
Request
editDELETE /api/v1/platform/infrastructure/runners/{runner_id}
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
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
editcurl -XDELETE https://{{hostname}}/api/v1/platform/infrastructure/runners/{runner_id} \ -H "Authorization: ApiKey $ECE_API_KEY"