Skip to content
Cloudflare API
Start here
API Reference

Brand Protection

Create new URL submissions
POST/accounts/{account_id}/brand-protection/submit
Read submitted URLs by ID
GET/accounts/{account_id}/brand-protection/url-info
ModelsExpand Collapse
BrandProtectionSubmitResponse object { skipped_urls, submitted_urls }
skipped_urls: optional array of map[unknown]
submitted_urls: optional array of map[unknown]
BrandProtectionURLInfoResponse = map[unknown]

Brand ProtectionQueries

Create new saved string queries
POST/accounts/{account_id}/brand-protection/queries
Delete saved string queries by ID
DELETE/accounts/{account_id}/brand-protection/queries
Create new saved string queries in bulk
POST/accounts/{account_id}/brand-protection/queries/bulk

Brand ProtectionMatches

Read matches for string queries by ID
GET/accounts/{account_id}/brand-protection/matches
Download matches for string queries by ID
GET/accounts/{account_id}/brand-protection/matches/download
ModelsExpand Collapse
MatchGetResponse object { matches, total }
matches: optional array of map[unknown]
total: optional number
MatchDownloadResponse object { matches, total }
matches: optional array of map[unknown]
total: optional number

Brand ProtectionLogos

Create new saved logo queries from image files
POST/accounts/{account_id}/brand-protection/logos
Delete saved logo queries by ID
DELETE/accounts/{account_id}/brand-protection/logos/{logo_id}
ModelsExpand Collapse
LogoCreateResponse object { id, tag, upload_path }
id: optional number
tag: optional string
upload_path: optional string

Brand ProtectionLogo Matches

Read matches for logo queries by ID
GET/accounts/{account_id}/brand-protection/logo-matches
Download matches for logo queries by ID
GET/accounts/{account_id}/brand-protection/logo-matches/download
ModelsExpand Collapse
LogoMatchGetResponse object { matches, total }
matches: optional array of map[unknown]
total: optional number
LogoMatchDownloadResponse object { matches, total }
matches: optional array of map[unknown]
total: optional number

Brand ProtectionV2

Brand ProtectionV2Queries

List domain queries
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries
ModelsExpand Collapse
QueryGetResponse = array of object { created, parameters, query_id, 3 more } or object { created, parameters, query_id, 3 more }
One of the following:
array of object { created, parameters, query_id, 3 more }
created: string
parameters: object { string_matches, max_time, min_time }
string_matches: array of object { pattern }
pattern: string
maxLength200
minLength1
max_time: optional string
min_time: optional string
query_id: number
query_tag: string
scan: boolean
updated: string
object { created, parameters, query_id, 3 more }
created: string
parameters: object { string_matches, max_time, min_time }
string_matches: array of object { pattern }
pattern: string
maxLength200
minLength1
max_time: optional string
min_time: optional string
query_id: number
query_tag: string
scan: boolean
updated: string

Brand ProtectionV2Matches

List domain matches
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches
ModelsExpand Collapse
MatchGetResponse object { matches, total }
matches: array of object { domain, first_seen, public_scans, 7 more }
domain: string

The matched domain name.

first_seen: string

When the domain was matched. For multi-query requests, the most recent match time across the requested queries.

public_scans: object { submission_id }
submission_id: string
registrar: string

Registrar of the matched domain, if known.

scan_status: string
scan_submission_id: number
source: string
dismissed: optional boolean

Whether the match is dismissed. Only present for single-query requests. For multi-query requests, use the dismissed field in each match_details entry.

domain_id: optional number

ID of the matched domain. Present only when include_domain_id=true. Use it with query_id to dismiss or undismiss the match.

match_details: optional array of object { dismissed, match_id, query_id, query_tag }

Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested.

dismissed: boolean

Individual dismissed state for this specific match.

match_id: number

ID of the match. Accepted by the legacy match_ids format.

query_id: number

ID of the domain query that produced this match.

query_tag: string

Tag associated with the query, if one exists.

total: number

Number of matching domains available for pagination. For requests with several query_id values, matches are deduplicated from at most 5,000 query-domain rows, so total can be lower than the actual number of matches.

minimum0

Brand ProtectionV2Logos

Create logo query
POST/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
Delete logo query
DELETE/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}
List logo queries
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
ModelsExpand Collapse
LogoCreateResponse object { message, success, query_id }
message: string
success: boolean
query_id: optional number

ID of the created logo query.

LogoDeleteResponse object { message, success }
message: string
success: boolean
LogoGetResponse = array of object { id, r2_path, similarity_threshold, 4 more }
id: number

ID of the logo query.

r2_path: string
similarity_threshold: number

Minimum similarity score (0-1) required for a visual match.

tag: string

Name of the logo query.

uploaded_at: string

When the logo was uploaded.

content_type: optional string

MIME type of the image (only present when download=true)

image_data: optional string

Base64-encoded image data (only present when download=true)

Brand ProtectionV2Logo Matches

List logo matches
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches
ModelsExpand Collapse
LogoMatchGetResponse object { matches, total }
matches: array of object { id, domain, matched_at, 6 more }
id: number

ID of the logo match.

domain: string

Domain where the matching image was found, if known.

matched_at: string

When the match was recorded.

query_id: number

ID of the logo query that produced this match.

registrar: string

Registrar of domain, if known.

similarity_score: number

Visual similarity between the matched image and the query logo. Higher is closer.

url_scan_id: string
content_type: optional string

MIME type of the matched image (only present when download=true)

image_data: optional string

Base64-encoded matched image (only present when download=true)

total: number
minimum0