Skip to content
Cloudflare API
Start here
API Reference
Brand Protection

V2

V2Queries

Get queries
brand_protection.v2.queries.get(QueryGetParams**kwargs) -> QueryGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries
ModelsExpand Collapse
List[QueryGetResponseItem]
created: str
parameters: Optional[QueryGetResponseItemParameters]
string_matches: List[QueryGetResponseItemParametersStringMatch]
max_edit_distance: float
maximum1
minimum0
pattern: str
minLength1
max_time: Optional[str]
min_time: Optional[str]
query_id: int
query_tag: str
scan: bool
updated: str

V2Matches

List saved query matches
brand_protection.v2.matches.get(MatchGetParams**kwargs) -> MatchGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches
ModelsExpand Collapse
class MatchGetResponse: …
matches: List[Match]
domain: str
first_seen: str
public_scans: Optional[MatchPublicScans]
submission_id: str
registrar: Optional[str]
scan_status: str
scan_submission_id: Optional[int]
source: Optional[str]
dismissed: Optional[bool]

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

match_details: Optional[List[MatchMatchDetail]]

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

dismissed: bool

Individual dismissed state for this specific match.

match_id: int
query_id: int
query_tag: Optional[str]

Tag associated with the query, if one exists.

total: int
minimum0

V2Logos

Insert logo query
brand_protection.v2.logos.create(LogoCreateParams**kwargs) -> LogoCreateResponse
POST/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
Delete logo query
brand_protection.v2.logos.delete(strquery_id, LogoDeleteParams**kwargs) -> LogoDeleteResponse
DELETE/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}
Get logo queries
brand_protection.v2.logos.get(LogoGetParams**kwargs) -> LogoGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
ModelsExpand Collapse
class LogoCreateResponse: …
message: str
success: bool
query_id: Optional[int]
class LogoDeleteResponse: …
message: str
success: bool
List[LogoGetResponseItem]
id: int
r2_path: str
similarity_threshold: float
tag: str
uploaded_at: Optional[str]
content_type: Optional[str]

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

image_data: Optional[str]

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

V2Logo Matches

List logo matches
brand_protection.v2.logo_matches.get(LogoMatchGetParams**kwargs) -> LogoMatchGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches
ModelsExpand Collapse
class LogoMatchGetResponse: …
matches: List[Match]
id: int
domain: Optional[str]
matched_at: Optional[str]
query_id: int
registrar: Optional[str]
similarity_score: float
url_scan_id: Optional[str]
content_type: Optional[str]
image_data: Optional[str]
total: int
minimum0