Cloudflare API | Brand Protection › Get Results For A URL Scan

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/brand-protection/url-info \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "categorizations": [
      {
        "category": "PHISHING",
        "verification_status": "confirmed"
      }
    ],
    "model_results": [
      {
        "model_name": "MACHINE_LEARNING_v2",
        "model_score": 0.024
      }
    ],
    "rule_matches": [
      {
        "banning": true,
        "blocking": true,
        "description": "Match frequently used social followers phishing kit",
        "name": "phishkit.social_followers"
      }
    ],
    "scan_status": {
      "last_processed": "Wed, 26 Oct 2022 16:04:51 GMT",
      "scan_complete": true,
      "status_code": 0,
      "submission_id": 0
    },
    "screenshot_download_signature": "screenshot_download_signature",
    "screenshot_path": "screenshot_path",
    "url": "https://www.cloudflare.com"
  }
}

Domain types

Info = { categorizations, model_results, rule_matches, 4 more... }

RuleMatch = { banning, blocking, description, 1 more... }

ScanStatus = { last_processed, scan_complete, status_code, 1 more... }

Submit = { excluded_urls, skipped_urls, submitted_urls }

URLInfoModelResults = { model_name, model_score }