--- title: Brand Protection --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/brand_protection/methods/submit) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/methods/url_info) 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. Link to this property verification\_status?: string Result of human review for this categorization. Link to this property
Link to this property
model\_results?: Array<ModelResult> List of model results for completed scans. model\_name?: string Name of the model. Link to this property model\_score?: number This is the score that is outputted by the model for this submission. Link to this property
Link to this property
rule\_matches?: Array<RuleMatch> List of signatures that matched against site content found when crawling the URL. banning?: boolean For internal use. Link to this property blocking?: boolean For internal use. Link to this property description?: string Description of the signature that matched. Link to this property name?: string Name of the signature that matched. Link to this property
Link to this property
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. Link to this property scan\_complete?: boolean For internal use. Link to this property status\_code?: number Status code that the crawler received when loading the submitted URL. Link to this property submission\_id?: number ID of the most recent submission. Link to this property
Link to this property screenshot\_download\_signature?: string For internal use. Link to this property screenshot\_path?: string For internal use. Link to this property url?: 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 {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. Link to this property
Link to this property
skipped\_urls?: Array<SkippedURL> URLs that were skipped because the same URL is currently being scanned. url?: string URL that was skipped. Link to this property url\_id?: number ID of the submission of that URL that is currently scanning. Link to this property
Link to this property
submitted\_urls?: Array<SubmittedURL> URLs that were successfully submitted for scanning. url?: string URL that was submitted. Link to this property url\_id?: 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 {skipped\_urls, submitted\_urls } skipped\_urls?: Array<Record<string, unknown>> Link to this property submitted\_urls?: Array<Record<string, 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 = Record [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/typescript/resources/brand_protection/subresources/queries/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/queries/methods/delete) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/queries/methods/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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/matches/methods/get) client.brandProtection.matches.get(MatchGetParams {account\_id, id, include\_dismissed, 3 more } params, RequestOptionsoptions?): [MatchGetResponse]() {matches, total } GET/accounts/{account\_id}/brand-protection/matches ##### [Download matches for string queries by ID](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/matches/methods/download) client.brandProtection.matches.download(MatchDownloadParams {account\_id, id, include\_dismissed, 3 more } params, RequestOptionsoptions?): [MatchDownloadResponse]() {matches, total } GET/accounts/{account\_id}/brand-protection/matches/download ##### ModelsExpand Collapse
MatchGetResponse {matches, total } matches?: Array<Record<string, unknown>> Link to this property total?: 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 {matches, total } matches?: Array<Record<string, unknown>> Link to this property total?: 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/typescript/resources/brand_protection/subresources/logos/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/logos/methods/delete) 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 Link to this property tag?: string Link to this property upload\_path?: 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/typescript/resources/brand_protection/subresources/logo_matches/methods/get) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/logo_matches/methods/download) 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>> Link to this property total?: 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 {matches, total } matches?: Array<Record<string, unknown>> Link to this property total?: 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/typescript/resources/brand_protection/subresources/v2/subresources/queries/methods/get) client.brandProtection.v2.queries.get(QueryGetParams {account\_id, id, page, per\_page } params, RequestOptionsoptions?): [QueryGetResponse]() GET/accounts/{account\_id}/cloudforce-one/v2/brand-protection/domain/queries ##### ModelsExpand Collapse
QueryGetResponse = Array<UnionMember0>| UnionMember1 {created, parameters, query\_id, 3 more } One of the following:
Array<UnionMember0> created: string Link to this property
parameters: Parameters| null
string\_matches: Array<StringMatch> pattern: string maxLength200 minLength1 Link to this property
Link to this property max\_time?: string Link to this property min\_time?: 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
UnionMember1 {created, parameters, query\_id, 3 more } created: string Link to this property
parameters: Parameters| null
string\_matches: Array<StringMatch> pattern: string maxLength200 minLength1 Link to this property
Link to this property max\_time?: string Link to this property min\_time?: 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/typescript/resources/brand_protection/subresources/v2/subresources/matches/methods/get) client.brandProtection.v2.matches.get(MatchGetParams {account\_id, query\_id, domain\_search, 6 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> domain: string Link to this property first\_seen: string Link to this property
public\_scans: PublicScans| null submission\_id: string Link to this property
Link to this property registrar: string| null Link to this property scan\_status: string Link to this property scan\_submission\_id: number| null Link to this property source: string| null Link to this property dismissed?: 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?: Array<MatchDetail> 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| null 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/typescript/resources/brand_protection/subresources/v2/subresources/logos/methods/create) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/v2/subresources/logos/methods/delete) 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](https://developers.cloudflare.com/api/typescript/resources/brand_protection/subresources/v2/subresources/logos/methods/get) 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 Link to this property success: boolean Link to this property query\_id?: 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 {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<LogoGetResponseItem> 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| null Link to this property content\_type?: string MIME type of the image (only present when download=true) Link to this property image\_data?: 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/typescript/resources/brand_protection/subresources/v2/subresources/logo_matches/methods/get) 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 Link to this property domain: string| null Link to this property matched\_at: string| null Link to this property query\_id: number Link to this property registrar: string| null Link to this property similarity\_score: number Link to this property url\_scan\_id: string| null Link to this property content\_type?: string Link to this property image\_data?: 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)>)