Update configuration

PUT

/ipaware/{hostname}/config

Last modified:2026-10-09 00:59:51

OperationId:updateConfig

Sets one or more configuration keys of the IP rules service on one server. Requires Super User scope.

Every value is checked first. If any key is invalid, nothing is written and the answer lists each problem in details. listen_addr and listen_port cannot be changed here. Keys in liveKeys take effect at once; the rest take effect when the service restarts, and effects says which applies to each key. Keys in replicableKeys are also copied to the other servers in the cluster; other keys change this server only. Restart the service with POST /ipaware/{hostname}/restart.

The request goes to the IP rules service on {hostname}, and its status and body come back unchanged. Errors the API decides itself use the code and message form; errors from the service use the error form.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Every key was written.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Internal Server Error

🔴501Not Implemented

🔴503Service Unavailable

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

cURL

Shorter firewall blocksTurn on the firewallWrapped in updates

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

Response Example

200 - Shorter firewall blocks

{
    "status": "updated",
    "updated": {
        "firewall_block_ttl": 86400
    },
    "removed": [],
    "effects": [
        {
            "key": "firewall_block_ttl",
            "value": 86400,
            "effect": "restart"
        }
    ],
    "applied": [],
    "pending": [
        {
            "key": "firewall_block_ttl",
            "running": 604800,
            "file": 86400
        }
    ],
    "restartRequired": true
}

Modified at 2026-10-09 00:59:51

Read configuration

Read configuration key