Read configuration - NetSapiens API v2

Returns the value of one configuration setting that applies in the context you describe with the key parts: the most specific matching row. Every scope that can read configurations can call it, and reads only its own tiers and the system rows. With no matching row, the definition's default 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 ********************

Responses

🟢200OK

application/json

The most specific row that applies, as an array of at most one row, or an empty array when none does. Rows are limited to your own tiers and the system rows: Super User and Super User Read Only read every row, a Reseller its territory's rows and those of domains in it, an Office Manager its own domain's rows, and other scopes the rows for their own domain, user, and scope.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

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": "*" } ]