Skip to Content
ReferenceAPI referenceCrowdSec

Get the CrowdSec integration status

GET
/api/v1/crowdsec/status

Returns whether the integration is on, whether bans and alerts are available, whether the LAPI answers and whether /ws/crowdsec streams changes. Unlike the other CrowdSec endpoints, it answers while the integration is off, with every field false.

Authorization

cookiesession<token>

Session cookie authentication.

Response Body

Request fulfilled, document follows

application/json
  1. response

Whether the CrowdSec integration is on and what it can do.

enabled*boolean

True when CROWDSEC_LAPI_URL and CROWDSEC_BOUNCER_API_KEY are set.

lapiReachable*boolean

Whether the LAPI answered the last decision stream poll. Before the first poll, or with no poller, GeoMetrikks asks the LAPI during this request.

liveUpdates?boolean

Whether /ws/crowdsec streams decision changes. False when the scheduler is off or the server runs without its database.

Defaultfalse
writeEnabled*boolean

True when CROWDSEC_MACHINE_ID and CROWDSEC_MACHINE_PASSWORD are set too. Banning, unbanning and the alert endpoints need them. This does not test the credentials.

Example Request
curl -X GET 'https://geometrikks.example.com/api/v1/crowdsec/status'
Example Response200
{  "enabled": true,  "lapiReachable": true,  "liveUpdates": false,  "writeEnabled": true}