Read configuration

Returns the value of one setting in the context you describe with the key parts. 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.

Name every key part that applies, such as reseller, domain, and user. For each one you send, rows with that value or with * match, and the most specific row is returned. Each key part you leave out matches only *, so with none you get the system value. include_wildcards=false matches only the exact values you sent.

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.

The response is an array with at most one row. A setting with no matching row returns an empty array: its definition's default then applies (GET /config-definitions/{config-name}).

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/PORTAL_SHOW_SHARED_CONTACTS?domain=example.com&reseller=example-reseller&user=1001&core-server=core1.example.com&user-scope=Office%20Manager&admin-ui-account-type=Domain&include_wildcards=true&include-secrets=no' \ --header 'Authorization: Bearer <token>'

[ { "config-name": "PORTAL_SHOW_SHARED_CONTACTS", "config-value": "no", "description": "Hide shared contacts in this domain", "reseller": "*", "domain": "example.com", "user": "*", "user-scope": "*", "admin-ui-account-type": "*", "core-server": "*" } ]

Request

Responses