What Kind of APIs the Security Server Provides?

Open

Image 1. X-Road interfaces.

The APIs represent different API styles: SOAP, REST and JMX. Some information, e.g. environmental and operational monitoring data, is available via multiple APIs representing different API styles. Instead, other information is available via a single API.

Below there's a list of the current Security Server APIs.

Message Exchange

Message exchange via X-Road is done using the X-Road message protocols that support REST and SOAP.

Meta Services

Meta services provide methods that can be used to discover what services are available within an X-Road instance and download service descriptions files (OpenAPI / WSDL).

More information:

• https://docs.x-road.global/Protocols/pr-mrest_x-road_service_metadata_protocol_for_rest.html

• https://docs.x-road.global/Protocols/pr-meta_x-road_service_metadata_protocol.html

Environmental Monitoring

Environmental monitoring provides technical monitoring information about the Security Server, e.g. details of the security servers such as operating system, memory, disk space, CPU load, running processes and installed packages, etc.

More information:

• https://docs.x-road.global/EnvironmentalMonitoring/Monitoring-messages.html

Operational Monitoring

Operational monitoring provides operational monitoring information and statistics about the Security Server, e.g. which services have been called, how many times, what is the average response time, etc.

More information:

• https://docs.x-road.global/OperationalMonitoring/Protocols/pr-opmon_x-road_operational_monitoring_protocol_Y-1096-2.html

• https://docs.x-road.global/OperationalMonitoring/Protocols/pr-opmonjmx_x-road_operational_monitoring_jmx_protocol_Y-1096-3.html

Signed Document Download

An API for retrieving signed and time-stamped messages processed by the Security Server.

More information:

• https://docs.x-road.global/Manuals/ug-sigdoc_x-road_signed_document_download_and_verification_manual.html

Healthcheck

The health check API can be used to ping the Security Server using HTTP to see if it is healthy and likely to be able to send and receive messages.

More information:

• https://docs.x-road.global/Manuals/LoadBalancing/ig-xlb_x-road_external_load_balancer_installation_guide.html#34-health-check-service-configuration

Management API

Management APIs provides access to all the administrative features of the Central Server and Security Server - all the features that are available in the UIs are available through the APIs too.

More information:

• https://docs.x-road.global/Manuals/ug-ss_x-road_6_security_server_user_guide.html#19-management-rest-api

• https://docs.x-road.global/Manuals/ug-cs_x-road_6_central_server_user_guide.html#17-management-rest-api

Related articles