NaaS Endpoints⁠

NexumAPI provides a few additional endpoints that provide different insights into your present configuration and health of the service.

Operations⁠

health⁠

GET

Get the health status of your NaaS instance.

Responses

statusstringoptionalThe NaaS health status.

GET/health

GET /health HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json

keep-alive⁠

GET

Keep the NaaS instance warm and return a basic status response.

Responses

statusstringoptionalThe NaaS health status.

GET/keep-alive

GET /keep-alive HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json

connection-status⁠

GET

Get the connection status between the NaaS instance and SymXchange

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Responses

GET/connection-status

GET /connection-status HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT

host-configs⁠

GET

Get configured SymXchange host metadata for your NaaS instance.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Responses

hoststringoptional

idstringoptional

defaultbooleanoptional

securebooleanoptional

publicApiKeystringoptionalPath to the configured API public key.

tlsTruststorestring · nullableoptionalConfigured TLS truststore path, or null when not configured.

GET/host-configs

GET /host-configs HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT

operations⁠

GET

List of available operations for a specific SymXchange service and version.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Path Parameters

symstringrequired: Sym number
versionstringrequired: SymXchange version
servicestringrequired: SymXchange service name

Responses

No named fields defined.

GET/nexum/{sym}/{version}/{service}/operations

GET /nexum/627/{version}/{service}/operations HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT

supported-services⁠

GET

Get a list of supported SymXchange services on your NaaS instance.

Authorizations

Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Responses

GET/supported-services

GET /supported-services HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT