A newer version is available. For the latest information, see the
current release documentation.
Delete runneredit
Delete a runner by id.
Requestedit
DELETE /api/v1/platform/infrastructure/runners/{runner_id}
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The identifier for the runner |
Responsesedit
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XDELETE {{hostname}}/api/v1/platform/infrastructure/runners/{runner_id} \
-H "Authorization: ApiKey $ECE_API_KEY"