Read configuration

GET

/ipaware/{hostname}/config

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

OperationId:getConfig

Reads the configuration of the IP rules service on one server: every key's value, the keys the file sets, and which changes are waiting for a restart. Requires Super User or Admin Super User scope.

It also lists the keys a change applies at once (liveKeys) and the keys a change copies to the rest of the cluster (replicableKeys), and in replication.drift, the servers whose values differ from this one.

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

Configuration of the service on this server.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴501Not Implemented

🔴503Service Unavailable

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Configuration

{
    "path": "/etc/netsapiens/netsapiens-ipaware.conf",
    "exists": true,
    "config": {
        "firewall_enable": "yes",
        "firewall_block_ttl": 604800,
        "api_batch_max": 100
    },
    "overrides": {
        "firewall_enable": "yes"
    },
    "warnings": [],
    "pending": [],
    "restartRequired": false,
    "liveKeys": [
        "localscore_block_threshold"
    ],
    "replicableKeys": [
        "firewall_block_ttl",
        "localscore_block_threshold"
    ],
    "replication": {
        "enabled": true,
        "channel": "ipaware_config",
        "digest": "9c1e4f0a",
        "generation": 1788272400000,
        "peers": {},
        "drift": [],
        "needsRestart": [],
        "error": null
    }
}

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

Remove allowed IPs with POST

Update configuration