Get a coordinator

GET /platform/infrastructure/coordinators/{coordinator_id}

Auth

Retrieve overview of a single coordinator.

Path parameters

coordinator_id string required: The identifier for the coordinator

Responses

An overview of a coordinator instance.

application/json

name string required: Name of this coordinator
public_hostname string required: Public hostname of this coordinator
leader_port integer · format: int32 required: Leader port of this coordinator
election_port integer · format: int32 required: Election port of this coordinator
client_port integer · format: int32 required: Client port of this coordinator
attributes map string to string required: Attributes of this coordinator

Unable to find coordinator {coordinator_id}. Edit your request, then try again. (code: coordinators.coordinator_not_found)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/platform/infrastructure/coordinators/${COORDINATOR_ID}" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "name": "string",
  "public_hostname": "string",
  "leader_port": 0,
  "election_port": 0,
  "client_port": 0,
  "attributes": {
    "key": "string"
  }
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

Path parameters

Responses

Response headers