Update configuration keys

PUT

/ipaware/config

Last modified:2026-07-18 16:57:06

OperationId:updateConfig

Applies {key: value, ...} to the conf file (a {"updates": {...}} wrapper is also accepted; POST works identically). Every value is validated with the loader's own rules — integer keys must be integers, enum keys must hold a listed value (booleans map to yes/no), values must be single-line without #. Any invalid key rejects the whole request (400 with per-key details) and nothing is written. listen_addr/listen_port are refused: breaking the listener would sever this API. Comments and ordering in the file are preserved; a backup of the previous content is written to the state directory. Changes take effect on the next restart.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Keys written to the conf file.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

🔴500Server Error

🔴501

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

cURL

enableFirewallbooleansAccepted

curl --location --request PUT 'https://awqacore01.crexendocloud.com/ns-api/v2/ipaware/config' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "firewall_enable": "yes",
    "firewall_block_ttl": 86400
}'

Response Example

200 - Example 1

{
    "status": "updated",
    "updated": {
        "property1": "string",
        "property2": "string"
    },
    "removed": [
        "string"
    ],
    "pending": [
        {
            "key": "string",
            "running": null,
            "file": null
        }
    ],
    "restartRequired": true
}

Modified at 2026-07-18 16:57:06

Read the full configuration

Read one configuration key