Create configuration definition

Creates a configuration definition. A configuration definition describes one setting: what it controls, its default value, its data-type, the release it first applies to, and whether a Reseller may set it. Configuration rows (/configurations) then set values for it at each tier.

Requires Super User scope. Every other scope gets 403.

config-name, description, default, code-version, and data-type are required. config-name takes letters, digits, and @ . - _ '. config-def-allow-reseller-access and config-def-allow-hostname take yes or no and default to yes; the scope-specific defaults default to empty. A name that already has a definition returns 409. A masked default value for a secret-named setting returns 400.

Definitions the platform ships are reloaded from its master list on every upgrade, which resets their fields; a definition you create keeps its values. The definition is published over the service bus (SBUS) and applied on every server shortly after, so 202 means accepted, not yet stored.

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/config-definitions' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "config-name": "PORTAL_SHOW_SHARED_CONTACTS", "description": "Show shared contacts to every user", "default": "no", "code-version": "v44.0", "data-type": "boolean", "config-def-allow-reseller-access": "yes", "tags": "portal,contacts" }'