Skip to content
Cloudflare API
Start here
API Reference
Brand Protection

V2

V2Queries

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

V2Matches

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

V2Logos

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)

V2Logo 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