Read configuration key

GET

/ipaware/{hostname}/config/{key}

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

OperationId:getConfigKey

Reads one configuration key of the IP rules service on one server: the value the file gives it, the value in effect, its default, and how a change to it takes effect. Requires Super User or Admin Super User scope.

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

Responses

🟢200OK

application/json

The key on this server.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🟠429Too Many Requests

🔴501Not Implemented

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/ipaware//config/firewall_block_ttl' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Changed, waiting for restart

{
    "key": "firewall_block_ttl",
    "value": 86400,
    "running": 604800,
    "default": 604800,
    "source": "file",
    "restartRequired": true,
    "applyMode": "process_restart",
    "replicable": true
}

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

Update configuration

Update configuration key