API documentation

Scan

A run of your protection resources against leak data.

Fields

Scan result counts.

stats.severitiesobject
Findings by severity.
stats.typesobject
Findings by type.
stats.resourceTypeBreakdownobject
Findings by resource type.
stats.totalItemsCheckednumber
Records checked.
stats.totalResourcesScannednumber
Protection resources scanned.
stats.totalMatchesnumber
Total matches.
stats.newMatchesnumber
Matches seen for the first time in this scan.
stats.credentialsFoundnumber
Credentials found.
stats.machinesFoundnumber
Machines found.

Error summary if the scan failed (message and code only).

error.messagestring | null
Error message.
error.codestring | null
Error code.
_idstring
Record id (24 hex characters).
firmstring
Id of the firm the record belongs to — always your API key’s firm.
protectionResourceGroupIdstring | null
Id of the protection resource group the record belongs to.
scanTypestring
Scan type: `manual`, `scheduled`, `automatic` or `auto`.
statusstring
Scan status: `pending`, `running`, `completed`, `failed`, `cancelled`.
startedAtstring
Start time.
completedAtstring | null
Completion time.
durationMsnumber | null
Duration (milliseconds).
resourceResultsarray
Per-resource scan results.
createdAtstring
Creation time (ISO 8601).
updatedAtstring
Last update time (ISO 8601).

JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/scan.schema.json",
  "title": "Scan",
  "description": "A run of your protection resources against leak data.",
  "type": "object",
  "properties": {
    "stats": {
      "type": "object",
      "description": "Scan result counts.",
      "properties": {
        "severities": {
          "type": "object",
          "description": "Findings by severity."
        },
        "types": {
          "type": "object",
          "description": "Findings by type."
        },
        "resourceTypeBreakdown": {
          "type": "object",
          "description": "Findings by resource type."
        },
        "totalItemsChecked": {
          "type": "number",
          "description": "Records checked."
        },
        "totalResourcesScanned": {
          "type": "number",
          "description": "Protection resources scanned."
        },
        "totalMatches": {
          "type": "number",
          "description": "Total matches."
        },
        "newMatches": {
          "type": "number",
          "description": "Matches seen for the first time in this scan."
        },
        "credentialsFound": {
          "type": "number",
          "description": "Credentials found."
        },
        "machinesFound": {
          "type": "number",
          "description": "Machines found."
        }
      }
    },
    "error": {
      "type": "object",
      "description": "Error summary if the scan failed (message and code only).",
      "properties": {
        "message": {
          "type": [
            "string",
            "null"
          ],
          "description": "Error message."
        },
        "code": {
          "type": [
            "string",
            "null"
          ],
          "description": "Error code."
        }
      }
    },
    "_id": {
      "type": "string",
      "description": "Record id (24 hex characters)."
    },
    "firm": {
      "type": "string",
      "description": "Id of the firm the record belongs to — always your API key’s firm."
    },
    "protectionResourceGroupId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Id of the protection resource group the record belongs to."
    },
    "scanType": {
      "type": "string",
      "description": "Scan type: `manual`, `scheduled`, `automatic` or `auto`."
    },
    "status": {
      "type": "string",
      "description": "Scan status: `pending`, `running`, `completed`, `failed`, `cancelled`."
    },
    "startedAt": {
      "type": "string",
      "description": "Start time."
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "description": "Completion time."
    },
    "durationMs": {
      "type": [
        "number",
        "null"
      ],
      "description": "Duration (milliseconds)."
    },
    "resourceResults": {
      "type": "array",
      "description": "Per-resource scan results.",
      "items": {}
    },
    "createdAt": {
      "type": "string",
      "description": "Creation time (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Last update time (ISO 8601)."
    }
  }
}

Was this page helpful?