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 Email Security 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: Email Security paths: /accounts/{account_id}/email-security/investigate: parameters: - $ref: '#/components/parameters/email-security_account_id' get: operationId: email_security_investigate summary: Search email messages description: Returns information for each email that matches the provided search parameters. parameters: - name: start in: query description: The beginning of the search date range. Defaults to `now - 30 days`. Must not be in the future. schema: type: string format: date-time example: '2022-06-25T14:30:00Z' - name: end in: query description: The end of the search date range. Defaults to `now`. schema: type: string format: date-time example: '2022-07-25T14:30:00Z' - name: query in: query description: Space-delimited term matched case-insensitively against message metadata — sender, recipient, subject, attachment names and hashes, and message ID. schema: type: string example: bob jones - name: detections_only in: query description: Whether to include only detections in search results. schema: type: boolean default: true - name: final_disposition in: query description: Dispositions to filter by. schema: type: string enum: - MALICIOUS - SUSPICIOUS - SPOOF - SPAM - BULK - NONE - name: metric in: query description: Metric to aggregate the results by. schema: type: string - name: message_action in: query description: Message actions to filter by. schema: type: string enum: - PREVIEW - QUARANTINE_RELEASED - MOVED - name: recipient in: query description: Filter by recipient. Matches an email address or a domain. schema: type: string example: me@example.com - name: sender in: query description: Filter by sender. Matches an email address or a domain. schema: type: string example: noreply@example.com - name: smtp_helo_ip in: query description: Matches messages whose SMTP HELO server IP address equals this value. schema: type: string example: 192.0.2.1 - name: alert_id in: query description: Filter by alert ID. schema: type: string - name: domain in: query description: Filter by a domain found in the email — sender domain, recipient domain, or a domain in a link. schema: type: string example: example.com - name: message_id in: query description: Filter by the RFC 5322 Message-ID header. schema: type: string - name: subject in: query description: Search for messages containing individual keywords in any order within the subject. schema: type: string - name: delivery_status in: query description: Delivery status to filter by. schema: $ref: '#/components/schemas/email-security_MessageDeliveryStatus' - name: cursor in: query description: Pagination cursor from the previous response's `result_info`. schema: type: string x-auditable: true - $ref: '#/components/parameters/email-security_per_page' - name: page in: query description: 'Deprecated: Use cursor pagination instead. End of life: November 1, 2026.' schema: type: - integer - 'null' default: 1 minimum: 1 deprecated: true x-stainless-deprecation-message: Use cursor pagination instead. x-sunset: '2026-11-01T00:00:00Z' responses: '200': description: Search results for the provided query. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_MessageDetails' result_info: $ref: '#/components/schemas/email-security_CursorResultInfo' required: - result - result_info type: object '202': description: The search is taking longer than expected. Use the Location header to poll for results. headers: Location: description: URL to poll for search results. schema: type: string content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: description: Always empty on 202; follow the Location header to retrieve results. type: array items: type: string maxItems: 0 result_info: $ref: '#/components/schemas/email-security_CursorResultInfo' required: - result - result_info type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate x-fern-sdk-method-name: list x-stability: beta /accounts/{account_id}/email-security/investigate/bulk: parameters: - $ref: '#/components/parameters/email-security_account_id' get: operationId: email_security_get_bulk_jobs summary: List bulk action jobs description: Returns a paginated list of bulk action jobs for the account. parameters: - $ref: '#/components/parameters/email-security_page' - $ref: '#/components/parameters/email-security_per_page' - name: action_type in: query description: Filter jobs by the action they perform. schema: type: string enum: - MOVE - RELEASE - name: status in: query description: Filter jobs by their processing status. schema: $ref: '#/components/schemas/email-security_BulkJobStatus' responses: '200': description: Jobs retrieved successfully. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_BulkJobDetail' result_info: $ref: '#/components/schemas/email-security_CursorResultInfo' required: - result - result_info type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions x-fern-sdk-method-name: list x-stability: beta post: operationId: email_security_create_bulk_job summary: Create a bulk action job description: Creates a new bulk action job to move or release messages that match the provided search parameters. To move or release an explicit list of known messages instead of a search, use the move or release endpoints. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email-security_BulkActionRequest' responses: '201': description: Bulk job created. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-single' - properties: result: $ref: '#/components/schemas/email-security_BulkJobDetail' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions x-fern-sdk-method-name: create x-stability: beta /accounts/{account_id}/email-security/investigate/bulk/{job_id}: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: job_id in: path description: Identifier of the bulk action job. required: true schema: $ref: '#/components/schemas/email-security_BulkJobId' delete: operationId: email_security_delete_bulk_job summary: Delete a bulk action job description: Deletes the job, removing it from all list and detail endpoints. Only jobs in a terminal state (`COMPLETED`, `CANCELLED`, or `FAILED`) can be deleted. To stop an in-progress job without removing it, use the cancel endpoint instead. responses: '200': description: Job deleted. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-single' - properties: result: type: object properties: id: type: string format: uuid required: - id required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions x-fern-sdk-method-name: delete x-forge-require-confirmation: This operation permanently deletes the completed, cancelled, or failed bulk action job from all list and detail endpoints. x-stability: beta get: operationId: email_security_get_bulk_job summary: Get bulk action job details description: Returns the status and details of a specific bulk action job. responses: '200': description: Job details retrieved. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-single' - properties: result: $ref: '#/components/schemas/email-security_BulkJobDetail' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/investigate/bulk/{job_id}/cancel: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: job_id in: path description: Identifier of the bulk action job to cancel. required: true schema: $ref: '#/components/schemas/email-security_BulkJobId' post: operationId: email_security_cancel_bulk_job summary: Cancel a bulk action job description: Cancels the job, marking it as cancelled and stopping any pending message processing. The job record remains visible in list and detail endpoints. responses: '200': description: Job cancelled. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-single' - properties: result: $ref: '#/components/schemas/email-security_BulkJobDetail' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions x-fern-sdk-method-name: cancel x-stability: beta /accounts/{account_id}/email-security/investigate/bulk/{job_id}/messages: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: job_id in: path description: Identifier of the bulk action job whose messages to list. required: true schema: $ref: '#/components/schemas/email-security_BulkJobId' get: operationId: email_security_get_bulk_job_messages summary: List messages for a bulk action job description: Returns the individual messages associated with a bulk action job, including their processing status. parameters: - $ref: '#/components/parameters/email-security_page' - $ref: '#/components/parameters/email-security_per_page' - name: status in: query description: Filter the job's messages by their processing status. schema: $ref: '#/components/schemas/email-security_BulkActionMessageStatus' responses: '200': description: Messages for the bulk job. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_BulkActionMessageDetail' result_info: $ref: '#/components/schemas/email-security_CursorResultInfo' required: - result - result_info type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.bulk-actions.messages x-fern-sdk-method-name: list x-stability: beta /accounts/{account_id}/email-security/investigate/move: parameters: - $ref: '#/components/parameters/email-security_account_id' post: operationId: email_security_post_bulk_move summary: Move messages description: Moves one or more messages to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration. Operates on an explicit list of messages; to move all messages matching a search, create a bulk action job instead. requestBody: required: true content: application/json: schema: type: object properties: destination: $ref: '#/components/schemas/email-security_MailboxDestination' expected_disposition: description: 'Nonfunctional field. End of life: December 1, 2026.' type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' deprecated: true x-stainless-deprecation-message: This field is nonfunctional. ids: description: List of message IDs to move. type: array items: $ref: '#/components/schemas/email-security_InvestigateId' maxItems: 1000 minItems: 1 x-auditable: true postfix_ids: description: 'Deprecated, use `ids` instead. End of life: November 1, 2026.' type: array items: $ref: '#/components/schemas/email-security_PostfixId' deprecated: true x-auditable: true x-stainless-deprecation-message: Use `ids` instead. required: - destination - ids responses: '200': description: Bulk move operation results. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_MoveResponseItem' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate x-fern-sdk-method-name: move x-stability: beta /accounts/{account_id}/email-security/investigate/preview: parameters: - $ref: '#/components/parameters/email-security_account_id' post: operationId: email_security_post_preview summary: Generate preview for a non-detection message description: Generates a preview image for a message that was not flagged as a detection. The message is rendered from the copy in the recipient's mailbox, so this requires an active integration and only works while the message is still in the recipient's inbox. Returns a base64-encoded PNG screenshot of the email body. For messages with a detection, use the detection preview endpoint instead. requestBody: required: true content: application/json: schema: type: object properties: id: $ref: '#/components/schemas/email-security_InvestigateId' required: - id responses: '200': description: Email preview. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessagePreview' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.preview x-fern-sdk-method-name: generate x-stability: beta /accounts/{account_id}/email-security/investigate/release: parameters: - $ref: '#/components/parameters/email-security_account_id' post: operationId: email_security_post_release summary: Release messages from quarantine description: Delivers one or more quarantined messages to their intended recipients, for cases where a message was incorrectly quarantined. Operates on an explicit list of messages; to release all messages matching a search, create a bulk action job instead. The response includes delivery status for each recipient. requestBody: description: The messages to release, identified by their investigate IDs. required: true content: application/json: schema: type: object properties: ids: description: Investigate IDs of the messages to release. type: array items: $ref: '#/components/schemas/email-security_InvestigateId' minItems: 1 x-auditable: true required: - ids responses: '200': description: Release operation results. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_ReleaseResponse' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate x-fern-sdk-method-name: release x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' - $ref: '#/components/parameters/email-security_submission' get: operationId: email_security_get_message summary: Get message details description: Retrieves comprehensive details for a specific email message including headers, recipients, sender information, and current quarantine status. Use the investigate_id from search results to fetch detailed information. responses: '200': description: Email message details. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessageDetails' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/action_log: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' get: operationId: email_security_get_message_action_log summary: List post-delivery actions for a message description: Returns the list of post-delivery actions (moves, quarantine releases, previews, etc.) that have been applied to a specific email message. parameters: - $ref: '#/components/parameters/email-security_page' - $ref: '#/components/parameters/email-security_per_page' responses: '200': description: Action log for the email. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/email-security_ActionEntry' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.action-log x-fern-sdk-method-name: list x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/detections: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' get: operationId: email_security_get_message_detections summary: Get message detection details description: Returns detection details such as threat categories and sender information for messages with a detection. responses: '200': description: Email message detection details. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessageDetectionDetails' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.detections x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/move: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' post: operationId: email_security_post_message_move summary: Move a message description: Moves a single message to a specified mailbox folder (Inbox, JunkEmail, DeletedItems, RecoverableItemsDeletions, or RecoverableItemsPurges). Requires active integration. requestBody: required: true content: application/json: schema: type: object properties: destination: $ref: '#/components/schemas/email-security_MailboxDestination' expected_disposition: description: 'Nonfunctional field. End of life: December 1, 2026.' type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' deprecated: true x-stainless-deprecation-message: This field is nonfunctional. required: - destination responses: '200': description: Move operation results. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: array items: $ref: '#/components/schemas/email-security_MoveResponseItem' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: beta x-fern-ignore: true x-fern-sdk-group-name: email-security.investigate.move x-fern-sdk-method-name: create x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/preview: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' get: operationId: email_security_get_message_preview summary: Get preview for a detection description: Returns a preview of the message body as a base64-encoded PNG image for any message with a detection. For messages without a detection, use the non-detection preview endpoint instead. responses: '200': description: Email preview. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessagePreview' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.preview x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/raw: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' get: operationId: email_security_get_message_raw summary: Get raw email content description: Returns the raw EML content of any message with a detection. responses: '200': description: Raw email content. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessageRaw' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.raw x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/reclassify: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' post: operationId: email_security_post_reclassify summary: Change email classification description: Submits a request to reclassify an email's disposition. Use for reporting false positives or false negatives. Optionally provide the raw EML content for reanalysis. The reclassification is processed asynchronously. Deprecated; use the create submissions endpoint instead. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/email-security_ReclassifyRequest' responses: '202': description: Reclassification request accepted. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: object required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' deprecated: true security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' x-fern-availability: deprecated x-fern-ignore: true x-fern-sdk-group-name: email-security.investigate.reclassify x-fern-sdk-method-name: create x-stability: beta /accounts/{account_id}/email-security/investigate/{investigate_id}/trace: parameters: - $ref: '#/components/parameters/email-security_account_id' - name: investigate_id in: path required: true schema: $ref: '#/components/schemas/email-security_InvestigateId' get: operationId: email_security_get_message_trace summary: Get email trace description: Retrieves delivery and processing trace information for an email message. Shows the delivery path, retraction history, and move operations performed on the message. Useful for debugging delivery issues. responses: '200': description: Email trace. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: $ref: '#/components/schemas/email-security_MessageTrace' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.investigate.trace x-fern-sdk-method-name: get x-stability: beta /accounts/{account_id}/email-security/phishguard/reports: parameters: - $ref: '#/components/parameters/email-security_account_id' get: operationId: email_security_get_phishguard_reports summary: List PhishGuard reports description: Retrieves PhishGuard security alert reports for a specified date range. Reports include detected threats, dispositions, and contextual information. Use for security monitoring and threat analysis. parameters: - name: start in: query description: Start of the time range (RFC3339). Takes precedence over from_date. schema: type: string format: date-time example: '2020-08-01T00:00:00Z' - name: end in: query description: End of the time range (RFC3339). Takes precedence over to_date. schema: type: string format: date-time example: '2020-09-01T00:00:00Z' - name: from_date in: query description: Deprecated, use `start` instead. Start date in YYYY-MM-DD format. schema: type: string format: date deprecated: true example: '2020-08-01T00:00:00Z' x-stainless-deprecation-message: Use `start` instead. x-sunset: '2026-11-01T00:00:00Z' - name: to_date in: query description: Deprecated, use `end` instead. End date in YYYY-MM-DD format. schema: type: string format: date deprecated: true example: '2020-09-01T00:00:00Z' x-stainless-deprecation-message: Use `end` instead. x-sunset: '2026-11-01T00:00:00Z' - $ref: '#/components/parameters/email-security_page' - $ref: '#/components/parameters/email-security_per_page' responses: '200': description: List of PhishGuard reports. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/email-security_PhishGuardReport' required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: - 'Cloud Email Security: Write' - 'Cloud Email Security: Read' x-fern-availability: beta x-fern-sdk-group-name: email-security.phishguard.reports x-fern-sdk-method-name: list x-stability: beta /accounts/{account_id}/email-security/submissions: parameters: - $ref: '#/components/parameters/email-security_account_id' get: operationId: email_security_submissions summary: List reclassify submissions description: Returns information for submissions made to reclassify emails. Shows the status, outcome, and disposition changes for reclassification requests made by users or the security team. Useful for tracking false positive/negative reports. parameters: - name: start in: query description: The beginning of the search date range. Defaults to `now - 30 days`. schema: type: string format: date-time example: '2022-06-25T14:30:00Z' - name: end in: query description: The end of the search date range. Defaults to `now`. schema: type: string format: date-time example: '2022-07-25T14:30:00Z' - name: type in: query description: Filter by who created the submission — `TEAM` for security team members or `USER` for end users. schema: type: string enum: - TEAM - USER - name: submission_id in: query description: Filter by a specific submission ID. schema: type: string - name: original_disposition in: query schema: $ref: '#/components/schemas/email-security_SubmissionDisposition' - name: requested_disposition in: query schema: $ref: '#/components/schemas/email-security_SubmissionDisposition' - name: outcome_disposition in: query schema: $ref: '#/components/schemas/email-security_SubmissionDisposition' - name: status in: query description: Filter by review status — `escalated`, `reviewed`, or `unreviewed`. schema: type: string - name: query in: query description: Search term for filtering submissions. schema: type: - string - 'null' - name: escalated_from_user in: query description: When true, return only submissions that were escalated by an end user (vs. by the security team). When false, return only submissions that were not escalated by an end user. When omitted, no filter is applied. schema: type: boolean - name: order in: query description: Field to sort by. schema: type: string default: requested_at enum: - submission_id - subject - original_disposition - requested_disposition - outcome_disposition - requested_at - $ref: '#/components/parameters/email-security_direction' - $ref: '#/components/parameters/email-security_page' - $ref: '#/components/parameters/email-security_per_page' responses: '200': description: List of submissions. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/email-security_Submission' type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-api-token-group: null x-fern-availability: beta x-fern-sdk-group-name: email-security.submissions x-fern-sdk-method-name: list x-stability: beta post: operationId: email_security_create_submissions summary: Create new submissions description: Submits messages for reclassification or to report missed detections. requestBody: required: true content: application/json: schema: discriminator: propertyName: type oneOf: - properties: messages: type: array items: $ref: '#/components/schemas/email-security_ReclassificationSubmission' type: type: string enum: - reclassification required: - type - messages type: object - properties: messages: type: array items: $ref: '#/components/schemas/email-security_MissedDetectionSubmission' type: type: string enum: - missed_detection required: - type - messages type: object responses: '202': description: Submission accepted. content: application/json: schema: allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result: type: object properties: results: type: array items: $ref: '#/components/schemas/email-security_SubmissionResult' required: - results required: - result type: object 4XX: $ref: '#/components/responses/email-security_ClientError' security: - api_token: [] - api_email: [] api_key: [] tags: - Email Security x-fern-availability: beta x-fern-sdk-group-name: email-security.submissions x-fern-sdk-method-name: create x-stability: beta components: schemas: email-security_MailboxDestination: description: The mailbox folder to move messages to. type: string enum: - Inbox - JunkEmail - DeletedItems - RecoverableItemsDeletions - RecoverableItemsPurges email-security_OptionalSubmissionDisposition: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_SubmissionDisposition' email-security_InvestigateId: description: Unique identifier for a message retrieved from investigation. type: string example: 4Njp3P0STMz2c02Q-2024-01-05T10:00:00-12345678 email-security_ThreatCategory: type: object properties: description: type: - string - 'null' id: type: integer name: type: - string - 'null' email-security_BulkJobActionParams: discriminator: propertyName: type oneOf: - properties: destination: $ref: '#/components/schemas/email-security_MailboxDestination' expected_disposition: description: 'Nonfunctional field. End of life: December 1, 2026.' type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' deprecated: true x-stainless-deprecation-message: This field is nonfunctional. x-sunset: '2026-12-01T00:00:00Z' type: type: string enum: - MOVE required: - type - destination type: object - properties: type: type: string enum: - RELEASE required: - type type: object email-security_MessageDeliveryStatus: description: Delivery status of the message. type: string enum: - delivered - moved - quarantined - rejected - deferred - bounced - queued - move_failed email-security_ReleaseResponse: type: object properties: delivered: type: - array - 'null' items: type: string failed: type: - array - 'null' items: type: string id: allOf: - $ref: '#/components/schemas/email-security_InvestigateId' x-auditable: true postfix_id: description: 'Deprecated, use `id` instead. End of life: November 1, 2026.' allOf: - $ref: '#/components/schemas/email-security_PostfixId' deprecated: true x-stainless-deprecation-message: Use `id` instead. undelivered: type: - array - 'null' items: type: string required: - id email-security_BulkActionMessageDetail: type: object properties: action_params: $ref: '#/components/schemas/email-security_BulkMessageActionParams' action_type: type: string enum: - MOVE - RELEASE alert_id: type: - string - 'null' created_at: type: string format: date-time email_message_id: type: - string - 'null' message: $ref: '#/components/schemas/email-security_MessageDetails' message_id: type: string format: uuid postfix_id: type: string processed_at: type: - string - 'null' format: date-time retry_after: description: When to retry the action if it failed. type: - string - 'null' format: date-time retry_count: type: integer status: $ref: '#/components/schemas/email-security_BulkActionMessageStatus' status_message: type: - string - 'null' required: - message_id - postfix_id - action_type - action_params - status - retry_count - created_at email-security_ValidationStatus: type: - string - 'null' enum: - pass - neutral - fail - error - none email-security_BulkJobId: description: Bulk action job identifier. type: string format: uuid example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415 x-auditable: true email-security_identifier: description: Identifier. type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 x-auditable: true email-security_api-response-collection: type: object allOf: - $ref: '#/components/schemas/email-security_api-response-common' - properties: result_info: type: object properties: count: description: Total number of results for the requested service. type: number example: 1 page: description: Current page within paginated list of results. type: number example: 1 per_page: description: Number of results per page of results. type: number example: 20 total_count: description: Total results available without any search parameters. type: number example: 2000 type: object email-security_CursorResultInfo: type: object properties: count: description: Number of items in current page. type: integer minimum: 0 next: description: Cursor for next page. type: - string - 'null' page: description: 'Deprecated: Always returns 0. End of life: November 1, 2026.' type: integer deprecated: true minimum: 0 x-stainless-deprecation-message: This field always returns 0 and is deprecated. per_page: description: Number of items per page. type: integer minimum: 0 previous: description: Cursor for previous page. type: - string - 'null' total_count: description: 'Deprecated: Always returns 0. End of life: November 1, 2026.' type: integer deprecated: true minimum: 0 x-stainless-deprecation-message: This field always returns 0 and is deprecated. required: - per_page - count - total_count email-security_MessageDeliveryMode: type: - string - 'null' enum: - DIRECT - BCC - JOURNAL - REVIEW_SUBMISSION - DMARC_UNVERIFIED - DMARC_FAILURE_REPORT - DMARC_AGGREGATE_REPORT - THREAT_INTEL_SUBMISSION - SIMULATION_SUBMISSION - API - RETRO_SCAN email-security_messages: type: array items: properties: code: type: integer minimum: 1000 documentation_url: type: string message: type: string source: type: object properties: pointer: type: string required: - code - message type: object uniqueItems: true example: [] email-security_ActionEntryProperties: type: object properties: folder: type: - string - 'null' requested_by: type: - string - 'null' requested_disposition: type: - string - 'null' service: type: - string - 'null' submission_id: type: - string - 'null' submission_type: type: - string - 'null' email-security_BulkJobStatus: description: Status of a bulk action job. type: string enum: - PENDING - DISCOVERING - PROCESSING - COMPLETED - FAILED - CANCELLED email-security_BulkActionMessageStatus: description: Status of a message within a bulk action job. type: string enum: - PENDING - PROCESSING - COMPLETED - FAILED - CANCELLED - SKIPPED email-security_PhishGuardReport: type: object properties: content: type: string created_at: type: - string - 'null' format: date-time readOnly: true disposition: $ref: '#/components/schemas/email-security_DispositionLabel' fields: type: object properties: from: type: - string - 'null' occurred_at: type: string format: date-time readOnly: true postfix_id: type: - string - 'null' to: type: array items: type: string ts: description: Deprecated, use `occurred_at` instead. type: string format: date-time deprecated: true readOnly: true x-stainless-deprecation-message: Use `occurred_at` instead. required: - to id: type: integer priority: type: string tags: type: - array - 'null' items: $ref: '#/components/schemas/email-security_PhishGuardReportTag' title: type: string ts: description: Deprecated, use `created_at` instead. type: string format: date-time deprecated: true readOnly: true x-stainless-deprecation-message: Use `created_at` instead. updated_at: type: - string - 'null' format: date-time readOnly: true required: - id - title - content - fields - priority - disposition email-security_BulkActionRequest: type: object properties: action: description: The action the job performs on every message matching the search parameters. type: string enum: - MOVE - RELEASE comment: description: Optional note describing the job. type: - string - 'null' destination: description: Required when action is 'MOVE'. allOf: - $ref: '#/components/schemas/email-security_MailboxDestination' expected_disposition: description: 'Nonfunctional field. End of life: December 1, 2026.' type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' deprecated: true x-stainless-deprecation-message: This field is nonfunctional. search_params: $ref: '#/components/schemas/email-security_BulkSearchParams' required: - action - search_params email-security_api-response-common-failure: type: object properties: errors: example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/email-security_messages' minLength: 1 messages: example: [] allOf: - $ref: '#/components/schemas/email-security_messages' result: type: - object - 'null' enum: - null success: description: Whether the API call was successful. type: boolean example: false enum: - false required: - success - errors - messages - result email-security_DispositionLabel: description: The verdict Email Security assigns to a message. type: string enum: - MALICIOUS - MALICIOUS-BEC - SUSPICIOUS - SPOOF - SPAM - BULK - ENCRYPTED - EXTERNAL - UNKNOWN - NONE email-security_BulkSearchParams: type: object properties: action_log: description: 'Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026.' type: boolean default: false deprecated: true x-stainless-deprecation-message: Use GET /investigate/{investigate_id}/action_log instead. alert_id: description: Alert ID of the detection to filter by. type: - string - 'null' delivery_status: description: Delivery status to filter by. type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_MessageDeliveryStatus' detections_only: description: Whether to include only detections in search results. type: boolean default: true domain: description: Match messages that mention this domain — sender domain, recipient domain, or a domain in a link. type: - string - 'null' end: description: End of search date range. type: string format: date-time example: '2022-07-25T14:30:00Z' exact_subject: description: Match messages whose subject line equals this value exactly. type: - string - 'null' final_disposition: description: Dispositions to filter by. type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' message_action: description: Message actions to filter by. type: - string - 'null' enum: - PREVIEW - QUARANTINE_RELEASED - MOVED message_id: description: Message-ID header value to filter by. type: - string - 'null' metric: description: Metric name to filter the search by. type: - string - 'null' query: description: Space-delimited search term. Case-insensitive. type: - string - 'null' recipient: description: Match messages whose recipient is this email address or domain. type: - string - 'null' sender: description: Match messages whose sender is this email address or domain. type: - string - 'null' smtp_helo_ip: description: Matches messages whose SMTP HELO server IP address equals this value. type: - string - 'null' start: description: Beginning of search date range. type: string format: date-time example: '2022-06-25T14:30:00Z' subject: description: Match messages whose subject contains these keywords, in any order. type: - string - 'null' submissions: description: Whether to search reclassification submissions instead of original messages. type: boolean default: false email-security_Validation: type: object properties: comment: type: - string - 'null' dkim: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_ValidationStatus' dmarc: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_ValidationStatus' spf: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_ValidationStatus' email-security_MessagePreview: type: object properties: screenshot: description: A base64 encoded PNG image of the email. type: string required: - screenshot email-security_Finding: description: A single detection finding for a message. type: object properties: attachment: type: - string - 'null' detail: type: - string - 'null' detection: description: Detection result associated with this finding. type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' field: type: - string - 'null' name: type: - string - 'null' portion: type: - string - 'null' reason: type: - string - 'null' score: type: - number - 'null' format: double value: type: - string - 'null' email-security_SubmissionResult: type: object properties: accepted: type: boolean error: type: - string - 'null' id: type: string required: - id - accepted email-security_MessageHeader: type: object properties: name: type: string value: type: string required: - name - value email-security_Link: type: object properties: href: type: string text: type: - string - 'null' required: - href email-security_api-response-single: type: object allOf: - $ref: '#/components/schemas/email-security_api-response-common' email-security_api-response-common: type: object properties: errors: $ref: '#/components/schemas/email-security_messages' messages: $ref: '#/components/schemas/email-security_messages' success: description: Whether the API call was successful. type: boolean example: true enum: - true required: - success - errors - messages email-security_Submission: type: object properties: customer_status: $ref: '#/components/schemas/email-security_CustomerStatus' escalated_as: $ref: '#/components/schemas/email-security_OptionalSubmissionDisposition' escalated_at: description: When the submission was escalated to the security team. type: - string - 'null' format: date-time escalated_by: description: Email address of the user who escalated the submission. type: - string - 'null' escalated_submission_id: description: Submission ID of the escalated team submission, when this user submission was escalated. type: - string - 'null' original_disposition: $ref: '#/components/schemas/email-security_OptionalSubmissionDisposition' original_edf_hash: description: EDF hash of the original message. type: - string - 'null' original_postfix_id: description: The postfix ID of the original message that was submitted. type: - string - 'null' outcome: description: Processing outcome of the submission. type: - string - 'null' outcome_disposition: $ref: '#/components/schemas/email-security_OptionalSubmissionDisposition' requested_at: description: When the submission was requested (UTC). type: string format: date-time requested_by: description: Email address of the user who requested the submission. type: - string - 'null' requested_disposition: $ref: '#/components/schemas/email-security_OptionalSubmissionDisposition' requested_ts: description: Deprecated, use `requested_at` instead. type: string deprecated: true readOnly: true x-stainless-deprecation-message: Use `requested_at` instead. status: description: Processing status of the submission. type: - string - 'null' subject: description: Subject line of the submitted message. type: - string - 'null' submission_id: type: string x-auditable: true type: description: Indicates whether a team member or an end user created the submission. type: - string - 'null' enum: - Team - User required: - submission_id - requested_at email-security_ReclassifyRequest: type: object properties: eml_content: description: Base64 encoded content of the EML file. type: string escalated_submission_id: description: Submission ID of the original user submission, when reclassifying an escalated user report. type: string x-auditable: true expected_disposition: description: The disposition the message should have. type: string enum: - NONE - BULK - MALICIOUS - SPAM - SPOOF - SUSPICIOUS required: - expected_disposition email-security_BulkJobDetail: type: object properties: action_params: $ref: '#/components/schemas/email-security_BulkJobActionParams' action_type: type: string enum: - MOVE - RELEASE comment: type: - string - 'null' completed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time job_id: type: string format: uuid messages_cancelled: description: 'Messages that were cancelled: rows cancelled via the API before being claimed, and rows whose in-flight attempt ended when the job reached a terminal state. Together the counters satisfy total_messages_discovered = messages_pending + messages_successful + messages_failed + messages_skipped + messages_cancelled.' type: integer messages_failed: type: integer messages_pending: type: integer messages_skipped: description: Messages that discovery skipped (for example, phish submissions, which the job cannot action). type: integer messages_successful: type: integer search_params: $ref: '#/components/schemas/email-security_BulkSearchParams' started_at: type: - string - 'null' format: date-time status: $ref: '#/components/schemas/email-security_BulkJobStatus' status_message: type: - string - 'null' total_messages_discovered: type: integer required: - job_id - action_type - action_params - search_params - status - total_messages_discovered - messages_pending - messages_successful - messages_failed - messages_skipped - messages_cancelled - created_at email-security_TraceLine: type: object properties: lineno: description: Line number in the trace log. type: integer logged_at: type: - string - 'null' format: date-time readOnly: true message: type: string ts: description: 'Deprecated, use `logged_at` instead. End of life: November 1, 2026.' type: string deprecated: true readOnly: true x-stainless-deprecation-message: Use `logged_at` instead. email-security_BulkMessageActionParams: discriminator: propertyName: type oneOf: - properties: client_recipient: type: string destination: $ref: '#/components/schemas/email-security_MailboxDestination' expected_disposition: description: 'Nonfunctional field. End of life: December 1, 2026.' type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' deprecated: true x-stainless-deprecation-message: This field is nonfunctional. x-sunset: '2026-12-01T00:00:00Z' type: type: string enum: - MOVE required: - type - destination - client_recipient type: object - properties: client_recipient: type: string type: type: string enum: - RELEASE required: - type - client_recipient type: object email-security_MessageDetails: type: object properties: action_log: description: 'Deprecated, use `GET /investigate/{investigate_id}/action_log` instead. End of life: November 1, 2026.' type: array items: $ref: '#/components/schemas/email-security_ActionLogEntry' deprecated: true x-stainless-deprecation-message: Use GET /investigate/{investigate_id}/action_log instead. alert_id: type: - string - 'null' client_recipients: type: array items: type: string delivery_mode: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_MessageDeliveryMode' delivery_status: type: - array - 'null' items: $ref: '#/components/schemas/email-security_MessageDeliveryStatus' detection_reasons: type: array items: type: string edf_hash: type: - string - 'null' envelope_from: type: - string - 'null' envelope_to: type: - array - 'null' items: type: string final_disposition: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' findings: description: 'Deprecated, use the `findings` field from `GET /investigate/{investigate_id}/detections` instead. End of life: November 1, 2026. Detection findings for this message.' type: - array - 'null' items: properties: attachment: type: - string - 'null' detail: type: - string - 'null' detection: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' field: type: - string - 'null' name: type: - string - 'null' portion: type: - string - 'null' reason: type: - string - 'null' score: type: - number - 'null' format: double value: type: - string - 'null' type: object deprecated: true x-stainless-deprecation-message: Use the `findings` field from GET /investigate/{investigate_id}/detections instead. from: type: - string - 'null' from_name: type: - string - 'null' htmltext_structure_hash: type: - string - 'null' id: allOf: - $ref: '#/components/schemas/email-security_InvestigateId' x-auditable: true is_phish_submission: type: boolean is_quarantined: type: boolean message_id: type: - string - 'null' post_delivery_operations: description: Post-delivery operations performed on this message. type: - array - 'null' items: enum: - PREVIEW - QUARANTINE_RELEASE - SUBMISSION - MOVE type: string postfix_id: $ref: '#/components/schemas/email-security_PostfixId' postfix_id_outbound: type: - string - 'null' properties: description: Message processing properties. type: object properties: allowlisted_pattern: description: Pattern that allowlisted this message. type: - string - 'null' allowlisted_pattern_type: description: Type of allowlist pattern. enum: - quarantine_release - acceptable_sender - allowed_sender - allowed_recipient - domain_similarity - domain_recency - managed_acceptable_sender - outbound_ndr type: - string - 'null' blocklisted_message: description: Whether message was blocklisted. type: - boolean - 'null' blocklisted_pattern: description: Pattern that blocklisted this message. type: - string - 'null' whitelisted_pattern_type: description: Legacy field for allowlist pattern type. enum: - quarantine_release - acceptable_sender - allowed_sender - allowed_recipient - domain_similarity - domain_recency - managed_acceptable_sender - outbound_ndr type: - string - 'null' replyto: type: - string - 'null' scanned_at: description: When the message was scanned (UTC). type: - string - 'null' format: date-time sent_at: description: When the message was sent (UTC). type: - string - 'null' format: date-time sent_date: type: - string - 'null' smtp_helo_server_ip: type: - string - 'null' smtp_previous_hop_ip: type: - string - 'null' subject: type: - string - 'null' threat_categories: type: - array - 'null' items: type: string to: type: - array - 'null' items: type: string to_name: type: - array - 'null' items: type: string ts: description: 'Deprecated, use `scanned_at` instead. End of life: November 1, 2026.' type: string deprecated: true readOnly: true x-stainless-deprecation-message: Use `scanned_at` instead. validation: type: - object - 'null' allOf: - $ref: '#/components/schemas/email-security_Validation' x_originating_ip: type: - string - 'null' required: - id - ts - client_recipients - postfix_id - detection_reasons - action_log - is_quarantined - is_phish_submission - properties email-security_MessageTrace: type: object properties: inbound: type: object properties: lines: type: - array - 'null' items: $ref: '#/components/schemas/email-security_TraceLine' pending: type: - boolean - 'null' outbound: type: object properties: lines: type: - array - 'null' items: $ref: '#/components/schemas/email-security_TraceLine' pending: type: - boolean - 'null' required: - inbound - outbound email-security_PhishGuardReportTag: type: object properties: category: type: string value: type: string required: - category - value email-security_MissedDetectionSubmission: type: object properties: eml_content: description: Base64 encoded content of the EML file. type: string escalated_submission_id: description: Submission ID of the original user submission, when escalating an escalated user report. type: string x-auditable: true expected_disposition: $ref: '#/components/schemas/email-security_SubmissionDisposition' message_id: description: Message-ID header value of the reported message. type: string x-auditable: true postfix_id: $ref: '#/components/schemas/email-security_PostfixId' recipient_emails: description: Recipient email addresses of the reported message. type: array items: type: string x-auditable: true minItems: 1 required: - postfix_id - expected_disposition - message_id - recipient_emails email-security_ReclassificationSubmission: type: object properties: alert_id: description: Alert ID of the detection to reclassify. type: string x-auditable: true escalated_submission_id: description: Submission ID of the original user submission, when reclassifying an escalated user report. type: string x-auditable: true expected_disposition: $ref: '#/components/schemas/email-security_SubmissionDisposition' required: - alert_id - expected_disposition email-security_ActionLogEntry: type: object properties: completed_at: description: Timestamp when action completed. type: string format: date-time readOnly: true completed_timestamp: description: 'Deprecated, use `completed_at` instead. End of life: November 1, 2026.' type: string deprecated: true readOnly: true x-stainless-deprecation-message: Use `completed_at` instead. operation: description: Type of action performed. type: string enum: - MOVE - RELEASE - RECLASSIFY - SUBMISSION - QUARANTINE_RELEASE - PREVIEW properties: description: Additional properties for the action. type: object properties: folder: description: Target folder for move operations. type: string requested_by: description: User who requested the action. type: string status: description: Status of the action. type: - string - 'null' required: - completed_at - operation email-security_Attachment: type: object properties: content_type: description: MIME type of the attachment. type: - string - 'null' detection: description: Detection result for this attachment. type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' encrypted: description: Whether the attachment is encrypted. type: - boolean - 'null' filename: description: Name of the attached file. type: - string - 'null' md5: description: MD5 hash of the attachment. type: - string - 'null' name: description: Attachment name (alternative to filename). type: - string - 'null' sha1: description: SHA1 hash of the attachment. type: - string - 'null' sha256: description: SHA256 hash of the attachment. type: - string - 'null' size: description: Size of the attachment in bytes. type: integer minimum: 0 required: - size email-security_MessageDetectionDetails: type: object properties: action: type: string attachments: type: array items: $ref: '#/components/schemas/email-security_Attachment' final_disposition: type: - string - 'null' allOf: - $ref: '#/components/schemas/email-security_DispositionLabel' findings: type: - array - 'null' items: $ref: '#/components/schemas/email-security_Finding' headers: type: array items: $ref: '#/components/schemas/email-security_MessageHeader' links: type: array items: $ref: '#/components/schemas/email-security_Link' sender_info: type: object properties: as_name: description: The name of the autonomous system. type: - string - 'null' as_number: description: The number of the autonomous system. type: - integer - 'null' geo: type: - string - 'null' ip: type: - string - 'null' pld: type: - string - 'null' threat_categories: type: array items: $ref: '#/components/schemas/email-security_ThreatCategory' validation: $ref: '#/components/schemas/email-security_Validation' required: - validation - headers - threat_categories - sender_info - links - action - attachments - findings email-security_PostfixId: description: The identifier of the message. type: string example: 4Njp3P0STMz2c02Q email-security_ActionEntry: type: object properties: completed_at: description: Timestamp when the action completed. type: - string - 'null' format: date-time operation: type: string enum: - PREVIEW - QUARANTINE_RELEASE - SUBMISSION - MOVE properties: type: - object - 'null' allOf: - $ref: '#/components/schemas/email-security_ActionEntryProperties' started_at: description: Timestamp when the action was initiated. type: - string - 'null' format: date-time status: type: - string - 'null' success: type: - boolean - 'null' required: - operation email-security_MoveResponseItem: type: object properties: completed_at: description: When the move operation completed (UTC). type: - string - 'null' format: date-time completed_timestamp: description: 'Deprecated, use `completed_at` instead. End of life: November 1, 2026.' type: string format: date-time deprecated: true x-stainless-deprecation-message: Use `completed_at` instead. destination: description: Destination folder for the message. type: - string - 'null' item_count: description: 'Number of items moved. End of life: November 1, 2026.' type: integer deprecated: true x-stainless-deprecation-message: This field is deprecated. message_id: description: Message identifier. type: - string - 'null' operation: description: Type of operation performed. type: - string - 'null' recipient: description: Recipient email address. type: - string - 'null' status: description: Operation status. type: - string - 'null' success: description: Whether the operation succeeded. type: boolean required: - success email-security_CustomerStatus: type: - string - 'null' enum: - escalated - reviewed - unreviewed email-security_SubmissionDisposition: description: The disposition a message is submitted to have. type: string enum: - MALICIOUS - SUSPICIOUS - SPOOF - SPAM - BULK - NONE email-security_MessageRaw: type: object properties: raw: description: A UTF-8 encoded eml file of the email. type: string required: - raw parameters: email-security_page: description: Current page within paginated list of results. in: query name: page schema: type: integer example: 1 default: 1 minimum: 1 email-security_per_page: description: The number of results per page. Maximum value is 1000. in: query name: per_page schema: type: integer example: 20 default: 20 maximum: 1000 minimum: 1 email-security_submission: description: 'When true, search the submissions datastore only. When false or omitted, search the regular datastore only.' in: query name: submission schema: type: boolean email-security_account_id: description: Account identifier tag. in: path name: account_id required: true schema: $ref: '#/components/schemas/email-security_identifier' email-security_direction: description: The sorting direction. in: query name: direction schema: type: string enum: - asc - desc responses: email-security_ClientError: description: Client error. content: application/json: schema: $ref: '#/components/schemas/email-security_api-response-common-failure' 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