List controllable services

GET

/services/catalog

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

OperationId:ListServiceCatalog

Lists every systemd unit the service routes may control, with the actions allowed for each.

Requires Super User scope.

The list is fixed in the apt manager release and is the same on every server, so this call takes no hostname and asks no server. A unit that is not listed is refused with 400 on every other /services route. Use actions and allow-stop to decide which controls to offer; GET /services/{hostname} tells you which units are installed on a server.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Responses

🟢200OK

application/json

The controllable units.

Bodyapplication/json

🟠401Authentication Required

🟠403Forbidden

🟠429Too Many Requests

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Catalog

[
    {
        "unit": "netsapiens_nms",
        "aliases": [],
        "package": "netsapiens-core",
        "category": "netsapiens",
        "allow-stop": true,
        "deferred": false,
        "actions": [
            "start",
            "stop",
            "restart"
        ]
    },
    {
        "unit": "apache2",
        "aliases": [],
        "package": "apache2",
        "category": "infra",
        "allow-stop": false,
        "deferred": true,
        "actions": [
            "start",
            "restart"
        ]
    },
    {
        "unit": "mariadb",
        "aliases": [
            "mysql"
        ],
        "package": "mariadb-server",
        "category": "infra",
        "allow-stop": true,
        "deferred": false,
        "actions": [
            "start",
            "stop",
            "restart"
        ]
    }
]

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

List processes, projected to selected fields

List services on server