X-Road (NIIS)

X-Road (NIIS) System API

resources related to System info

GitHub OpenAPI

Operations 29

PUT /system/server-address update the server address #
GET /system/server-address Get current Security Server address #
GET /system/status get the system status #
GET /system/version get information for the system version #
GET /system/high-availability-cluster/status get the system status #
GET /system/anchor view the configuration anchor information #
POST /system/anchor Upload a new configuration anchor file when initializing a new security server #
PUT /system/anchor Upload a configuration anchor file to replace an existing one #
POST /system/anchor/previews Read and the configuration anchor file and return the hash for a preview #
GET /system/anchor/download download configuration anchor information #
GET /system/certificate view the security server certificate information #
POST /system/certificate generate a new internal TLS key and cert #
GET /system/certificate/export download the security server certificate as gzip compressed tar archive #
POST /system/certificate/csr generate new certificate request #
POST /system/certificate/import import new internal TLS certificate #
GET /system/external-rpc-ca view the Security Server external RPC CA details #
GET /system/external-rpc-ca/download download the Security Server external RPC CA as a PEM file #
GET /system/op-monitor-ca view the op-monitor CA details #
POST /system/op-monitor-ca upload or replace the op-monitor CA #
DELETE /system/op-monitor-ca delete the op-monitor CA #
GET /system/timestamping-services view the configured timestamping services #
POST /system/timestamping-services add a configured timestamping service #
POST /system/timestamping-services/delete delete configured timestamping service #
GET /system/timestamping-services/prioritization-strategy get timestamping services prioritization strategy #
GET /system/node-type get the node type #
GET /system/auth-provider-type get the authentication provider type #
GET /system/maintenance-mode get information for the maintenance mode #
PUT /system/maintenance-mode/enable enable maintenance mode of the security server #
PUT /system/maintenance-mode/disable disable maintenance mode of the security server #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/x-road-global/openapi/x-road-global-system-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/x-road-global/json-schema/x-road-global-certificate-details-schema.json

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-system-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

x-road-global-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: X Road Global System API
  contact:
    email: info@niis.org
    name: Nordic Institute for Interoperability Solutions (NIIS)
    url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
  description: 'Operations tagged system across 4 of this provider''s published API definitions: central-server-admin-openapi.yaml, security-server-admin-openapi.yaml, x-road-global-central-server-admin-openapi.yml, x-road-global-security-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: basepath for API v1
  url: /api/v1
security:
- ApiKeyAuth: []
tags:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://artifacts.apis.io/x-road-global/openapi/x-road-global-system-api-openapi.yml