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.

Have an endpoint suggestion? Please let us know at [e-mail]. We're always looking to improve our feature set and be more of a use to the Symitar community.

Operations

health

get

Get the health status of your NaaS instance.

Responses

200

Successful operation.

application/json

statusstringOptional

The NaaS health status.

get/health

HTTPcURLJavaScriptPython

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

200

Successful operation.

{
  "status": "text"
}

keep-alive

get

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

Responses

200

Successful operation.

application/json

statusstringOptional

The NaaS health status.

get/keep-alive

HTTPcURLJavaScriptPython

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

200

Successful operation.

{
  "status": "text"
}

connection-status

get

Get the connection status between the NaaS instance and SymXchange

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

statusobjectOptional

The NaaS connection status with SymXchange.

retryingobject[]Optional

SymXchange devices that NaaS is still retrying after startup or a failed connection.

get/connection-status

HTTPcURLJavaScriptPython

GET /connection-status HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful operation.

{
  "status": {},
  "retrying": [
    {}
  ]
}

host-configs

get

Get configured SymXchange host metadata for your NaaS instance.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

Configured SymXchange host metadata.

hoststringOptional

idstringOptional

defaultbooleanOptional

securebooleanOptional

get/host-configs

HTTPcURLJavaScriptPython

GET /host-configs HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful operation.

[
  {
    "host": "text",
    "id": "text",
    "default": true,
    "secure": true,
    "syms": [
      {
        "sym": "text",
        "port": "text"
      }
    ]
  }
]

operations

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

symstringRequired

Sym number

versionstringRequired

SymXchange version

servicestringRequired

SymXchange service name

Responses

200

Successful operation.

application/json

string[]Optional

List of operations.

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

HTTPcURLJavaScriptPython

GET /nexum/{sym}/{version}/{service}/operations HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful operation.

[
  "text"
]

supported-services

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation.

application/json

Supported SymXchange services and versions, grouped by configured host or credit union identifier.

get/supported-services

HTTPcURLJavaScriptPython

GET /supported-services HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful operation.

{
  "ANY_ADDITIONAL_PROPERTY": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}