Sign in
x-road-instances

get list of known x-road instance identifiers

Changed on
<h3>Administrator lists x-road instance identifiers</h3>
get/xroad-instances

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/xroad-instances
  • Auth: API key in header Authorization

Response

x-road instance identifiers

identifierstring text required

x-road instance identifier

localboolean required

is this the local x-road instance

Changes

  • 4db3a1928035Revision changes
    • ▲

      the response property's maxLength was unset from 255 for the response status

    • ▲

      the response property's minLength was decreased from 1 to 0 for the response status

    • ▲

      the response's property type changed from string to object, and format from text to no format for status

    • ○

      api operation id getXroadInstances removed and replaced with getXRoadInstances

    • ○

      api tag x-road-instances added

    • ○

      api tag xroad-instances removed

    • ○

      added the required property / to the response with the status

    • ○

      added the required property / to the response with the status