Start, stop, or restart service

Starts, stops, or restarts one systemd unit on one server and waits up to 90 seconds for systemctl to finish. Requires Super User scope. A stop or restart of netsapiens_nms, netsapiens_ncs, or netsapiens_licf drops the calls on that server immediately: this route does not check for active calls.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The action ran. success reports whether the unit did what was asked: a unit that fails to start is a 200 with success: false. A platform daemon answers as soon as its process is spawned (ready-unknown: true), so poll GET /services/{hostname}/{unit} to confirm it stayed up.

Bodyapplication/json

🟢202Accepted

🟠400Bad Request

🟠401Authentication Required

🟠403Forbidden

🟠404Unit Not Installed

🟠409Conflict

🟠429Too Many Requests

🔴500Server Error

🔴502Peer Unreachable

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/services/core1.example.com/netsapiens_nms/restart?ticket=API-1234' \ --header 'X-Ticket: API-1234' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ticket": "API-1234" }'

{ "unit": "netsapiens_nms", "resolved-unit": "netsapiens_nms.service", "action": "restart", "target-host": "core1.example.com", "package": "netsapiens-core", "category": "netsapiens", "success": true, "exit-code": 0, "prior-active-state": "active", "active-state": "active", "sub-state": "running", "daemon-reloaded": true, "restart-count": 0, "type": "simple", "ready-unknown": true, "output": "" }