# X-Road (NIIS) System API

**Canonical:** https://apis.io/apis/x-road-global/x-road-global-system-api/  
**Provider:** X-Road (NIIS) — https://apis.io/providers/x-road-global/  
**Base URL:** https://{security-server-host}:4000/api/v1  
**Documentation:** https://docs.x-road.global/

X-Road (NIIS) System API is one of 40 APIs that [X-Road (NIIS)](https://apis.io/providers/x-road-global/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 1 JSON Schema definition. Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification and 1 JSON Schema.

resources related to System info

## Operations (29)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/x-road-global/openapi/x-road-global-system-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/x-road-global/json-schema/x-road-global-certificate-details-schema.json

## Other X-Road (NIIS) APIs (12)

- [X-Road Management Services (SOAP)](https://apis.io/apis/x-road-global/management-services/)
- [X-Road Environmental and Operational Monitoring (SOAP)](https://apis.io/apis/x-road-global/monitoring/)
- [X-Road (NIIS) Backups API](https://apis.io/apis/x-road-global/x-road-global-backups-api/)
- [X-Road (NIIS) Certificate Authorities API](https://apis.io/apis/x-road-global/x-road-global-certificate-authorities-api/)
- [X-Road (NIIS) Certification Services API](https://apis.io/apis/x-road-global/x-road-global-certification-services-api/)
- [X-Road (NIIS) Clients API](https://apis.io/apis/x-road-global/x-road-global-clients-api/)
- [X-Road (NIIS) Configuration Parts API](https://apis.io/apis/x-road-global/x-road-global-configuration-parts-api/)
- [X-Road (NIIS) Configuration Source Anchors API](https://apis.io/apis/x-road-global/x-road-global-configuration-source-anchors-api/)
- [X-Road (NIIS) Configuration Sources API](https://apis.io/apis/x-road-global/x-road-global-configuration-sources-api/)
- [X-Road (NIIS) Dataspace API](https://apis.io/apis/x-road-global/x-road-global-dataspace-api/)
- [X-Road (NIIS) Diagnostics API](https://apis.io/apis/x-road-global/x-road-global-diagnostics-api/)
- [X-Road (NIIS) Ds Tls Certification Authorities API](https://apis.io/apis/x-road-global/x-road-global-ds-tls-certification-authorities-api/)

## Tags

System

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/x-road-global/x-road-global-system-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/x-road-global/.