Update a Configuration

PUT

/configurations

Last modified:2025-04-23 16:52:41

OperationId:UpdateConfiguration

Update a configurution, must already exist or will get a 404.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

config-name

string

required

This is the name of the configuration

config-value

required

This is the configuration value. Can be a string, boolean, or integer

Any of

string

boolean

integer

domain

string

optional

This is the domain this configuration applies to. Defaults to "*"

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

description

string

optional

This describes the configuration

admin-ui-account-type

string

optional

This is the admin UI account type this configuraton effects

Default:

reseller

string

optional

This is the reseller or territory this configuration applies to. Defaults to "*"

Default:

user

string

optional

This is the user this configuration applies to. Defaults to "*"

Default:

user-scope

string

optional

This is the user scope this configuration applies to. Defaults to "*"

Default:

core-server

string

optional

This is the hostname this configuration applies to. Defaults to "*"

Default:

Example

{
  "config-name": "PORTAL_INVENTORY_PHONENUMBERS_IMPORT",
  "config-value": "no",
  "domain": "portal",
  "user": "*",
  "user-scope": "Office Manager",
  "core-server": "*",
  "reseller": "*",
  "admin-ui-account-type": "*",
  "description": "Allow inventory phonenumbers to be imported"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/configurations' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config-name": "PORTAL_INVENTORY_PHONENUMBERS_IMPORT",
    "config-value": "no",
    "domain": "portal",
    "user": "*",
    "user-scope": "Office Manager",
    "core-server": "*",
    "reseller": "*",
    "admin-ui-account-type": "*",
    "description": "Allow inventory phonenumbers to be imported"
}'

Responses

🟢202Accepted

application/json

Body

code

integer

required

message

string

required

Example

{
  "code": 202,
  "message": "Accepted"
}

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Modified at 2025-04-23 16:52:41

Create a Configuration

Delete a Configuration