Create configuration - NetSapiens API v2

Creates a configuration row: one value for one combination of key parts. Each key part you leave out is *, except that below Reseller your own domain and user fill in. 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.

Who can write:

Super User writes any row, including system rows, for any name.

Reseller writes rows for its own territory or a domain in it. With neither reseller nor domain, the row is stored for your territory.

Office Manager and Route Manager write their own domain's rows. domain left out means your domain.

Other scopes with write rights write only their own user's rows in their own domain. user and domain left out mean yours.

Super User Read Only, Route Manager Reseller, Call Center Supervisor, Site Manager, and Office Manager Read-Only are read-only and get 403.

Below Super User, the setting must have a definition whose config-def-allow-reseller-access is yes. A key outside your tier returns 403.

config-name takes letters, digits, and @ . - _ '; * returns 400. config-value is stored as a string and is not checked against the definition's data-type. A row with the same key returns 409; change it with PUT /configurations/{config-name}. A masked value for a secret-named setting returns 400: send the real value.

The row is checked, then published over the service bus (SBUS) and applied on every server shortly after, so 202 means accepted, not yet stored. Send domain, reseller, and user in the body: in the query string they're ignored.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢202Accepted

application/json

The change passed every check and was published over the service bus (SBUS); it is applied on every server shortly after: {"code": 202, "message": "Accepted"}. Read the row back to confirm it.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409Conflict

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/configurations' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "config-name": "PORTAL_SHOW_SHARED_CONTACTS", "config-value": "yes", "description": "Show shared contacts to every user" }'