Skip to content
Cloudflare API
Start here
API Reference

Brand Protection

Create new URL submissions
client.brandProtection.submit(BrandProtectionSubmitParams { account_id } params, RequestOptionsoptions?): BrandProtectionSubmitResponse { skipped_urls, submitted_urls }
POST/accounts/{account_id}/brand-protection/submit
Read submitted URLs by ID
client.brandProtection.urlInfo(BrandProtectionURLInfoParams { account_id } params, RequestOptionsoptions?): SinglePage<BrandProtectionURLInfoResponse>
GET/accounts/{account_id}/brand-protection/url-info
ModelsExpand Collapse
Info { categorizations, model_results, rule_matches, 4 more }
categorizations?: Array<Categorization>

List of categorizations applied to this submission.

category?: string

Name of the category applied.

verification_status?: string

Result of human review for this categorization.

model_results?: Array<ModelResult>

List of model results for completed scans.

model_name?: string

Name of the model.

model_score?: number

This is the score that is outputted by the model for this submission.

rule_matches?: Array<RuleMatch>

List of signatures that matched against site content found when crawling the URL.

banning?: boolean

For internal use.

blocking?: boolean

For internal use.

description?: string

Description of the signature that matched.

name?: string

Name of the signature that matched.

scan_status?: ScanStatus { last_processed, scan_complete, status_code, submission_id }

Status of the most recent scan found.

last_processed?: string

Timestamp of when the submission was processed.

scan_complete?: boolean

For internal use.

status_code?: number

Status code that the crawler received when loading the submitted URL.

submission_id?: number

ID of the most recent submission.

screenshot_download_signature?: string

For internal use.

screenshot_path?: string

For internal use.

url?: string

URL that was submitted.

Submit { excluded_urls, skipped_urls, submitted_urls }
excluded_urls?: Array<ExcludedURL>

URLs that were excluded from scanning because their domain is in our no-scan list.

url?: string

URL that was excluded.

skipped_urls?: Array<SkippedURL>

URLs that were skipped because the same URL is currently being scanned.

url?: string

URL that was skipped.

url_id?: number

ID of the submission of that URL that is currently scanning.

submitted_urls?: Array<SubmittedURL>

URLs that were successfully submitted for scanning.

url?: string

URL that was submitted.

url_id?: number

ID assigned to this URL submission. Used to retrieve scanning results.

BrandProtectionSubmitResponse { skipped_urls, submitted_urls }
skipped_urls?: Array<Record<string, unknown>>
submitted_urls?: Array<Record<string, unknown>>
BrandProtectionURLInfoResponse = Record<string, unknown>

Brand ProtectionQueries

Create new saved string queries
client.brandProtection.queries.create(QueryCreateParams { account_id, id, body_scan, 4 more } params, RequestOptionsoptions?): void
POST/accounts/{account_id}/brand-protection/queries
Delete saved string queries by ID
client.brandProtection.queries.delete(QueryDeleteParams { account_id, id, scan, tag } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/brand-protection/queries
Create new saved string queries in bulk
client.brandProtection.queries.bulk(QueryBulkParams { account_id, queries } params, RequestOptionsoptions?): void
POST/accounts/{account_id}/brand-protection/queries/bulk

Brand ProtectionMatches

Read matches for string queries by ID
client.brandProtection.matches.get(MatchGetParams { account_id, id, include_domain_id, 2 more } params, RequestOptionsoptions?): MatchGetResponse { matches, total }
GET/accounts/{account_id}/brand-protection/matches
Download matches for string queries by ID
client.brandProtection.matches.download(MatchDownloadParams { account_id, id, include_domain_id, 2 more } params, RequestOptionsoptions?): MatchDownloadResponse { matches, total }
GET/accounts/{account_id}/brand-protection/matches/download
ModelsExpand Collapse
MatchGetResponse { matches, total }
matches?: Array<Record<string, unknown>>
total?: number
MatchDownloadResponse { matches, total }
matches?: Array<Record<string, unknown>>
total?: number

Brand ProtectionLogos

Create new saved logo queries from image files
client.brandProtection.logos.create(LogoCreateParams { account_id, match_type, tag, 2 more } params, RequestOptionsoptions?): LogoCreateResponse { id, tag, upload_path }
POST/accounts/{account_id}/brand-protection/logos
Delete saved logo queries by ID
client.brandProtection.logos.delete(stringlogoId, LogoDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/brand-protection/logos/{logo_id}
ModelsExpand Collapse
LogoCreateResponse { id, tag, upload_path }
id?: number
tag?: string
upload_path?: string

Brand ProtectionLogo Matches

Read matches for logo queries by ID
client.brandProtection.logoMatches.get(LogoMatchGetParams { account_id, limit, logo_id, offset } params, RequestOptionsoptions?): LogoMatchGetResponse { matches, total }
GET/accounts/{account_id}/brand-protection/logo-matches
Download matches for logo queries by ID
client.brandProtection.logoMatches.download(LogoMatchDownloadParams { account_id, limit, logo_id, offset } params, RequestOptionsoptions?): LogoMatchDownloadResponse { matches, total }
GET/accounts/{account_id}/brand-protection/logo-matches/download
ModelsExpand Collapse
LogoMatchGetResponse { matches, total }
matches?: Array<Record<string, unknown>>
total?: number
LogoMatchDownloadResponse { matches, total }
matches?: Array<Record<string, unknown>>
total?: number

Brand ProtectionV2

Brand ProtectionV2Queries

Get queries
client.brandProtection.v2.queries.get(QueryGetParams { account_id, id } params, RequestOptionsoptions?): QueryGetResponse { created, parameters, query_id, 3 more }
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries
ModelsExpand Collapse
QueryGetResponse = Array<QueryGetResponseItem>
created: string
parameters: Parameters | null
string_matches: Array<StringMatch>
max_edit_distance: number
maximum1
minimum0
pattern: string
minLength1
max_time?: string
min_time?: string
query_id: number
query_tag: string
scan: boolean
updated: string

Brand ProtectionV2Matches

List saved query matches
client.brandProtection.v2.matches.get(MatchGetParams { account_id, query_id, include_dismissed, 5 more } params, RequestOptionsoptions?): MatchGetResponse { matches, total }
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches
ModelsExpand Collapse
MatchGetResponse { matches, total }
matches: Array<Match>
dismissed: boolean
domain: string
first_seen: string
public_scans: PublicScans | null
submission_id: string
scan_status: string
scan_submission_id: number | null
source: string | null
total: number
minimum0

Brand ProtectionV2Logos

Insert logo query
client.brandProtection.v2.logos.create(LogoCreateParams { account_id, image_data, similarity_threshold, 2 more } params, RequestOptionsoptions?): LogoCreateResponse { message, success, query_id }
POST/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
Delete logo query
client.brandProtection.v2.logos.delete(stringqueryId, LogoDeleteParams { account_id } params, RequestOptionsoptions?): LogoDeleteResponse { message, success }
DELETE/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}
Get logo queries
client.brandProtection.v2.logos.get(LogoGetParams { account_id, id, download } params, RequestOptionsoptions?): LogoGetResponse { id, r2_path, similarity_threshold, 4 more }
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
ModelsExpand Collapse
LogoCreateResponse { message, success, query_id }
message: string
success: boolean
query_id?: number
LogoDeleteResponse { message, success }
message: string
success: boolean
LogoGetResponse = Array<LogoGetResponseItem>
id: number
r2_path: string
similarity_threshold: number
tag: string
uploaded_at: string | null
content_type?: string

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

image_data?: string

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

Brand ProtectionV2Logo Matches

List logo matches
client.brandProtection.v2.logoMatches.get(LogoMatchGetParams { account_id, query_id, download, 4 more } params, RequestOptionsoptions?): LogoMatchGetResponse { matches, total }
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches
ModelsExpand Collapse
LogoMatchGetResponse { matches, total }
matches: Array<Match>
id: number
matched_at: string | null
query_id: number
similarity_score: number
url_scan_id: string | null
content_type?: string
domain?: string | null
image_data?: string
total: number
minimum0