Get CrowdSec protection status on a virtual server

Check the CrowdSec protection status on a specific virtual server (VM). Returns information on protected IPs, protection status, and opted-out IPs. Used to troubleshoot or verify server security settings.

Path Parameters

vmid integer · min: 1 required Example

Unique vmid identifier

Headers

Accept Example

Content-Type Example

Responses

200

success boolean

timestamp string

requestId string

data object

400

error string

message string

code string

timestamp string

requestId string

429

error string

message string

retryAfter string

requestId string

GET https://cloud.hostup.se/api/vm/{vmid}/crowdsec

For AI assistants

cURL

curl -X GET "https://cloud.hostup.se/api/vm/6912/crowdsec" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "timestamp": "string",
  "requestId": "string",
  "data": {
    "ips": [
      "string"
    ],
    "ip_statuses": [
      {
        "ip": "string",
        "is_opted_out": true,
        "opt_out_date": "string"
      }
    ],
    "protection_active": true,
    "total_ips": 0,
    "opted_out_count": 0
  }
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "timestamp": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "ips": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ip_statuses": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "ip": {
                "type": "string"
              },
              "is_opted_out": {
                "type": "boolean"
              },
              "opt_out_date": {
                "type": "string",
                "nullable": true
              }
            }
          }
        },
        "protection_active": {
          "type": "boolean"
        },
        "total_ips": {
          "type": "integer"
        },
        "opted_out_count": {
          "type": "integer"
        }
      }
    }
  }
}