Skip to Content
ReferenceAPI referenceAbuseIPDB

Show whether AbuseIPDB checks and reports are available

GET
/api/v1/abuseipdb/status

Says whether ABUSEIPDB_API_KEY is set, which enables checks, whether ABUSEIPDB_REPORTING_ENABLED=true, which enables reports, and whether ABUSEIPDB_BLACKLIST_ENABLED=true, which enables the blacklist. The quotas come from AbuseIPDB's latest answer to each kind of request since startup and are null before the first one. Nothing leaves the server.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Whether checks and reports are available, and the quota left for each.

blacklistEnabled*boolean

True when ABUSEIPDB_BLACKLIST_ENABLED=true, so the blacklist is downloaded, or read from ABUSEIPDB_BLACKLIST_FILE, and marked.

checks*|

The check quota from AbuseIPDB's latest answer. Null until a check since startup.

enabled*boolean

True when ABUSEIPDB_API_KEY is set, so checks work.

reportingEnabled*boolean

True when ABUSEIPDB_REPORTING_ENABLED=true, so reports can be sent.

reports*|

The report quota from AbuseIPDB's latest answer. Null until a report since startup.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/abuseipdb/status'
Example Response200
{  "blacklistEnabled": true,  "checks": {    "limit": 0,    "remaining": 0,    "resetsAt": "2019-08-24T14:15:22Z"  },  "enabled": true,  "reportingEnabled": true,  "reports": {    "limit": 0,    "remaining": 0,    "resetsAt": "2019-08-24T14:15:22Z"  }}