List configurations

Lists configuration rows. Configurations are the named settings the portal and the API look up at run time, such as PORTAL_SHOW_SHARED_CONTACTS. Each row sets one value for one combination of key parts: reseller, domain, user, user-scope, admin-ui-account-type, and core-server. A key part of * matches everything, so the row with every key part * is the system value.

Every scope reads its own tiers and the system rows, never another tenant's:

Super User and Super User Read Only read every row.

Reseller reads its territory's rows, rows of domains in its territory, and system rows.

Office Manager reads its own domain's rows and system rows.

Other scopes read the rows for their own domain, user, and scope, and system rows. Sending a user-scope other than your own returns 403.

Values of secret-named settings are masked, as /nmsconfig masks them: a name containing a secret keyword (password, key, token, secret, and others), less the names in the NsConfigurationMaskExempt setting, has its value masked unless the value is shorter than NsConfigurationMaskMinLength (default 4) or a plain switch (yes, no, true, false, on, off, enabled, disabled). A Super User can send include-secrets=yes to get them in clear; any other scope that sends it gets 403.

How the filters work:

config-name takes one name, a pattern with *, or a comma-separated list. It defaults to *.

Each key part you send matches that value. Each key part you leave out matches only *, so with no filters the list holds the system rows.

For one exact config-name, rows with * in a key part you sent match too, and the most specific row comes first. That row is the value that applies in that context. include_wildcards turns this on or off.

The result has one row per config name.

Rows are paged with start and limit, which defaults to 100. No match returns an empty array. GET /configurations/count counts differently: a key part it is not sent matches every value. To see what each setting means, call GET /config-definitions.

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/configurations?reseller=example-reseller&user=1001&user-scope=Office%20Manager&admin-ui-account-type=Domain&core-server=core1.example.com&include_wildcards=true&filter=CONTACTS&start=undefined&limit=100&sort=config_name%20asc&include-secrets=no' \ --header 'Authorization: Bearer <token>'

[ { "config-name": "PORTAL_SHOW_SHARED_CONTACTS", "config-value": "yes", "description": "Show shared contacts to every user", "reseller": "*", "domain": "example.com", "user": "*", "user-scope": "*", "admin-ui-account-type": "*", "core-server": "*" } ]

Request

Responses