openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Brand Protection API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Brand Protection paths: /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches: get: operationId: get_DomainMatchList summary: List saved query matches description: Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: offset in: query schema: type: string default: '0' - name: limit in: query schema: type: string default: '50' - name: query_id in: query required: true schema: description: Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and dismissed state. type: array items: type: string - name: include_domain_id in: query schema: type: string default: 'false' - name: include_dismissed in: query schema: type: string - name: domain_search in: query schema: description: Filter matches by domain name (substring match) type: string - name: orderBy in: query schema: description: 'Column to sort by. Options: ''domain'', ''first_seen'', or ''registrar''' type: string enum: - domain - first_seen - registrar - name: order in: query schema: description: 'Sort order. Options: ''asc'' (ascending) or ''desc'' (descending)' type: string enum: - asc - desc responses: '200': description: Successfully retrieved query matches content: application/json: schema: type: object properties: matches: type: array items: properties: dismissed: description: Whether the match is dismissed. Only present for single-query requests. For multi-query requests, use the dismissed field in each match_details entry. type: boolean domain: type: string first_seen: type: string match_details: description: Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested. type: array items: properties: dismissed: description: Individual dismissed state for this specific match. type: boolean match_id: type: integer query_id: type: integer query_tag: description: Tag associated with the query, if one exists. type: - string - 'null' required: - query_id - query_tag - match_id - dismissed type: object public_scans: type: - object - 'null' properties: submission_id: type: string required: - submission_id registrar: type: - string - 'null' scan_status: type: string scan_submission_id: type: - integer - 'null' source: type: - string - 'null' required: - domain - first_seen - public_scans - scan_status - scan_submission_id - source - registrar type: object total: type: integer minimum: 0 required: - matches - total 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.matches x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches/bulk-dismiss: post: operationId: post_BulkDismissMatches summary: Bulk dismiss or undismiss matches description: 'Dismiss or undismiss multiple matches in a single request. Accepts either the new format (matches: [{query_id, domain_id}]) for per-query control, or the legacy format (match_ids: [number]) which dismisses for all queries sharing each match''s hash. Returns per-item success/error results.' parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: action: type: string enum: - dismiss - undismiss match_ids: type: array items: type: integer exclusiveMinimum: 0 maxItems: 100 minItems: 1 matches: type: array items: properties: domain_id: type: integer exclusiveMinimum: 0 query_id: type: integer exclusiveMinimum: 0 required: - query_id - domain_id type: object maxItems: 100 minItems: 1 required: - action responses: '200': description: Bulk dismiss/undismiss results content: application/json: schema: anyOf: - properties: result: type: object properties: results: type: array items: properties: domain_id: type: integer error: type: string query_id: type: integer success: type: boolean required: - query_id - domain_id - success type: object required: - results success: type: boolean required: - success - result type: object - properties: result: type: object properties: results: type: array items: properties: error: type: string match_id: type: integer success: type: boolean required: - match_id - success type: object required: - results success: type: boolean required: - success - result type: object 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.matches x-fern-sdk-method-name: bulk-dismiss x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries: get: operationId: get_GetDomainQueries summary: Get queries description: Get all saved brand protection queries for an account parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: id in: query schema: type: string - name: page in: query schema: description: Optional page number for paginated list requests. Defaults to 1 when only per_page is supplied. Omit page and per_page to preserve the legacy full-list response. type: integer maximum: 1000000 exclusiveMinimum: 0 - name: per_page in: query schema: description: Optional number of queries per page for paginated list requests. Defaults to 100 when only page is supplied. Maximum 100. Omit page and per_page to preserve the legacy full-list response. type: integer maximum: 100 exclusiveMinimum: 0 responses: '200': description: Successfully retrieved queries content: application/json: schema: type: object properties: errors: type: array items: properties: code: anyOf: - type: string - type: number message: type: string required: - message type: object messages: type: array items: properties: code: anyOf: - type: string - type: number message: type: string required: - message type: object result: anyOf: - items: properties: created: type: string parameters: required: - string_matches properties: max_time: type: string min_time: type: string string_matches: type: array items: properties: pattern: type: string maxLength: 200 minLength: 1 required: - pattern type: object type: - object - 'null' query_id: type: integer query_tag: type: string scan: type: boolean updated: type: string required: - query_id - query_tag - scan - parameters - created - updated type: object type: array - properties: created: type: string parameters: required: - string_matches properties: max_time: type: string min_time: type: string string_matches: type: array items: properties: pattern: type: string maxLength: 200 minLength: 1 required: - pattern type: object type: - object - 'null' query_id: type: integer query_tag: type: string scan: type: boolean updated: type: string required: - query_id - query_tag - scan - parameters - created - updated type: object result_info: description: Present on paginated list responses when page or per_page is supplied. type: object properties: count: type: integer minimum: 0 page: type: integer exclusiveMinimum: 0 per_page: type: integer exclusiveMinimum: 0 total_count: type: integer minimum: 0 required: - count - page - per_page - total_count success: type: boolean required: - success - result - errors - messages 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.queries x-fern-sdk-method-name: get x-forge-hidden: true post: operationId: post_InsertDomainQuery summary: Insert query description: Create a new saved brand protection query with string match patterns parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: max_time: type: string min_time: type: string scan: type: boolean scan_matches: type: boolean search_lookback: description: If true, search recent domain lookback entries for matches type: boolean default: true string_matches: type: array items: properties: pattern: type: string maxLength: 200 minLength: 1 required: - pattern type: object maxItems: 100 minItems: 1 tag: type: string minLength: 1 required: - tag - string_matches responses: '200': description: Query inserted successfully content: application/json: schema: type: object properties: message: type: string query_id: type: integer success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.domain-queries x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries/{query_id}: delete: operationId: delete_DeleteDomainQuery summary: Delete domain query description: Delete a saved brand protection domain query from the account_queries table. This operation will remove the query from the durable object database. Returns 404 if the query ID doesn't exist. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: query_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Domain query deleted successfully content: application/json: schema: type: object properties: message: type: string success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.domain-queries x-fern-sdk-method-name: delete x-forge-hidden: true patch: operationId: patch_UpdateDomainQuery summary: Update domain query description: Update a saved brand protection domain query with string match patterns parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: query_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: max_time: type: string min_time: type: string scan: type: boolean scan_matches: type: boolean search_lookback: description: If true, search recent domain lookback entries for matches type: boolean default: true string_matches: type: array items: properties: pattern: type: string maxLength: 200 minLength: 1 required: - pattern type: object maxItems: 100 minItems: 1 tag: type: string minLength: 1 required: - tag - string_matches responses: '200': description: Domain query updated successfully content: application/json: schema: type: object properties: message: type: string query_id: type: integer success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.domain-queries x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/trial: post: operationId: post_DomainTrial summary: Analyze domains for brand impersonation description: Uses AI to scan all domains in the lookback table and identify potential phishing or impersonation attempts against the given brand string. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: brand: type: string maxLength: 200 minLength: 1 pattern: ^[\w\s.-]+$ required: - brand responses: '200': description: Domain analysis results content: application/json: schema: type: object properties: matches: type: array items: properties: confidence: type: number maximum: 1 minimum: 0 domain: type: string domain_id: type: integer minimum: 0 first_seen: type: string format: date-time reason: type: string maxLength: 500 required: - domain - domain_id - first_seen - confidence - reason type: object total_analyzed: type: number total_matches: type: number truncated: type: boolean required: - matches - total_analyzed - total_matches - truncated '403': description: Brand is not a zone belonging to this account '502': description: Zone ownership check failed (upstream error) '503': description: Zone ownership check is not configured security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.trial x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/generate: post: operationId: post_LetterGenerate summary: Generate takedown letter description: Generate a takedown letter from a template. Returns V4 JSON for text format or a PDF binary for pdf format. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: createNotice: type: boolean default: false fields: type: object properties: discoveryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ domain: type: string maxLength: 500 generationDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ jurisdiction: type: string maxLength: 500 registrantEmail: type: string maxLength: 500 registrar: type: string maxLength: 500 registrarEmail: type: string maxLength: 500 resolutionByDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ senderCompany: type: string maxLength: 500 senderEmail: type: string maxLength: 500 senderName: type: string maxLength: 500 senderTitle: type: string maxLength: 500 trademarkName: type: string maxLength: 500 trademarkNumber: type: string maxLength: 500 trademarkOwner: type: string maxLength: 500 format: type: string default: text enum: - text - pdf noticeParams: type: object properties: domain: type: string maxLength: 253 minLength: 1 queryId: type: integer exclusiveMinimum: 0 status: type: string default: sent enum: - draft - sent - resolved - expired required: - domain templateId: type: string minLength: 1 required: - templateId - fields responses: '200': description: 'Letter generated successfully. When format=text, returns V4 JSON with { result: { letter: string } }. When format=pdf, returns binary with Content-Type: application/pdf.' content: application/json: schema: type: object properties: letter: type: string letterId: type: integer exclusiveMinimum: 0 notice: type: object properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt required: - letter application/pdf: schema: type: string format: binary 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: generate x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates: get: operationId: get_LetterTemplateList summary: List letter templates description: List user-defined takedown letter templates. System example templates are available via the /templates/examples endpoint. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Templates listed successfully content: application/json: schema: type: object properties: templates: type: array items: properties: category: type: string createdAt: type: - string - 'null' description: type: - string - 'null' id: type: string name: type: string source: type: string enum: - system - user updatedAt: type: - string - 'null' required: - id - source - name - category - description - createdAt - updatedAt type: object required: - templates 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: post_LetterTemplateCreate summary: Create letter template description: Create a new user-defined takedown letter template parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: body: type: string minLength: 1 category: type: string maxLength: 100 minLength: 1 description: type: string maxLength: 1000 name: type: string maxLength: 255 minLength: 1 required: - name - category - body responses: '200': description: Template created successfully content: application/json: schema: type: object properties: body: type: string category: type: string createdAt: type: - string - 'null' description: type: - string - 'null' id: type: string name: type: string source: type: string enum: - system - user updatedAt: type: - string - 'null' required: - id - source - name - category - description - body - createdAt - updatedAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/examples: get: operationId: get_LetterTemplateExamples summary: List example letter templates description: List system-provided example templates that can be used as starting points when creating custom templates. These templates cannot be used directly for letter generation. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Example templates listed successfully content: application/json: schema: type: object properties: templates: type: array items: properties: body: type: string category: type: string createdAt: type: - string - 'null' description: type: - string - 'null' id: type: string name: type: string source: type: string enum: - system - user updatedAt: type: - string - 'null' required: - id - source - name - category - description - body - createdAt - updatedAt type: object required: - templates 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: examples x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/templates/{template_id}: delete: operationId: delete_LetterTemplateDelete summary: Delete letter template description: Delete a user-defined takedown letter template. System templates cannot be deleted. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: template_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Template deleted successfully content: application/json: schema: type: object properties: message: type: string success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: get_LetterTemplateGet summary: Get letter template description: Get a specific user-defined takedown letter template by ID. System example templates are available via the /templates/examples endpoint. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: template_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Template retrieved successfully content: application/json: schema: type: object properties: body: type: string category: type: string createdAt: type: - string - 'null' description: type: - string - 'null' id: type: string name: type: string source: type: string enum: - system - user updatedAt: type: - string - 'null' required: - id - source - name - category - description - body - createdAt - updatedAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: get x-forge-hidden: true put: operationId: put_LetterTemplateUpdate summary: Update letter template description: Update a user-defined takedown letter template. System templates cannot be modified. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: template_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: body: type: string minLength: 1 category: type: string maxLength: 100 minLength: 1 description: type: - string - 'null' maxLength: 1000 name: type: string maxLength: 255 minLength: 1 responses: '200': description: Template updated successfully content: application/json: schema: type: object properties: body: type: string category: type: string createdAt: type: - string - 'null' description: type: - string - 'null' id: type: string name: type: string source: type: string enum: - system - user updatedAt: type: - string - 'null' required: - id - source - name - category - description - body - createdAt - updatedAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.letter-templates x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches: get: operationId: get_LogoMatchList summary: List logo matches description: Get paginated list of logo matches for a specific brand protection logo query parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: offset in: query schema: type: string default: '0' - name: limit in: query schema: type: string default: '50' - name: query_id in: query required: true schema: type: string minLength: 1 - name: download in: query schema: type: string - name: orderBy in: query schema: description: 'Column to sort by. Options: ''matchedAt'', ''domain'', ''similarityScore'', or ''registrar''' type: string enum: - matchedAt - domain - similarityScore - registrar - name: order in: query schema: description: 'Sort order. Options: ''asc'' (ascending) or ''desc'' (descending)' type: string enum: - asc - desc responses: '200': description: Successfully retrieved logo matches content: application/json: schema: type: object properties: matches: type: array items: properties: content_type: type: string domain: type: - string - 'null' id: type: integer image_data: type: string matched_at: type: - string - 'null' query_id: type: integer registrar: type: - string - 'null' similarity_score: type: number url_scan_id: type: - string - 'null' required: - id - query_id - url_scan_id - similarity_score - matched_at - domain - registrar type: object total: type: integer minimum: 0 required: - matches - total 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.logo-matches x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries: get: operationId: get_GetLogoQueries summary: Get logo queries description: Get all saved brand protection logo queries for an account. Optionally specify id to get a single query. Set download=true to include base64-encoded image data. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: id in: query description: Optional query ID to retrieve a specific logo query schema: description: Optional query ID to retrieve a specific logo query type: string - name: download in: query description: If true, include base64-encoded image data in the response schema: description: If true, include base64-encoded image data in the response type: string responses: '200': description: Successfully retrieved logo queries content: application/json: schema: type: array items: properties: content_type: description: MIME type of the image (only present when download=true) type: string id: type: integer image_data: description: Base64-encoded image data (only present when download=true) type: string r2_path: type: string similarity_threshold: type: number tag: type: string uploaded_at: type: - string - 'null' required: - id - tag - r2_path - similarity_threshold - uploaded_at type: object 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.logos x-fern-sdk-method-name: get x-forge-hidden: true post: operationId: post_InsertLogoQuery summary: Insert logo query description: Create a new saved brand protection logo query for visual similarity matching parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: image_data: description: Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string. type: string minLength: 1 search_lookback: description: If true, search historic scanned images for matches above the similarity threshold type: boolean default: true similarity_threshold: description: Minimum similarity score (0-1) required for visual matches type: number maximum: 1 minimum: 0 tag: description: Unique identifier for the logo query type: string minLength: 1 required: - tag - image_data - similarity_threshold responses: '200': description: Logo query inserted successfully content: application/json: schema: type: object properties: message: type: string query_id: type: integer success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.logos x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}: delete: operationId: delete_DeleteLogoQuery summary: Delete logo query description: Delete a saved brand protection logo query. Returns 404 if the query ID doesn't exist. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: query_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Logo query deleted successfully content: application/json: schema: type: object properties: message: type: string success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.logos x-fern-sdk-method-name: delete x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/search: post: operationId: post_SearchLogoSimilarity summary: Search scanned images description: Submit an image and find the n closest matches from the scanned images index without creating any match records. Returns similarity scores and metadata for each match. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: showHistoric in: query description: 'Include scanned images without domain metadata (historic data). Default: false (only show images with domain)' schema: description: 'Include scanned images without domain metadata (historic data). Default: false (only show images with domain)' type: string default: 'false' - name: download in: query description: If true, include base64-encoded image data in the response schema: description: If true, include base64-encoded image data in the response type: string requestBody: content: application/json: schema: type: object properties: image_data: description: Base64 encoded image data. Can include data URI prefix (e.g., 'data:image/png;base64,...') or just the base64 string. type: string minLength: 1 score_threshold: description: 'Minimum similarity score threshold for matches (0-1, default: 0)' type: number default: 0 maximum: 1 minimum: 0 top_k: description: 'Number of closest matches to return (1-100, default: 10)' type: integer default: 10 maximum: 100 minimum: 1 required: - image_data responses: '200': description: Scanned images search completed successfully content: application/json: schema: type: object properties: matches: type: array items: properties: account_id: type: string content_type: description: MIME type of the image (only present when download=true) type: string domain: type: string image_data: description: Base64-encoded image data (only present when download=true) type: string query_id: type: integer r2_path: type: string similarity_score: type: number similarity_threshold: type: number tag: type: string timestamp: type: number url_scan_id: type: string vector_id: type: string required: - similarity_score type: object required: - matches 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection x-fern-sdk-method-name: submit x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/queries/{query_id}/matches/{domain_id}/dismiss: post: operationId: post_DismissMatch summary: Dismiss a match description: Mark a specific domain as dismissed for a given query. Dismissals are per-query — dismissing a domain in one query does not affect other queries. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: query_id in: path required: true schema: type: integer exclusiveMinimum: 0 - name: domain_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Match dismissed successfully content: application/json: schema: type: object properties: result: type: object properties: dismissed: type: boolean domain_id: type: integer query_id: type: integer required: - query_id - domain_id - dismissed success: type: boolean required: - success - result 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.queries x-fern-sdk-method-name: dismiss x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/queries/{query_id}/matches/{domain_id}/undismiss: post: operationId: post_UndismissMatch summary: Undismiss a match description: Remove the dismissed status from a specific domain for a given query. Undismissals are per-query — undismissing a domain in one query does not affect other queries. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: query_id in: path required: true schema: type: integer exclusiveMinimum: 0 - name: domain_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Match undismissed successfully content: application/json: schema: type: object properties: result: type: object properties: dismissed: type: boolean domain_id: type: integer query_id: type: integer required: - query_id - domain_id - dismissed success: type: boolean required: - success - result 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection.queries x-fern-sdk-method-name: undismiss x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices: get: operationId: get_TakedownNoticeList summary: List takedown notices description: List all takedown notices for the account. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Takedown notices listed successfully content: application/json: schema: type: object properties: notices: type: array items: properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt type: object required: - notices 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: post_TakedownNoticeCreate summary: Create takedown notice description: Create a new takedown notice for a domain suspected of trademark infringement. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: domain: type: string maxLength: 253 minLength: 1 matchId: type: integer exclusiveMinimum: 0 matchType: type: string enum: - logo - domain queryId: type: integer exclusiveMinimum: 0 status: type: string default: draft enum: - draft - sent - resolved - expired required: - domain responses: '200': description: Takedown notice created successfully content: application/json: schema: type: object properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt '409': description: A takedown notice already exists for this domain security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/lookup: post: operationId: post_TakedownNoticeLookup summary: Lookup takedown notices by domains description: Bulk lookup of takedown notices by domain names. Returns an array of { domain, queryId, notice } entries (notice is null when no match exists). Supports optional queryId or queryIds to scope lookups per query. Uses POST to avoid URL length limits when looking up many domains. This endpoint is read-only. Domains are normalized (trimmed, lowercased) and deduplicated. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 requestBody: content: application/json: schema: type: object properties: domains: type: array items: maxLength: 253 minLength: 1 type: string maxItems: 100 minItems: 1 queryId: type: integer exclusiveMinimum: 0 queryIds: type: array items: type: integer exclusiveMinimum: 0 maxItems: 100 required: - domains responses: '200': description: Takedown notice lookup results content: application/json: schema: type: object properties: notices: type: array items: properties: domain: type: string notice: type: - object - 'null' properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt queryId: type: - number - 'null' required: - domain - queryId - notice type: object required: - notices 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: lookup x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}: delete: operationId: delete_TakedownNoticeDelete summary: Delete takedown notice description: Delete a takedown notice and all associated letters. PDFs are also removed from storage. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown notice deleted successfully content: application/json: schema: type: object properties: message: type: string success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: get_TakedownNoticeGet summary: Get takedown notice description: Get a specific takedown notice by ID. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown notice retrieved successfully content: application/json: schema: type: object properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: get x-forge-hidden: true put: operationId: put_TakedownNoticeUpdate summary: Update takedown notice description: Update a takedown notice (e.g. change status to sent, resolved, etc.). parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 requestBody: content: application/json: schema: type: object properties: domain: type: string maxLength: 253 minLength: 1 matchId: type: - integer - 'null' exclusiveMinimum: 0 matchType: type: - string - 'null' enum: - logo - domain queryId: type: - integer - 'null' exclusiveMinimum: 0 status: type: string enum: - draft - sent - resolved - expired responses: '200': description: Takedown notice updated successfully content: application/json: schema: type: object properties: createdAt: type: - string - 'null' domain: type: string id: type: number matchId: type: - number - 'null' matchType: type: - string - 'null' enum: - logo - domain queryId: type: - number - 'null' status: type: string enum: - draft - sent - resolved - expired updatedAt: type: - string - 'null' required: - id - domain - queryId - status - matchId - matchType - createdAt - updatedAt '409': description: A takedown notice already exists for the target domain security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-notices x-fern-sdk-method-name: update x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters: get: operationId: get_TakedownLetterList summary: List takedown letters description: List all letters for a specific takedown notice. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown letters listed successfully content: application/json: schema: type: object properties: letters: type: array items: properties: createdAt: type: - string - 'null' id: type: number letterType: type: string takedownNoticeId: type: number templateId: type: string required: - id - takedownNoticeId - templateId - letterType - createdAt type: object required: - letters 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: list x-forge-hidden: true post: operationId: post_TakedownLetterCreate summary: Create takedown letter description: Generate a takedown letter for a notice and persist the rendered text. The PDF is generated lazily on download. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 requestBody: content: application/json: schema: type: object properties: fields: type: object properties: discoveryDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ domain: type: string maxLength: 500 generationDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ jurisdiction: type: string maxLength: 500 registrantEmail: type: string maxLength: 500 registrar: type: string maxLength: 500 registrarEmail: type: string maxLength: 500 resolutionByDate: type: string pattern: ^\d{4}-\d{2}-\d{2}$ senderCompany: type: string maxLength: 500 senderEmail: type: string maxLength: 500 senderName: type: string maxLength: 500 senderTitle: type: string maxLength: 500 trademarkName: type: string maxLength: 500 trademarkNumber: type: string maxLength: 500 trademarkOwner: type: string maxLength: 500 templateId: type: string minLength: 1 required: - templateId - fields responses: '200': description: Takedown letter created successfully content: application/json: schema: type: object properties: createdAt: type: - string - 'null' id: type: number letterText: type: string letterType: type: string takedownNoticeId: type: number templateId: type: string required: - id - takedownNoticeId - templateId - letterType - letterText - createdAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters/{letter_id}: delete: operationId: delete_TakedownLetterDelete summary: Delete takedown letter description: Delete a specific takedown letter and its associated PDF from storage. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 - name: letter_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown letter deleted successfully content: application/json: schema: type: object properties: message: type: string success: type: boolean required: - success - message 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: get_TakedownLetterGet summary: Get takedown letter description: Get a specific takedown letter by ID, including the rendered text. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 - name: letter_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown letter retrieved successfully content: application/json: schema: type: object properties: createdAt: type: - string - 'null' id: type: number letterText: type: string letterType: type: string takedownNoticeId: type: number templateId: type: string required: - id - takedownNoticeId - templateId - letterType - letterText - createdAt 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/takedown-notices/{notice_id}/letters/{letter_id}/pdf: get: operationId: get_TakedownLetterPdfGet summary: Download takedown letter PDF description: Download the PDF for a stored takedown letter. If no PDF exists yet, it is generated from the stored letter text and cached for future downloads. parameters: - name: account_id in: path required: true schema: type: string minLength: 1 - name: notice_id in: path required: true schema: type: integer exclusiveMinimum: 0 - name: letter_id in: path required: true schema: type: integer exclusiveMinimum: 0 responses: '200': description: Takedown letter PDF downloaded successfully content: application/pdf: schema: type: string format: binary 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: cloudforce-one.stakeout.takedown-letters x-fern-sdk-method-name: get-pdf x-forge-hidden: true /accounts/{account_id}/cloudforce-one/v2/brand-protection/total-queries: get: operationId: get_TotalQueries summary: Get total queries description: Get the total number of saved brand protection queries (domain + logo) for an account parameters: - name: account_id in: path required: true schema: type: string minLength: 1 responses: '200': description: Successfully retrieved total query count content: application/json: schema: type: array items: properties: total_queries: type: integer minimum: 0 required: - total_queries type: object 4XX: $ref: '#/components/responses/cloudforce-one-events_ApiV4ClientError' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Cloudforce One Write - Cloudforce One Read x-fern-availability: generally-available x-fern-sdk-group-name: brand-protection x-fern-sdk-method-name: url-info x-forge-hidden: true /accounts/{account_id}/brand-protection/alerts: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionAlerts summary: Read all alerts on submitted domains description: Return all alerts on submitted domains responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: alerts x-fern-sdk-method-name: get x-forge-hidden: true patch: operationId: patchAccountsAccountIdBrandProtectionAlerts summary: Update alerts on submitted domains by ID description: Return a success message after updating alerts on submitted domains by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: alerts x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/alerts/clear: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionAlertsClear summary: Update verification statuses of tracked URLs to awaiting by ID description: Return a success message after updating verification statuses of tracked URLs to awaiting by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: alerts.clear x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/alerts/refute: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionAlertsRefute summary: Update verification statuses of tracked URLs to disproven by ID description: Return a success message after updating verification statuses of tracked URLs to disproven by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: alerts.refute x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/alerts/verify: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionAlertsVerify summary: Update verification statuses of tracked URLs to confirmed by ID description: Return a success message after updating verification statuses of tracked URLs to confirmed by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: alerts.verify x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/brands: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 delete: operationId: deleteAccountsAccountIdBrandProtectionBrands summary: Delete brands by ID description: Return a success message after deleting brands by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: brands x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: getAccountsAccountIdBrandProtectionBrands summary: Read all brands description: Return all brands responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: brands x-fern-sdk-method-name: get x-forge-hidden: true post: operationId: postAccountsAccountIdBrandProtectionBrands summary: Create new brands description: Return new brands responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: brands x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/brand-protection/brands/patterns: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 delete: operationId: deleteAccountsAccountIdBrandProtectionBrandsPatterns summary: Delete patterns for brands by ID description: Return a success message after deleting patterns for brands by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: brands.patterns x-fern-sdk-method-name: delete x-forge-hidden: true get: operationId: getAccountsAccountIdBrandProtectionBrandsPatterns summary: Read patterns for brands by ID description: Return patterns for brands based on ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: brands.patterns x-fern-sdk-method-name: get x-forge-hidden: true post: operationId: postAccountsAccountIdBrandProtectionBrandsPatterns summary: Create new patterns for brands by ID description: Return a success message after creating new patterns for brands by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: brands.patterns x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/brand-protection/clear: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionClear summary: Update verification statuses of submitted URLs to awaiting by ID description: Return a success message after updating verification statuses of submitted URLs to awaiting by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: clear x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/domain-info: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionDomainInfo summary: Read submitted domains by ID description: Return submitted domains based on ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: domain-info x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/brand-protection/recent-submissions: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionRecentSubmissions summary: Read recent URL submissions description: Return recent URL submissions responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: recent-submissions x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/brand-protection/refute: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionRefute summary: Update verification statuses of submitted URLs to disproven by ID description: Return a success message after updating verification statuses of submitted URLs to disproven by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: refute x-fern-sdk-method-name: edit x-forge-hidden: true /accounts/{account_id}/brand-protection/submission-info: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionSubmissionInfo summary: Read URL submissions by ID description: Return URL submissions based on ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: submission-info x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/brand-protection/submit: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 post: operationId: postAccountsAccountIdBrandProtectionSubmit summary: Create new URL submissions description: Return new URL submissions responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/brand-protection-api_URLSubmit' default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: submit x-fern-sdk-method-name: create x-forge-hidden: true /accounts/{account_id}/brand-protection/tracked-domains: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionTrackedDomains summary: Read submitted domains by pattern description: Return submitted domains based on pattern responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: tracked-domains x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/brand-protection/url-info: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 get: operationId: getAccountsAccountIdBrandProtectionUrlInfo summary: Read submitted URLs by ID description: Return submitted URLs based on ID responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/brand-protection-api_URLInfo' default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write - Intel Read x-fern-availability: generally-available x-fern-sdk-group-name: url-info x-fern-sdk-method-name: get x-forge-hidden: true /accounts/{account_id}/brand-protection/verify: parameters: - name: account_id in: path required: true schema: type: string minLength: 1 patch: operationId: patchAccountsAccountIdBrandProtectionVerify summary: Update verification statuses of submitted URLs to confirmed by ID description: Return a success message after updating verification statuses of submitted URLs to confirmed by ID responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-api-token-group: - Intel Write x-fern-availability: generally-available x-fern-sdk-group-name: verify x-fern-sdk-method-name: edit x-forge-hidden: true /internal/submit: post: operationId: postInternalSubmit summary: Internal route for testing URL submissions description: Internal route for testing URL submissions. responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-fern-availability: generally-available x-fern-sdk-group-name: internal.submit x-fern-sdk-method-name: create x-forge-hidden: true /live: get: operationId: getLive summary: Run liveness checks description: Return a success message after running liveness checks responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-fern-availability: generally-available x-fern-sdk-group-name: live x-fern-sdk-method-name: get x-forge-hidden: true /ready: get: operationId: getReady summary: Run readiness checks description: Return a success message after running readiness checks responses: default: $ref: '#/components/responses/brand-protection-api_DEFAULT_ERROR' security: - api_token: [] tags: - Brand Protection x-fern-availability: generally-available x-fern-sdk-group-name: ready x-fern-sdk-method-name: get x-forge-hidden: true components: responses: cloudforce-one-events_ApiV4ClientError: description: Client error response. brand-protection-api_DEFAULT_ERROR: description: Default error response content: application/json: schema: $ref: '#/components/schemas/brand-protection-api_Error' schemas: brand-protection-api_URLInfo: type: object properties: result: type: array items: additionalProperties: {} type: object brand-protection-api_Error: type: object properties: code: description: Error code type: integer errors: description: Errors type: object additionalProperties: {} message: description: Error message type: string status: description: Error name type: string brand-protection-api_URLSubmit: type: object properties: skipped_urls: type: array items: additionalProperties: {} type: object submitted_urls: type: array items: additionalProperties: {} type: object securitySchemes: api_email: in: header name: X-Auth-Email type: apiKey api_key: in: header name: X-Auth-Key type: apiKey api_token: scheme: bearer type: http user_service_key: in: header name: X-Auth-User-Service-Key type: apiKey externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations