Read service status

GET

/ipaware/{hostname}/statusz

Last modified:2026-10-09 01:00:19

OperationId:getStatus

Reads the runtime status of the IP rules service on one server: version, uptime, request and decision counters, and the status of each part of the service, such as the firewall, the allow list, and the core scanner. Requires Super User or Admin Super User scope. Use it for monitoring and troubleshooting. The objects inside change between releases.

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

Status of the service on this server.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🟠404Not Found

🔴503Service Unavailable

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Status

{
    "service": "netsapiens-ipaware",
    "version": "46.0.3",
    "uptimeSec": 86400,
    "passthrough": "no",
    "failMode": "open",
    "requests": 125000,
    "decisions": {
        "allow": 124800,
        "deny": 200
    },
    "cache": {
        "size": 5120,
        "hits": 98000,
        "misses": 27000
    },
    "cloud": null,
    "firewall": {
        "enabled": true,
        "manualEnabled": true,
        "active": true,
        "ready": true
    },
    "allow": {
        "dbEnabled": true,
        "dbEntries": 2
    },
    "apiAuth": {
        "ok": 310,
        "badKey": 0
    },
    "coreScan": {
        "enabled": true
    },
    "ajpPool": {
        "size": 4,
        "idle": 3
    },
    "memoryRssBytes": 104857600
}

Modified at 2026-10-09 01:00:19

Check service health

Read core scanner status