Cloudflare API | Brand Protection › Submit Suspicious URL For Scanning

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/brand-protection/submit \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
      "url": "https://www.cloudflare.com"
    }'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "excluded_urls": [
      {
        "url": "https://developers.cloudflare.com"
      }
    ],
    "skipped_urls": [
      {
        "url": "https://www.cloudflare.com/developer-week/",
        "url_id": 2
      }
    ],
    "submitted_urls": [
      {
        "url": "https://www.cloudflare.com",
        "url_id": 1
      }
    ]
  }
}

Get Results For A URL Scan -> Envelope<

Info

get/accounts/{account_id}/brand-protection/url-info

Gets phishing details about a URL.

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... }

Status of the most recent scan found.

Submit = { excluded_urls, skipped_urls, submitted_urls }

URLInfoModelResults = { model_name, model_score }