Get a coordinator

GET /platform/infrastructure/coordinators/{coordinator_id}
Basic auth Api key

Retrieve overview of a single coordinator.

Path parameters

  • coordinator_id string Required

    The identifier for the coordinator

Responses

  • 200 application/json

    An overview of a coordinator instance.

    Hide response attributes Show response attributes object
    • name string Required

      Name of this coordinator

    • public_hostname string Required

      Public hostname of this coordinator

    • leader_port integer(int32) Required

      Leader port of this coordinator

    • election_port integer(int32) Required

      Election port of this coordinator

    • client_port integer(int32) Required

      Client port of this coordinator

    • attributes object Required

      Attributes of this coordinator

      Hide attributes attribute Show attributes attribute object
      • * string Additional properties
  • 404 application/json

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

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is coordinators.coordinator_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
GET /platform/infrastructure/coordinators/{coordinator_id} 
curl \
 --request GET 'https://{{hostname}}/api/v1/platform/infrastructure/coordinators/{coordinator_id}' \
 --user "username:password"