Read NMS configuration entry

GET

/nmsconfig/{config-name}

Last modified:2026-10-08 21:26:16

OperationId:ReadNmsConfig

Reads one key from every core server, one row per server holding it. Use it to confirm that a write reached every server.

Requires Super User or Super User Read Only. include-secrets=yes requires Super User.

The response is an array, not an object, and it is 200 with an empty array when no server holds the key. local-only=yes reads only the server that takes the request, and still answers an array. A server that does not answer within 3 seconds is left out.

config-in-sync, masking, and include-secrets work as on GET /nmsconfig.

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

Responses

🟢200OK

application/json

One row per server holding the key. An empty array when none does.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/nmsconfig/SMTP_HOST?local-only=yes&include-secrets=yes' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Drift between two servers

[
    {
        "config-name": "SMTP_HOST",
        "config-value": "smtp.example.com",
        "config-geo": "no",
        "config-timestamp-datetime": "2026-09-01T14:30:00+00:00",
        "config-server": "core1.example.com",
        "config-in-sync": "no",
        "config-servers-reporting": 2,
        "config-servers-expected": 2
    },
    {
        "config-name": "SMTP_HOST",
        "config-value": "smtp2.example.com",
        "config-geo": "no",
        "config-timestamp-datetime": "2026-09-02T08:00:00+00:00",
        "config-server": "core2.example.com",
        "config-in-sync": "no",
        "config-servers-reporting": 2,
        "config-servers-expected": 2
    }
]

Modified at 2026-10-08 21:26:16

List NMS configuration servers

Update NMS configuration entry