Delete coordinator candidate

edit

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

Delete coordinator candidate

edit

Delete a coordinator candidate by id.

Request

edit

DELETE /api/v1/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}

Path parameters

edit

Name	Type	Required	Description
`coordinator_candidate_id`	`string`	Y	The identifier for the coordinator candidate

Query parameters

edit

Name	Type	Required	Description
`version`	`string`	N	cloud resource version

Responses

edit

200

(EmptyResponse)

The coordinator candidate specified by {coordinator_candidate_id} was deleted.

400

(BasicFailedReply)

The coordinator specified by {coordinator_candidate_id} could not be deleted. (code: coordinators.candidate_deletion_failed)

Headers

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

404

(BasicFailedReply)

The coordinator candidate specified by {coordinator_candidate_id} cannot be found. (code: coordinators.candidate_not_found)

Headers

x-cloud-error-codes (string; allowed values: [coordinators.candidate_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/coordinators/candidates/{coordinator_candidate_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get coordinator candidates Get a coordinator candidate »