--- title: Brand Protection --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) 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/resources/brand_protection/methods/submit) POST/accounts/{account\_id}/brand-protection/submit ##### [Read submitted URLs by ID](https://developers.cloudflare.com/api/resources/brand_protection/methods/url_info) GET/accounts/{account\_id}/brand-protection/url-info ##### ModelsExpand Collapse
Info object {categorizations, model\_results, rule\_matches, 4 more }
categorizations: optional array of object {category, verification\_status } List of categorizations applied to this submission. category: optional string Name of the category applied. Link to this property verification\_status: optional string Result of human review for this categorization. Link to this property
Link to this property
model\_results: optional array of object {model\_name, model\_score } List of model results for completed scans. model\_name: optional string Name of the model. Link to this property model\_score: optional number This is the score that is outputted by the model for this submission. Link to this property
Link to this property
rule\_matches: optional array of object {banning, blocking, description, name } List of signatures that matched against site content found when crawling the URL. banning: optional boolean For internal use. Link to this property blocking: optional boolean For internal use. Link to this property description: optional string Description of the signature that matched. Link to this property name: optional string Name of the signature that matched. Link to this property
Link to this property
scan\_status: optional object {last\_processed, scan\_complete, status\_code, submission\_id } Status of the most recent scan found. last\_processed: optional string Timestamp of when the submission was processed. Link to this property scan\_complete: optional boolean For internal use. Link to this property status\_code: optional number Status code that the crawler received when loading the submitted URL. Link to this property submission\_id: optional number ID of the most recent submission. Link to this property
Link to this property screenshot\_download\_signature: optional string For internal use. Link to this property screenshot\_path: optional string For internal use. Link to this property url: optional string URL that was submitted. Link to this property
[Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20info%20%3E%20(schema)>)
Submit object {excluded\_urls, skipped\_urls, submitted\_urls }
excluded\_urls: optional array of object {url } URLs that were excluded from scanning because their domain is in our no-scan list. url: optional string URL that was excluded. Link to this property
Link to this property
skipped\_urls: optional array of object {url, url\_id } URLs that were skipped because the same URL is currently being scanned. url: optional string URL that was skipped. Link to this property url\_id: optional number ID of the submission of that URL that is currently scanning. Link to this property
Link to this property
submitted\_urls: optional array of object {url, url\_id } URLs that were successfully submitted for scanning. url: optional string URL that was submitted. Link to this property url\_id: optional number 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)>)
BrandProtectionSubmitResponse object {skipped\_urls, submitted\_urls } skipped\_urls: optional array of map\[unknown] Link to this property submitted\_urls: optional array of map\[unknown] Link to this property
[Link to this property](<#(resource)%20brand_protection%20%3E%20(model)%20brand_protection_submit_response%20%3E%20(schema)>) BrandProtectionURLInfoResponse = map\[unknown] [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/resources/brand_protection/subresources/queries/methods/create) POST/accounts/{account\_id}/brand-protection/queries ##### [Delete saved string queries by ID](https://developers.cloudflare.com/api/resources/brand_protection/subresources/queries/methods/delete) DELETE/accounts/{account\_id}/brand-protection/queries ##### [Create new saved string queries in bulk](https://developers.cloudflare.com/api/resources/brand_protection/subresources/queries/methods/bulk) POST/accounts/{account\_id}/brand-protection/queries/bulk #### Brand ProtectionMatches ##### [Read matches for string queries by ID](https://developers.cloudflare.com/api/resources/brand_protection/subresources/matches/methods/get) GET/accounts/{account\_id}/brand-protection/matches ##### [Download matches for string queries by ID](https://developers.cloudflare.com/api/resources/brand_protection/subresources/matches/methods/download) GET/accounts/{account\_id}/brand-protection/matches/download ##### ModelsExpand Collapse
MatchGetResponse object {matches, total } matches: optional array of map\[unknown] Link to this property total: optional number Link to this property
[Link to this property](<#(resource)%20brand_protection.matches%20%3E%20(model)%20match_get_response%20%3E%20(schema)>)
MatchDownloadResponse object {matches, total } matches: optional array of map\[unknown] Link to this property total: optional number 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/resources/brand_protection/subresources/logos/methods/create) POST/accounts/{account\_id}/brand-protection/logos ##### [Delete saved logo queries by ID](https://developers.cloudflare.com/api/resources/brand_protection/subresources/logos/methods/delete) DELETE/accounts/{account\_id}/brand-protection/logos/{logo\_id} ##### ModelsExpand Collapse
LogoCreateResponse object {id, tag, upload\_path } id: optional number Link to this property tag: optional string Link to this property upload\_path: optional string 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/resources/brand_protection/subresources/logo_matches/methods/get) GET/accounts/{account\_id}/brand-protection/logo-matches ##### [Download matches for logo queries by ID](https://developers.cloudflare.com/api/resources/brand_protection/subresources/logo_matches/methods/download) GET/accounts/{account\_id}/brand-protection/logo-matches/download ##### ModelsExpand Collapse
LogoMatchGetResponse object {matches, total } matches: optional array of map\[unknown] Link to this property total: optional number 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)>)
LogoMatchDownloadResponse object {matches, total } matches: optional array of map\[unknown] Link to this property total: optional number 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/resources/brand_protection/subresources/v2/subresources/queries/methods/get) 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 Link to this property
parameters: object {string\_matches, max\_time, min\_time }
string\_matches: array of object {pattern } pattern: string maxLength200 minLength1 Link to this property
Link to this property max\_time: optional string Link to this property min\_time: optional string Link to this property
Link to this property query\_id: number Link to this property query\_tag: string Link to this property scan: boolean Link to this property updated: string Link to this property
Link to this property
object {created, parameters, query\_id, 3 more } created: string Link to this property
parameters: object {string\_matches, max\_time, min\_time }
string\_matches: array of object {pattern } pattern: string maxLength200 minLength1 Link to this property
Link to this property max\_time: optional string Link to this property min\_time: optional string Link to this property
Link to this property query\_id: number Link to this property query\_tag: string Link to this property scan: boolean Link to this property updated: string 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/resources/brand_protection/subresources/v2/subresources/matches/methods/get) 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, 6 more } domain: string Link to this property first\_seen: string Link to this property
public\_scans: object {submission\_id } submission\_id: string Link to this property
Link to this property registrar: string Link to this property scan\_status: string Link to this property scan\_submission\_id: number Link to this property source: string Link to this property 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. Link to this property
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. Link to this property match\_id: number Link to this property query\_id: number Link to this property query\_tag: string Tag associated with the query, if one exists. Link to this property
Link to this property
Link to this property total: number 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/resources/brand_protection/subresources/v2/subresources/logos/methods/create) POST/accounts/{account\_id}/cloudforce-one/v2/brand-protection/logo/queries ##### [Delete logo query](https://developers.cloudflare.com/api/resources/brand_protection/subresources/v2/subresources/logos/methods/delete) DELETE/accounts/{account\_id}/cloudforce-one/v2/brand-protection/logo/queries/{query\_id} ##### [Get logo queries](https://developers.cloudflare.com/api/resources/brand_protection/subresources/v2/subresources/logos/methods/get) GET/accounts/{account\_id}/cloudforce-one/v2/brand-protection/logo/queries ##### ModelsExpand Collapse
LogoCreateResponse object {message, success, query\_id } message: string Link to this property success: boolean Link to this property query\_id: optional number Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logos%20%3E%20(model)%20logo_create_response%20%3E%20(schema)>)
LogoDeleteResponse object {message, success } message: string Link to this property success: boolean Link to this property
[Link to this property](<#(resource)%20brand_protection.v2.logos%20%3E%20(model)%20logo_delete_response%20%3E%20(schema)>)
LogoGetResponse = array of object {id, r2\_path, similarity\_threshold, 4 more } id: number Link to this property r2\_path: string Link to this property similarity\_threshold: number Link to this property tag: string Link to this property uploaded\_at: string Link to this property content\_type: optional string MIME type of the image (only present when download=true) Link to this property image\_data: optional string 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/resources/brand_protection/subresources/v2/subresources/logo_matches/methods/get) 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 Link to this property domain: string Link to this property matched\_at: string Link to this property query\_id: number Link to this property registrar: string Link to this property similarity\_score: number Link to this property url\_scan\_id: string Link to this property content\_type: optional string Link to this property image\_data: optional string Link to this property
Link to this property total: number 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)>)