Security scans

Get security overview

GET/v1/organization/security/overview

Gets the scanner status and a finding summary for the organization's scanned IP addresses.

curl --request GET \
  --url https://api.serverside.com/v1/organization/security/overview \
  --header 'Authorization: Bearer <api-key>'

{
  "success": true,
  "data": {
    "status": {
      "status": "UNKNOWN",
      "lastScan": "2026-01-15T09:30:00Z",
      "nextScan": "2026-01-15T09:30:00Z",
      "isScanRunning": true,
      "intervalSeconds": 123
    },
    "metadata": {
      "scanStarted": "2026-01-15T09:30:00Z",
      "scanFinished": "2026-01-15T09:30:00Z",
      "durationSeconds": 123
    },
    "summary": {
      "targetsWithFindings": 123,
      "totalFindings": 123,
      "openPorts": 123,
      "vulnerable": 123,
      "severityCounts": {
        "critical": 123,
        "high": 123,
        "medium": 123,
        "low": 123,
        "info": 123,
        "unknown": 123
      }
    },
    "targetCount": 123
  }
}

Autorisations

Authorizationstringheaderobligatoire
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Permission requise : organization.networking.read

Réponse

200 · application/json

OK

successbooleanobligatoire
Valeurs autorisées :true
dataobject | nullobligatoire