X-Road (NIIS)

X-Road (NIIS) X Road Instances API

x-road-instances endpoints

Documentation GitHub OpenAPI

Operations 1

GET /xroad-instances get list of known x-road instance identifiers #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/x-road-global/openapi/x-road-global-x-road-instances-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/x-road-global:x-road-global-x-road-instances-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: X Road Global X Road Instances API
  version: 2.1.0
  contact:
    name: Nordic Institute for Interoperability Solutions (NIIS)
    url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
    email: info@niis.org
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  description: 'Operations tagged x-road-instances across 2 of this provider''s published API definitions: security-server-admin-openapi.yaml, x-road-global-security-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v1
  description: basepath for API v1
security:
- ApiKeyAuth: []
tags:
- name: x-road-instances
  description: x-road-instances endpoints
paths:
  /xroad-instances:
    get:
      tags:
      - x-road-instances
      summary: get list of known x-road instance identifiers
      operationId: getXRoadInstances
      description: Administrator lists x-road instance identifiers
      responses:
        '200':
          description: x-road instance identifiers
          content:
            application/json:
              schema:
                type: array
                uniqueItems: true
                description: array of x-road instance identifiers
                items:
                  $ref: '#/components/schemas/XRoadInstance'
        '400':
          description: request was invalid
        '401':
          description: authentication credentials are missing
        '403':
          description: request has been refused
        '404':
          description: resource requested does not exists
        '406':
          description: request specified an invalid format
        '500':
          description: internal server error
    servers:
    - url: /api/v1
      description: basepath for API v1
components:
  schemas:
    XRoadInstance:
      type: object
      description: x-road instance
      required:
      - identifier
      - local
      properties:
        identifier:
          type: string
          readOnly: true
          format: text
          minLength: 1
          maxLength: 255
          description: x-road instance identifier
        local:
          type: boolean
          readOnly: true
          description: is this the local x-road instance
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: X-Road-ApiKey token=<api key>
x-refined-from:
- security-server-admin-openapi.yaml
- x-road-global-security-server-admin-openapi.yml