List Custom Scopes

Testing

GET

/scopes

Last modified:2026-08-27 23:58:55

OperationId:listCustomScopes

Returns every custom scope definition. Pass include-built-in=yes to append the built-in scopes (marked built-in: yes) so one call feeds a scope picker.

Requires Super User (reads also allow Super User Read Only) — enforced in the controller; scope_priv cannot express it.

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

Array of custom scopes.

Bodyapplication/json

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/scopes?parent-scope=undefined&enabled=undefined&include-built-in=undefined&sort=undefined&start=undefined&limit=undefined' \
--header 'Authorization: Bearer <token>'

Response Example

[
    {
        "name": "Platform Manager",
        "parent-scope": "Super User",
        "description": "Ops admin — no platform config or routing changes",
        "read-only": "no",
        "modifications": {
            "nsconfig": "none",
            "route": "ro",
            "device": "no-delete",
            "phonenumber": "update-only"
        },
        "enabled": "yes",
        "built-in": "yes"
    }
]

Modified at 2026-08-27 23:58:55

List NMS Status Servers

Create Custom Scope