API documentation

Threat Investigation finding

A leak found for a watched target; secrets masked.

Fields

idstring
Finding id.
targetIdstring
The watched target the finding belongs to.
sourcestring
Finding source (e.g. the host of the leaked login).
breachNamestring | null
Name of a known breach if linked; otherwise `null`.
exposedFieldsarray
Exposed data types (e.g. `username`, `password`).
secretMaskedstring | null
Masked secret; unmasked content opens only in the dashboard.
severitystring
Severity: `critical`, `high`, `medium` or `low`.
seenAtstring
When the leak was seen (ISO 8601).
createdAtstring
When the finding was added (ISO 8601).

JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/hunter-finding.schema.json",
  "title": "Threat Investigation finding",
  "description": "A leak found for a watched target; secrets masked.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Finding id."
    },
    "targetId": {
      "type": "string",
      "description": "The watched target the finding belongs to."
    },
    "source": {
      "type": "string",
      "description": "Finding source (e.g. the host of the leaked login)."
    },
    "breachName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Name of a known breach if linked; otherwise `null`."
    },
    "exposedFields": {
      "type": "array",
      "description": "Exposed data types (e.g. `username`, `password`).",
      "items": {}
    },
    "secretMasked": {
      "type": [
        "string",
        "null"
      ],
      "description": "Masked secret; unmasked content opens only in the dashboard."
    },
    "severity": {
      "type": "string",
      "description": "Severity: `critical`, `high`, `medium` or `low`."
    },
    "seenAt": {
      "type": "string",
      "description": "When the leak was seen (ISO 8601)."
    },
    "createdAt": {
      "type": "string",
      "description": "When the finding was added (ISO 8601)."
    }
  }
}

Was this page helpful?