Skip to Content
ReferenceAPI referenceCrowdSec

Unban an IP or range through CrowdSec

POST
/api/v1/crowdsec/unban

Deletes every active decision on exactly that IP or range, from any origin, and returns how many it deleted. An IP keeps a Range decision that covers it, so unban the range for that. Answers 403 when the server has no CrowdSec machine credentials, CROWDSEC_MACHINE_ID and CROWDSEC_MACHINE_PASSWORD. Needs a Read/write API key or a browser session.

Authorization

cookiesession<token>

Session cookie authentication.

Request Body

application/json
  1. body

What to unban.

ip*string

An IP, or a range in CIDR form such as 203.0.113.0/24.

Response Body

Request fulfilled, document follows

application/json
  1. response

How many decisions the unban deleted.

deleted*integer
Example Request
curl -X POST 'https://geometrikks.example.com/api/v1/crowdsec/unban' \  -H 'Content-Type: application/json' \  -d '{  "ip": "string"}'
Example Response
{  "deleted": 0}

Get the CrowdSec integration status GET

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.

List the Spamhaus DROP networks and ASNs GET

Returns every network and ASN on the Spamhaus DROP lists, with the download state of each feed. The scheduler downloads the lists every DROP_REFRESH_HOURS hours, 24 by default. With DROP_ENABLED=false the lists are empty and `enabled` is false. The answer carries `Cache-Control: private, max-age=300`.