Read service status

GET

/services/{hostname}/{unit}

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

OperationId:ReadService

Returns the live state of one unit on one server, read from systemd.

Requires Super User scope.

Poll this after a start or restart: a 200 from the action only means the process was spawned. The unit is up when active-state is active, sub-state is running, and restart-count has stopped climbing.

A unit in the catalog that is not installed on the server answers 404 with the package that provides it. A unit that is not in the catalog answers 400.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Path Params

Responses

🟢200OK

application/json

The unit's state.

Bodyapplication/json

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Unit Not Installed

🟠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/netsapiens_nms' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Running

{
    "target-host": "core1.example.com",
    "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
}

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

List services on server

Reload unit files on server