--- title: Brand Protection --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Brand Protection ##### [Create new URL submissions](https://developers.cloudflare.com/api/python/resources/brand_protection/methods/submit) brand\_protection.submit(BrandProtectionSubmitParams\*\*kwargs) -> [BrandProtectionSubmitResponse]() POST/accounts/{account\_id}/brand-protection/submit ##### [Read submitted URLs by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/methods/url_info) brand\_protection.url\_info(BrandProtectionURLInfoParams\*\*kwargs) -> SyncSinglePage\[[BrandProtectionURLInfoResponse]()] GET/accounts/{account\_id}/brand-protection/url-info ##### ModelsExpand Collapse
class Info: …
categorizations: Optional\[List\[Categorization]] List of categorizations applied to this submission. category: Optional\[str] Name of the category applied. Link to this property verification\_status: Optional\[str] Result of human review for this categorization. Link to this property
Link to this property
model\_results: Optional\[List\[ModelResult]] List of model results for completed scans. model\_name: Optional\[str] Name of the model. Link to this property model\_score: Optional\[float] This is the score that is outputted by the model for this submission. Link to this property
Link to this property
rule\_matches: Optional\[List\[RuleMatch]] List of signatures that matched against site content found when crawling the URL. banning: Optional\[bool] For internal use. Link to this property blocking: Optional\[bool] For internal use. Link to this property description: Optional\[str] Description of the signature that matched. Link to this property name: Optional\[str] Name of the signature that matched. Link to this property
Link to this property
scan\_status: Optional\[ScanStatus] Status of the most recent scan found. last\_processed: Optional\[str] Timestamp of when the submission was processed. Link to this property scan\_complete: Optional\[bool] For internal use. Link to this property status\_code: Optional\[int] Status code that the crawler received when loading the submitted URL. Link to this property submission\_id: Optional\[int] ID of the most recent submission. Link to this property
Link to this property screenshot\_download\_signature: Optional\[str] For internal use. Link to this property screenshot\_path: Optional\[str] For internal use. Link to this property url: Optional\[str] URL that was submitted. Link to this property
[Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20info%20%3E%20(schema)>)
class Submit: …
excluded\_urls: Optional\[List\[ExcludedURL]] URLs that were excluded from scanning because their domain is in our no-scan list. url: Optional\[str] URL that was excluded. Link to this property
Link to this property
skipped\_urls: Optional\[List\[SkippedURL]] URLs that were skipped because the same URL is currently being scanned. url: Optional\[str] URL that was skipped. Link to this property url\_id: Optional\[int] ID of the submission of that URL that is currently scanning. Link to this property
Link to this property
submitted\_urls: Optional\[List\[SubmittedURL]] URLs that were successfully submitted for scanning. url: Optional\[str] URL that was submitted. Link to this property url\_id: Optional\[int] ID assigned to this URL submission. Used to retrieve scanning results. Link to this property
Link to this property
[Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20submit%20%3E%20(schema)>)
class BrandProtectionSubmitResponse: … skipped\_urls: Optional\[List\[Dict\[str, object]]] Link to this property submitted\_urls: Optional\[List\[Dict\[str, object]]] Link to this property
[Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20brand_protection_submit_response%20%3E%20(schema)>) Dict\[str, object] [Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20brand_protection_url_info_response%20%3E%20(schema)>) #### Brand ProtectionQueries ##### [Create new saved string queries](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/queries/methods/create) brand\_protection.queries.create(QueryCreateParams\*\*kwargs) POST/accounts/{account\_id}/brand-protection/queries ##### [Delete saved string queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/queries/methods/delete) brand\_protection.queries.delete(QueryDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/brand-protection/queries ##### [Create new saved string queries in bulk](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/queries/methods/bulk) brand\_protection.queries.bulk(QueryBulkParams\*\*kwargs) POST/accounts/{account\_id}/brand-protection/queries/bulk #### Brand ProtectionMatches ##### [Read matches for string queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/matches/methods/get) brand\_protection.matches.get(MatchGetParams\*\*kwargs) -> [MatchGetResponse]() GET/accounts/{account\_id}/brand-protection/matches ##### [Download matches for string queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/matches/methods/download) brand\_protection.matches.download(MatchDownloadParams\*\*kwargs) -> [MatchDownloadResponse]() GET/accounts/{account\_id}/brand-protection/matches/download ##### ModelsExpand Collapse
class MatchGetResponse: … matches: Optional\[List\[Dict\[str, object]]] Link to this property total: Optional\[int] Link to this property
[Link to this property](<#(resource)%20brand_protection.matches%20%3E%20(model)%20match_get_response%20%3E%20(schema)>)
class MatchDownloadResponse: … matches: Optional\[List\[Dict\[str, object]]] Link to this property total: Optional\[int] Link to this property
[Link to this property](<#(resource)%20brand_protection.matches%20%3E%20(model)%20match_download_response%20%3E%20(schema)>) #### Brand ProtectionLogos ##### [Create new saved logo queries from image files](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/logos/methods/create) brand\_protection.logos.create(LogoCreateParams\*\*kwargs) -> [LogoCreateResponse]() POST/accounts/{account\_id}/brand-protection/logos ##### [Delete saved logo queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/logos/methods/delete) brand\_protection.logos.delete(strlogo\_id, LogoDeleteParams\*\*kwargs) DELETE/accounts/{account\_id}/brand-protection/logos/{logo\_id} ##### ModelsExpand Collapse
class LogoCreateResponse: … id: Optional\[int] Link to this property tag: Optional\[str] Link to this property upload\_path: Optional\[str] Link to this property
[Link to this property](<#(resource)%20brand_protection.logos%20%3E%20(model)%20logo_create_response%20%3E%20(schema)>) #### Brand ProtectionLogo Matches ##### [Read matches for logo queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/logo_matches/methods/get) brand\_protection.logo\_matches.get(LogoMatchGetParams\*\*kwargs) -> [LogoMatchGetResponse]() GET/accounts/{account\_id}/brand-protection/logo-matches ##### [Download matches for logo queries by ID](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/logo_matches/methods/download) brand\_protection.logo\_matches.download(LogoMatchDownloadParams\*\*kwargs) -> [LogoMatchDownloadResponse]() GET/accounts/{account\_id}/brand-protection/logo-matches/download ##### ModelsExpand Collapse
class LogoMatchGetResponse: … matches: Optional\[List\[Dict\[str, object]]] Link to this property total: Optional\[int] Link to this property
[Link to this property](<#(resource)%20brand_protection.logo_matches%20%3E%20(model)%20logo_match_get_response%20%3E%20(schema)>)
class LogoMatchDownloadResponse: … matches: Optional\[List\[Dict\[str, object]]] Link to this property total: Optional\[int] Link to this property
[Link to this property](<#(resource)%20brand_protection.logo_matches%20%3E%20(model)%20logo_match_download_response%20%3E%20(schema)>) #### Brand ProtectionV2 #### Brand ProtectionV2Queries ##### [Get queries](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/queries/methods/get) brand\_protection.v2.queries.get(QueryGetParams\*\*kwargs) -> [QueryGetResponse]() GET/accounts/{account\_id}/cloudforce-one/v2/brand-protection/domain/queries ##### ModelsExpand Collapse
QueryGetResponse One of the following:
List\[UnionMember0] created: str Link to this property
parameters: Optional\[UnionMember0Parameters]
string\_matches: List\[UnionMember0ParametersStringMatch] pattern: str maxLength200 minLength1 Link to this property
Link to this property max\_time: Optional\[str] Link to this property min\_time: Optional\[str] Link to this property
Link to this property query\_id: int Link to this property query\_tag: str Link to this property scan: bool Link to this property updated: str Link to this property
Link to this property
class UnionMember1: … created: str Link to this property
parameters: Optional\[UnionMember1Parameters]
string\_matches: List\[UnionMember1ParametersStringMatch] pattern: str maxLength200 minLength1 Link to this property
Link to this property max\_time: Optional\[str] Link to this property min\_time: Optional\[str] Link to this property
Link to this property query\_id: int Link to this property query\_tag: str Link to this property scan: bool Link to this property updated: str Link to this property
Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.queries%20%3E%20(model)%20query_get_response%20%3E%20(schema)>) #### Brand ProtectionV2Matches ##### [List saved query matches](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/matches/methods/get) 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 Link to this property first\_seen: str Link to this property
public\_scans: Optional\[MatchPublicScans] submission\_id: str Link to this property
Link to this property registrar: Optional\[str] Link to this property scan\_status: str Link to this property scan\_submission\_id: Optional\[int] Link to this property source: Optional\[str] Link to this property 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. Link to this property
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. Link to this property match\_id: int Link to this property query\_id: int Link to this property query\_tag: Optional\[str] Tag associated with the query, if one exists. Link to this property
Link to this property
Link to this property total: int minimum0 Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.matches%20%3E%20(model)%20match_get_response%20%3E%20(schema)>) #### Brand ProtectionV2Logos ##### [Insert logo query](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/logos/methods/create) brand\_protection.v2.logos.create(LogoCreateParams\*\*kwargs) -> [LogoCreateResponse]() POST/accounts/{account\_id}/cloudforce-one/v2/brand-protection/logo/queries ##### [Delete logo query](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/logos/methods/delete) 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](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/logos/methods/get) 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 Link to this property success: bool Link to this property query\_id: Optional\[int] Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logos%20%3E%20(model)%20logo_create_response%20%3E%20(schema)>)
class LogoDeleteResponse: … message: str Link to this property success: bool Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logos%20%3E%20(model)%20logo_delete_response%20%3E%20(schema)>)
List\[LogoGetResponseItem] id: int Link to this property r2\_path: str Link to this property similarity\_threshold: float Link to this property tag: str Link to this property uploaded\_at: Optional\[str] Link to this property content\_type: Optional\[str] MIME type of the image (only present when download=true) Link to this property image\_data: Optional\[str] Base64-encoded image data (only present when download=true) Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logos%20%3E%20(model)%20logo_get_response%20%3E%20(schema)>) #### Brand ProtectionV2Logo Matches ##### [List logo matches](https://developers.cloudflare.com/api/python/resources/brand_protection/subresources/v2/subresources/logo_matches/methods/get) 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 Link to this property domain: Optional\[str] Link to this property matched\_at: Optional\[str] Link to this property query\_id: int Link to this property registrar: Optional\[str] Link to this property similarity\_score: float Link to this property url\_scan\_id: Optional\[str] Link to this property content\_type: Optional\[str] Link to this property image\_data: Optional\[str] Link to this property
Link to this property total: int minimum0 Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logo_matches%20%3E%20(model)%20logo_match_get_response%20%3E%20(schema)>)