List services on server

GET

/services/{hostname}

Last modified:2026-09-29 18:52:15

OperationId:ListServices

Lists every unit in the service catalog with its live state on one server, read from systemd in a single call.

Requires Super User scope.

A catalog unit that is not installed on the server is still listed, with installed: false and empty state fields, so every server answers the same set of units. A unit installed under an alias, such as mysql for mariadb, is reported under the catalog name with resolved-unit naming what systemd loaded.

An active unit is not proof of health: every platform daemon restarts itself after a crash, so check restart-count too.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Every catalog unit and its state.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠429Too Many Requests

🔴500Server Error

🔴502Peer Unreachable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/services/core1.example.com' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Services

{
    "target-host": "core1.example.com",
    "units": [
        {
            "unit": "netsapiens_nms",
            "resolved-unit": "netsapiens_nms.service",
            "package": "netsapiens-core",
            "category": "netsapiens",
            "installed": true,
            "load-state": "loaded",
            "active-state": "active",
            "sub-state": "running",
            "unit-file-state": "enabled",
            "description": "NetSapiens NMS",
            "main-pid": 4242,
            "started-datetime": "2026-09-01T14:30:00+00:00",
            "need-daemon-reload": false,
            "restart-count": 0,
            "type": "simple",
            "allow-stop": true,
            "deferred": false
        },
        {
            "unit": "nscdr",
            "resolved-unit": "nscdr.service",
            "package": "netsapiens-cdr",
            "category": "netsapiens",
            "installed": false,
            "load-state": "not-found",
            "active-state": "",
            "sub-state": "",
            "unit-file-state": "",
            "description": "",
            "main-pid": null,
            "started-datetime": null,
            "need-daemon-reload": false,
            "restart-count": 0,
            "type": "",
            "allow-stop": true,
            "deferred": false
        }
    ]
}

Modified at 2026-09-29 18:52:15

List controllable services

Read service status