Get a coordinator candidate

edit

Retrieve a coordinator candidate.

Request

edit

GET /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

Responses

edit
200

(CoordinatorCandidateInfo)

Info about a coordinator candidate.

404

(BasicFailedReply)

Unable to find coordinator candidate {coordinator_candidate_id}. Edit your request, then try again. (code: coordinators.candidate_not_found)

Headers

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

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id} \
-H "Authorization: ApiKey $ECE_API_KEY"