Read one NMS configuration entry

GET

/nmsconfig/{config-name}

Last modified:2026-08-26 23:03:15

OperationId:ReadNmsConfig

Read a single configuration key.

The response is an array, not an object. This read fans out like the collection, so it answers one row per server — which is exactly what makes it useful for confirming that a write has landed everywhere. local-only=yes narrows it to this server, and the response is still an array of one.

Masking and include-secrets behave as on GET /nmsconfig.

Requires the Super User or Super User Read Only scope.

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 this key

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

[
    {
        "config-name": "SMTP_HOST",
        "config-value": "smtp.example.com",
        "config-geo": "no",
        "config-timestamp-datetime": "string",
        "config-server": "core1.example.com",
        "config-value-redacted": "yes",
        "config-in-sync": "yes"
    }
]

Modified at 2026-08-26 23:03:15

List cluster servers and their configuration state

Update an NMS configuration entry