List NMS configuration entries

List entries from config_config, the NMS key/value configuration table.

Reads fan out across the cluster by default. config_config exists on every core server and is kept in step by the service bus, so the interesting question is usually whether the servers agree — and a read that only ever answers for the box it landed on cannot tell you. Every row therefore carries config-server, and one row is returned per (config-name, server). Pass local-only=yes for this server alone.

Two consequences worth planning for:

limit applies per server, so an N-server cluster can answer up to N × limit rows.

config-in-sync is no when the reporting servers disagree on that key. That covers both accidental drift and a deliberate per-server value written with config-server — nothing records intent, so the two are indistinguishable here.

Values whose key looks like a credential are masked. Sensitivity in this table lives in the row, not the column: the password, licence and third-party keys are all config-name values, so the key name is the only signal. Any key matching password, secret, key, token, auth, smtp, license, cert (and similar) comes back masked, with config-value-redacted: yes.

Two things narrow that, because the keyword list matches substrings and is deliberately broad:

NsNmsconfigMaskExempt names keys that are never masked. It ships covering the SMTP relay settings other than the password — SMTP_HOST, SMTP_PORT, SMTP_UID, SMTP_USER, SMTP_USERNAME — so only SMTP_PWD is hidden.

NsNmsconfigMaskMinLength (default 4) returns anything shorter in the clear. Without it, settings such as SendNqsTlsKeys or TraceRtpRelay — which hold yes or no and match only incidentally — were reduced to ****.

Values are never numerically coerced: config-value is returned as the text that is stored, so a leading or trailing zero survives.

Requires the Super User or Super User Read Only scope.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/nmsconfig?config-name=SMTP_HOST&config-geo=undefined&local-only=undefined&include-secrets=undefined&limit=undefined&start=undefined&sort=config_name%20ASC' \ --header 'Authorization: Bearer <token>'

[ { "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" } ]

List NMS configuration entries

Request

Responses