List processes across the cluster

GET

/processes

Last modified:2026-09-18 17:05:15

OperationId:listProcesses

Returns process records from NsApi.processes — one per process per server, across every server on the platform. Filterable by application, hostname, element ID, element type, element version, status, MAC address, IP address and domain DB. Results are ordered by hostname then application unless sort says otherwise.
Requires Super User or Super User Read Only scope. The gate is in the controller, not scope_priv: scope_priv cannot express "Super User only", so a Reseller token passes the ACL check and is refused here.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200OK

application/json

Process records from across the cluster.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠405

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/processes?application=undefined&hostname=undefined&element_id=undefined&element_type=undefined&element_version=undefined&element_status=undefined&mac_address=undefined&ip_address=undefined&domain_db=undefined&limit=undefined&start=undefined&sort=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success Example

{
    "process-element-id": "sipbx",
    "process-application": "SiPbx",
    "process-element-type": "SiPBx",
    "process-element-version": "v46-0-0x100",
    "process-status": "Running",
    "process-start-time": "Sat, 28 Mar 2026 14:30:14 GMT",
    "process-status-update-time": "Tue, 07 Apr 2026 20:51:41 GMT",
    "process-hostname": "core2-phx.v46.nseng.dev",
    "process-mac-address": "02:00:17:0D:5C:DC",
    "process-ip-address": "172.16.1.12",
    "process-app-address": "172.16.1.12:5060",
    "process-app-address-v6": "[2603:c020:15:9800::9449]:5060",
    "process-wan-address": "137.131.3.250:5060",
    "process-subnet-mask": "255.255.255.0",
    "process-domain-db": ""
}

Modified at 2026-09-18 17:05:15

Delete a remote storage service

List processes on one server