APIs.io Engineering Platform Email Security Settings API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Email Security Settings API
  version: 4.0.0
tags:
- name: Email Security Settings
paths:
  /accounts/{account_id}/email-security/settings/allow_patterns:
    delete:
      operationId: email_security_delete_allow_patterns
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2401
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple email allow patterns
      tags:
      - Email Security Settings
    get:
      description: List, search, and sort an accounts's email allow patterns.
      operationId: email_security_list_allow_patterns
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - pattern
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: is_sender
        schema:
          type: boolean
      - in: query
        name: is_recipient
        schema:
          type: boolean
      - in: query
        name: is_spoof
        schema:
          type: boolean
      - in: query
        name: verify_sender
        schema:
          type: boolean
      - in: query
        name: pattern_type
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_AllowPattern'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of allow-patterns for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List email allow patterns
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateAllowPattern'
              - items:
                  $ref: '#/components/schemas/email-security_CreateAllowPattern'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_AllowPattern'
                      - items:
                          $ref: '#/components/schemas/email-security_AllowPattern'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an email allow pattern
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}:
    delete:
      operationId: email_security_delete_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2401
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an email allow pattern
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: Trust all messages send from test@example.com
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                        properties:
                          comments:
                            type:
                            - string
                            - 'null'
                          is_recipient:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_sender:
                            type: boolean
                          is_spoof:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                          verify_sender:
                            type: boolean
                        required:
                        - is_recipient
                        - is_sender
                        - is_spoof
                        - pattern
                        - is_regex
                        - verify_sender
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: Trust all messages send from test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recipient: false
                        is_regex: false
                        is_sender: true
                        is_spoof: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                        verify_sender: true
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an email allow pattern
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_allow_pattern
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2401
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  type:
                  - string
                  - 'null'
                is_recipient:
                  type:
                  - boolean
                  - 'null'
                is_regex:
                  type:
                  - boolean
                  - 'null'
                is_sender:
                  type:
                  - boolean
                  - 'null'
                is_spoof:
                  type:
                  - boolean
                  - 'null'
                pattern:
                  minLength: 1
                  type:
                  - string
                  - 'null'
                pattern_type:
                  allOf:
                  - $ref: '#/components/schemas/email-security_PatternType'
                  - type:
                    - string
                    - 'null'
                verify_sender:
                  type:
                  - boolean
                  - 'null'
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: Trust all messages send from test@example.com
                          is_recipient: false
                          is_regex: false
                          is_sender: true
                          is_spoof: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                          verify_sender: true
                        properties:
                          comments:
                            type:
                            - string
                            - 'null'
                          is_recipient:
                            type: boolean
                          is_regex:
                            type: boolean
                          is_sender:
                            type: boolean
                          is_spoof:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                          verify_sender:
                            type: boolean
                        required:
                        - is_recipient
                        - is_sender
                        - is_spoof
                        - pattern
                        - is_regex
                        - verify_sender
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2401
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: Trust all messages send from test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2401
                        is_recipient: false
                        is_regex: false
                        is_sender: true
                        is_spoof: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                        verify_sender: true
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an email allow pattern
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders:
    delete:
      operationId: email_security_delete_blocked_senders
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    example: 2402
                    format: int32
                    title: identifier
                    type: integer
                required:
                - id
                type: object
              minItems: 1
              type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        properties:
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                        required:
                        - id
                        type: object
                      minItems: 1
                      type: array
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete multiple blocked email senders
      tags:
      - Email Security Settings
    get:
      operationId: email_security_list_blocked_senders
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: Page number of paginated results.
        in: query
        name: page
        schema:
          default: 1
          format: int32
          minimum: 1
          type: integer
      - description: Number of results to display.
        in: query
        name: per_page
        schema:
          default: 20
          format: int32
          minimum: 1
          type: integer
      - description: The field to sort by.
        in: query
        name: order
        schema:
          enum:
          - pattern
          - created_at
          type: string
      - description: The sorting direction.
        in: query
        name: direction
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_SortingDirection'
      - description: 'Allows searching in multiple properties of a record simultaneously.

          This parameter is intended for human users, not automation. Its exact

          behavior is intentionally left unspecified and is subject to change

          in the future.'
        in: query
        name: search
        schema:
          type: string
      - in: query
        name: pattern_type
        schema:
          allOf:
          - $ref: '#/components/schemas/email-security_PatternType'
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/email-security_BlockedSender'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: List of blocked senders for the provided account
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List blocked email senders
      tags:
      - Email Security Settings
    post:
      operationId: email_security_create_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/email-security_CreateBlockedSender'
              - items:
                  $ref: '#/components/schemas/email-security_CreateBlockedSender'
                type: array
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '201':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/email-security_BlockedSender'
                      - items:
                          $ref: '#/components/schemas/email-security_BlockedSender'
                        type: array
                  required:
                  - result
                  type: object
          description: Returns the newly created patterns in the same shape as the request body
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a blocked email sender
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/block_senders/{pattern_id}:
    delete:
      operationId: email_security_delete_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        id:
                          example: 2402
                          format: int32
                          title: identifier
                          type: integer
                      required:
                      - id
                      type: object
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a blocked email sender
      tags:
      - Email Security Settings
    get:
      operationId: email_security_get_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: block sender with email test@example.com
                          is_regex: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                        properties:
                          comments:
                            type:
                            - string
                            - 'null'
                          is_regex:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                        required:
                        - pattern
                        - is_regex
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: block sender with email test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2402
                        is_regex: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a blocked email sender
      tags:
      - Email Security Settings
    patch:
      operationId: email_security_update_blocked_sender
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: pattern_id
        required: true
        schema:
          example: 2402
          format: int32
          title: identifier
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                comments:
                  type:
                  - string
                  - 'null'
                is_regex:
                  type:
                  - boolean
                  - 'null'
                pattern:
                  minLength: 1
                  type:
                  - string
                  - 'null'
                pattern_type:
                  allOf:
                  - $ref: '#/components/schemas/email-security_PatternType'
                  - type:
                    - string
                    - 'null'
              type: object
        required: true
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - additionalProperties: false
                        example:
                          comments: block sender with email test@example.com
                          is_regex: false
                          pattern: test@example.com
                          pattern_type: EMAIL
                        properties:
                          comments:
                            type:
                            - string
                            - 'null'
                          is_regex:
                            type: boolean
                          pattern:
                            minLength: 1
                            type: string
                          pattern_type:
                            $ref: '#/components/schemas/email-security_PatternType'
                        required:
                        - pattern
                        - is_regex
                        - pattern_type
                        type: object
                      - properties:
                          created_at:
                            format: date-time
                            type: string
                          id:
                            example: 2402
                            format: int32
                            title: identifier
                            type: integer
                          last_modified:
                            format: date-time
                            type: string
                        required:
                        - id
                        - created_at
                        - last_modified
                        type: object
                      example:
                        comments: block sender with email test@example.com
                        created_at: '2023-11-14T22:13:20Z'
                        id: 2402
                        is_regex: false
                        last_modified: '2023-11-14T22:13:20Z'
                        pattern: test@example.com
                        pattern_type: EMAIL
                  required:
                  - result
                  type: object
          description: ''
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a blocked email sender
      tags:
      - Email Security Settings
  /accounts/{account_id}/email-security/settings/domains:
    delete:
      operationId: email_security_delete_domains
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  id:
                    description: Unique domain identifier
                    example: 24

# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-email-security-settings-api-openapi.yml