API documentation

Protection resource

An asset you protect (domain, IP, email, …).

Fields

_idstring
Record id (24 hex characters).
firmstring
Id of the firm the record belongs to — always your API key’s firm.
groupIdstring
Id of the group the resource belongs to.
resourceTypestring
Type: `domain`, `ip`, `hwid`, `email`, `username`, `application`.
targetValuestring
The protected value (lower-cased).
descriptionstring | null
Description (optional).
isActiveboolean
Whether monitoring is active.
authorizationBlockedboolean
Whether new matches are blocked by the authorization scope.
thirdPartyIncludeboolean
Whether third-party leaks are included.
matchModestring
Match mode: `machine` or `credential`.
isVerifiedboolean
Whether ownership is verified.
verificationMethodstring
Verification method (e.g. `dns`, `file`, `manual`).
verificationStatusstring
Verification status.
verifiedAtstring
When it was verified.
reviewStatusstring | null
Manual review status (if required).
createdAtstring
Creation time (ISO 8601).
updatedAtstring
Last update time (ISO 8601).
metadataobject · optional
Free-form metadata (omitted when empty).

JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/protection-resource.schema.json",
  "title": "Protection resource",
  "description": "An asset you protect (domain, IP, email, …).",
  "type": "object",
  "properties": {
    "_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."
    },
    "groupId": {
      "type": "string",
      "description": "Id of the group the resource belongs to."
    },
    "resourceType": {
      "type": "string",
      "description": "Type: `domain`, `ip`, `hwid`, `email`, `username`, `application`."
    },
    "targetValue": {
      "type": "string",
      "description": "The protected value (lower-cased)."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Description (optional)."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether monitoring is active."
    },
    "authorizationBlocked": {
      "type": "boolean",
      "description": "Whether new matches are blocked by the authorization scope."
    },
    "thirdPartyInclude": {
      "type": "boolean",
      "description": "Whether third-party leaks are included."
    },
    "matchMode": {
      "type": "string",
      "description": "Match mode: `machine` or `credential`."
    },
    "isVerified": {
      "type": "boolean",
      "description": "Whether ownership is verified."
    },
    "verificationMethod": {
      "type": "string",
      "description": "Verification method (e.g. `dns`, `file`, `manual`)."
    },
    "verificationStatus": {
      "type": "string",
      "description": "Verification status."
    },
    "verifiedAt": {
      "type": "string",
      "description": "When it was verified."
    },
    "reviewStatus": {
      "type": [
        "string",
        "null"
      ],
      "description": "Manual review status (if required)."
    },
    "createdAt": {
      "type": "string",
      "description": "Creation time (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Last update time (ISO 8601)."
    },
    "metadata": {
      "type": "object",
      "description": "Free-form metadata (omitted when empty)."
    }
  }
}

Was this page helpful?