NaaS Endpoints

Know which NexumAPI specific endpoints are available and what they do.

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

circle-check

Operations

health

get

Get the health status of your NaaS instance.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/health
200

Successful operation.

connection-status

get

Get the connection status between the NaaS instance and SymXchange

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/connection-status
200

Successful operation.

operations

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
versioninteger · floatRequired

SymXchange version

servicestringRequired

SymXchange service name

Responses
get
/nexum/627/{version}/{service}/operations
200

Successful operation.

supported-services

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
get
/supported-services
200

Successful operation.

Last updated

Was this helpful?