openapi: 3.0.0
info:
  version: 2015-07-09
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Email Security API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Email Security
paths:
  /accounts/{account_id}/email-security/investigate:
    get:
      description: This endpoint returns information for each email that matches the search parameter(s).
      operationId: email_security_investigate
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - description: 'The beginning of the search date range.

          Defaults to `now - 30 days`.'
        example: '2022-07-25T14:30:00Z'
        in: query
        name: start
        schema:
          format: date-time
          type: string
      - description: 'The end of the search date range.

          Defaults to `now`.'
        example: '2022-06-25T14:30:00Z'
        in: query
        name: end
        schema:
          format: date-time
          type: string
      - description: 'Space delimited query term(s).

          The search is case-insensitive.


          The content of the following email metadata fields are searched:

          * alert_id

          * CC

          * From (envelope_from)

          * From Name

          * final_disposition

          * md5 hash (of any attachment)

          * sha1 hash (of any attachment)

          * sha256 hash (of any attachment)

          * name (of any attachment)

          * Reason

          * Received DateTime (yyyy-mm-ddThh:mm:ss)

          * Sent DateTime (yyyy-mm-ddThh:mm:ss)

          * ReplyTo

          * To (envelope_to)

          * To Name

          * Message-ID

          * smtp_helo_server_ip

          * smtp_previous_hop_ip

          * x_originating_ip

          * Subject'
        example: bob jones
        in: query
        name: query
        schema:
          type: string
      - description: If `false`, the search includes non-detections.
        in: query
        name: detections_only
        schema:
          default: true
          type: boolean
      - description: Controls whether the message action log in included in the response.
        in: query
        name: action_log
        schema:
          default: true
          type: boolean
      - description: Filter messages by the provided disposition.
        in: query
        name: final_disposition
        schema:
          allOf:
          - enum:
            - MALICIOUS
            - SUSPICIOUS
            - SPOOF
            - SPAM
            - BULK
            type: string
      - in: query
        name: metric
        schema:
          type: string
      - description: Filter messages by actions applied to them
        in: query
        name: message_action
        schema:
          allOf:
          - enum:
            - PREVIEW
            - QUARANTINE_RELEASED
            - MOVED
            type: string
      - example: me@example.com
        in: query
        name: recipient
        schema:
          type: string
      - example: noreply@example.com
        in: query
        name: sender
        schema:
          type: string
      - example: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
        in: query
        name: alert_id
        schema:
          type: string
      - description: Filter by the sender domain
        example: example.com
        in: query
        name: domain
        schema:
          type: string
      - example: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
        in: query
        name: message_id
        schema:
          type: string
      - 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
      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_MailsearchMessage'
                      type: array
                    result_info:
                      $ref: '#/components/schemas/email-security_ResultInfo'
                  required:
                  - result
                  - result_info
                  type: object
          description: Search results for the provided query
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Search email messages
      tags:
      - Email Security
      x-api-token-group:
      - 'Cloud Email Security: Write'
      - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}:
    get:
      operationId: email_security_get_message
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: postfix_id
        required: true
        schema:
          description: Message identifier
          example: 4Njp3P0STMz2c02Q
          title: postfix_id
          type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      allOf:
                      - properties:
                          action_log: {}
                          alert_id:
                            nullable: true
                            type: string
                          client_recipients:
                            items:
                              type: string
                            type: array
                          delivery_mode:
                            allOf:
                            - $ref: '#/components/schemas/email-security_MessageDeliveryMode'
                            - nullable: true
                              type: string
                          detection_reasons:
                            items:
                              type: string
                            type: array
                          edf_hash:
                            nullable: true
                            type: string
                          final_disposition:
                            allOf:
                            - $ref: '#/components/schemas/email-security_DispositionLabel'
                            - nullable: true
                              type: string
                          from:
                            nullable: true
                            type: string
                          from_name:
                            nullable: true
                            type: string
                          is_phish_submission:
                            type: boolean
                          is_quarantined:
                            type: boolean
                          message_id:
                            type: string
                          postfix_id:
                            $ref: '#/components/schemas/email-security_PostfixId'
                          sent_date:
                            nullable: true
                            type: string
                          subject:
                            nullable: true
                            type: string
                          threat_categories:
                            items:
                              type: string
                            nullable: true
                            type: array
                          to:
                            items:
                              type: string
                            nullable: true
                            type: array
                          to_name:
                            items:
                              type: string
                            nullable: true
                            type: array
                          ts:
                            type: string
                          validation:
                            allOf:
                            - properties:
                                comment:
                                  nullable: true
                                  type: string
                                dkim:
                                  allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                                dmarc:
                                  allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                                spf:
                                  allOf:
                                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                                  - nullable: true
                                    type: string
                              type: object
                            - nullable: true
                              type: object
                        required:
                        - ts
                        - message_id
                        - client_recipients
                        - postfix_id
                        - detection_reasons
                        - action_log
                        - is_quarantined
                        - is_phish_submission
                        type: object
                      - properties:
                          id:
                            type: string
                        required:
                        - id
                        type: object
                      example:
                        action_log: []
                        alert_id: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
                        client_recipients:
                        - email@example.com
                        delivery_mode: DIRECT
                        detection_reasons:
                        - 'Selector is a source of spam/uce : Smtp-Helo-Server-Ip=<b>127.0.0[dot]186</b>'
                        edf_hash: null
                        final_disposition: MALICIOUS
                        from: d1994@example.com
                        from_name: Sender Name
                        id: 47JJcT1w6GztQV7-email@example.com
                        is_phish_submission: false
                        is_quarantined: false
                        message_id: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
                        postfix_id: 47JJcT1w6GztQV7
                        sent_date: 2019-11-21 00:22:01
                        subject: listen, I highly recommend u to read that email, just to ensure not a thing will take place
                        threat_categories:
                        - IPReputation
                        - ASNReputation
                        to:
                        - email@example.com
                        to_name:
                        - Recipient Name
                        ts: 2019-11-20 23:22:01
                        validation:
                          comment: null
                          dkim: pass
                          dmarc: none
                          spf: fail
                  required:
                  - result
                  type: object
          description: Email message details
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get message details
      tags:
      - Email Security
  /accounts/{account_id}/email-security/investigate/{postfix_id}/detections:
    get:
      description: 'For emails that have a detection, this endpoint returns detection details

        such as threat categories, sender information, and links.'
      operationId: email_security_get_message_detections
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: postfix_id
        required: true
        schema:
          description: Message identifier
          example: 4Njp3P0STMz2c02Q
          title: postfix_id
          type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      example:
                        action: QUARANTINED
                        attachments: []
                        final_disposition: MALICIOUS
                        headers:
                        - name: From
                          value: Sender Name <d1994@example.com>
                        - name: Subject
                          value: listen, I highly recommend u to read that email, just to ensure not a thing will take place
                        links:
                        - href: https://example.com
                          text: Click here!
                        sender_info:
                          as_name: AS0
                          as_number: 0
                          geo: US/-/-
                          ip: 127.0.0.1
                          pld: example.com
                        threat_categories:
                        - description: null
                          id: 1234
                          name: IP Reputation
                        validation:
                          comment: null
                          dkim: pass
                          dmarc: none
                          spf: fail
                      properties:
                        action:
                          type: string
                        attachments:
                          items:
                            $ref: '#/components/schemas/email-security_Attachment'
                          type: array
                        final_disposition:
                          allOf:
                          - $ref: '#/components/schemas/email-security_DispositionLabel'
                          - nullable: true
                            type: string
                        headers:
                          items:
                            $ref: '#/components/schemas/email-security_MessageHeader'
                          type: array
                        links:
                          items:
                            $ref: '#/components/schemas/email-security_Link'
                          type: array
                        sender_info:
                          properties:
                            as_name:
                              description: Name of the autonomous system
                              nullable: true
                              type: string
                            as_number:
                              description: Number of the autonomous system
                              format: int64
                              nullable: true
                              type: integer
                            geo:
                              nullable: true
                              type: string
                            ip:
                              nullable: true
                              type: string
                            pld:
                              nullable: true
                              type: string
                          type: object
                        threat_categories:
                          items:
                            $ref: '#/components/schemas/email-security_ThreatCategory'
                          type: array
                        validation:
                          properties:
                            comment:
                              nullable: true
                              type: string
                            dkim:
                              allOf:
                              - $ref: '#/components/schemas/email-security_ValidationStatus'
                              - nullable: true
                                type: string
                            dmarc:
                              allOf:
                              - $ref: '#/components/schemas/email-security_ValidationStatus'
                              - nullable: true
                                type: string
                            spf:
                              allOf:
                              - $ref: '#/components/schemas/email-security_ValidationStatus'
                              - nullable: true
                                type: string
                          type: object
                      required:
                      - validation
                      - headers
                      - threat_categories
                      - sender_info
                      - links
                      - action
                      - attachments
                      type: object
                  required:
                  - result
                  type: object
          description: Email detection details
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get message detection details
      tags:
      - Email Security
  /accounts/{account_id}/email-security/investigate/{postfix_id}/preview:
    get:
      description: 'For emails that have a detection, this endpoint returns a preview of the

        message body as a base64 encoded PNG image.'
      operationId: email_security_get_message_preview
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: postfix_id
        required: true
        schema:
          description: Message identifier
          example: 4Njp3P0STMz2c02Q
          title: postfix_id
          type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      example:
                        screenshot: iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAYAAADimHc4AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABgAAAAAQAAAGAAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAAGCgAwAEAAAAAQAAAGAAAAAAtVTeigAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAACXtJREFUeAHtmwtwXFUZgP9zX7t3b7LNa9M2tGmLDbaWKpL6aBBJHdERQWGkU4u8CraVWmYQYWQUMSoKhZJikYo4Qqc6RVqkKmNHC0K1FGYoM9pqS4FAa9s0aTavfd3d+zq/527YSNvdzWY3m2ySc2c2595z/vOf///+e+4959wTAH5wApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwAhOJABmvzuCz158HXmUp2rCEOlhGbEdFh2qASFAgtiCKMUGgh8FM7IDDp3aQlt12Kfo6rgKAz3ylAQ3rJ/Fg39XYfyx32wUJpJpZ7wiq8LPebuGJaXfuipVKMHJ3YowsRgQC265aE+/quYf2/Le2YDM85aBOn/m7GDHX+m/4W0/B+gpUUNIBwN98rknvif4J+9urC/Tz7OqKBp66+vWSUf9dsvpx62yB0ckpyQDgLxtlS5iyyTx59OuATlFJkOrZYV9l7afItdv/XdSGMigvuQBEHmyqJRLug9DJ+gw2j3y2qIDWcOEPyFef/tHIK8+usaQCEGpdPFd0rEMQC8rZzS5OqXr+JU+JV2+5pjja02sV0mePfm7/I5+eIznm22MF3/U4/p+/L3d23LhxNL0viR7Qs/ETfo/lnIBIsHw0nU/bFiGgLbp0BfnirzanLR/hzJLoAV6QXywJ+C5cNu6N7d/7JD6zat4Is06rbswDENvU/A3sPd6Y1rqxyjRjkDj1zp7RaH5MA3CkpdkL0fAvRsPR4bbhBNtqcNvS7w233nDlxzQAgUp7E+pjPhnNyEw/duRefJLdJEU8pGLo7mptnuuTSJNHkeaBIPhMK/6Gbjm7A7ftfTPV3sGWBQpEu1ekrksxxWgQoLr6Tmbbj4tl34iOgmIbPnsLG8w9hKETajqDiX86sCXJe/1a4D4QEnfF2t/6fjq5UsojFTNQu21v0Z4UIxKA4LqL6nwyfQ3DJ8/JBR7x1wGIEmDfsVzEx1xGO3f+xeT6v7xcDEMKjmystXmRSkPtucJ3nWCy4wZ+0l7wfLsY8F2dBQWg46cfDaDVtw+MSLHsKwm98VDky8UypKAA+BVpF8T7i2Vb6eg1IiPyqE7nUN6joL51jUsw2nVBOqUTLc9TGfi965O++dLlomZvBSICyBoQpdyQVP8R4hFfgAQ+Spb8/PBwfc87AGWadrcR7x5ue+NS3qK2OxQFpcq72jGi7CXGvlGYYUAz7LGi7e6Shftba/x5ma1UB9ZDL2khlz1iuHWGOvJ+BJl65DNDKZ8I5UL17E515a4jri+OEbsoq096l2QeP3iXaR5N4MurH8SWliH5DimQqUHUezMVTah8tVx7wHUIdy6/gv3N7YlhRcHseOsOc9HBKL54S9Z1rrwCcLxlQdWEopzJGfbdGG7Y+XAyABK9MZNYxvx4t2r2vv067l55ayaZvAJgQ0zPpHAi5StT52xjnwfQ9cnWI9kfP5kcZ+8LM9i2EXfffE86kbwCMBuOmiCnXW1I18a4zCO+KuiVrZtSxqMVn5o6zyc1g+/+EF+47uYz6+Y8vg0/vPhygQjLRFH5JLXNWgx3+oGW5GazM33M61o+Z96VnpV//WOqsrF9SbInpK7zStnwVdDqmuQvbHk1VT9rAI63Lq6qJnQTNfRlkAin6kz4VKit/5ZvzZ7ksz/lrPmHy6KsF7CXQoGHp1JXOmoqUnuRMj6CEq0ff6Ay2tVDQ52TB77INmME6lecCd9FLlfUPFUg+oHqRp+Pzk08mtJ1Vg/oallQVlZR/i/a3/GBlNBkSIWqGW2iR7vCs3pX2tksvtQi2frBU1TvLnwEKChgls2ZWv75x7pOC4C7O8GbMNvYGD8wGaAD27QrT2s4KsrON6UVz+8cymd8fZUPYvLzZk9bEzjmUOJZy5VAw29J8+PXnRaAWGvjIQx3z89aM89CEmhwRMUXQVGRmOMC+x5AWOr+2NIKSwl7Ggoish8lRKDsSxplTVnuTwTU2aZzQwCMszehxXYu2AIhCQDKpvvERAImUGIK7jXSePJHWWpRHWw7wQYLcaDolplA0GLnukWddvmmpw+khpnDcQvfXF8DAlkKhnkhmEY52IYKlqGiZWho2z5KDYWtEPtpondGRr3eKlDKFsqDAQhvaLxfCHV/J2OFQgpkL2g152mw6rl4Pg4X0nSx6iL7PwQ4tF0GpXOAYchDIdIxMFIKHkRQKz2m8W4nWzcqz2SDUvfhS5KVO+9vXFhm9B5gd0gm2YLzhepze8G2goiCA6J7dxN31y0bxxKbBcUdz9psJ3ryjgc2d2Gb0m0KaDGTbHbHs/7Ozh1IUGC5wHoDEsthZQjUrWMTBMtheQSphQJYyFKB9Q6Kznup24Mck3Uvk1IITaP73iAtTFkeB+6/oxao8jHWA2ex3lVLEQPEtmqpZVewfxKpQjOmYLx/OpjR6mzqlfqFTyQDEHrogufESN/l2YQnXBmLuhyY+YpBjS/5177WM5R/+I9bA+Cl66ye0DUYbfcMJZ9LuVgz/wQJbrh4uho+wb4R5nUz5NJOact4/WznQ8VHylbuOZDJUNx97Vazu2P5SDMi5bNAKpetpfZkhe8SdyeYEfUVdlZ2ZgBwx5UVjoL7zWB7/ZllI3GNiW425vDVrBkJZeNaR/iUFnns4g+93wd89qpqC+Jtjh4uCvxkW1YMBDNhfvD9DU/Wc0VwBoff+FKz5JDwPrTNrC/Rglm5/zyIkVMF65kICmyHzRPeO5w+2Ow4dE7qumgpmwsIk2JXQw4E43H9n65Y75am8x2HfC2HKgWLEG+1I4BU1L2nBRs5GgrcLZM1t+9vd9vy+jx3j0abbhuypu0TSNnkWPbJBpWtV/w6VS6gsDR1XvQU6Vapa4qkJvrVaRTEMFvAsB2drcewQ/Q5BNj0JOSjA1NtljdFFwY/Srgzlwp1QNaVTx1inNU77dV12gU4qjSoI1XHictn5dla71l5KfnBdIjXl1U2oNcMKTh9SgfaPazthoHaXjswuBQ/8/ZX4ymdHVFHU+tmimoo4Ul4JBmdBFt5khDVBJtbS1junvt0REtO/tx6RLaSjIg+kKZ0oclktCibx//fP0HzCIIlCwnPFLn2+LHJsa8nBYSnnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACnAAnwAlwApwAJ8AJcAKcACfACXACk4DA/wDoepVZ2hARhAAAAABJRU5ErkJggg==
                      properties:
                        screenshot:
                          description: Base64 encoded PNG image
                          type: string
                      required:
                      - screenshot
                      type: object
                  required:
                  - result
                  type: object
          description: Email preview
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get email preview
      tags:
      - Email Security
      x-api-token-group:
      - 'Cloud Email Security: Write'
      - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}/raw:
    get:
      description: 'For emails that have a detection, this endpoint returns the raw email

        as an EML file.'
      operationId: email_security_get_message_raw
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: postfix_id
        required: true
        schema:
          description: Message identifier
          example: 4Njp3P0STMz2c02Q
          title: postfix_id
          type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      example:
                        raw: 'MIME-Version: 1.0

                          Content-Type: text/plain; charset="utf-8"


                          From: sender@example.com

                          To: recipient@example.com

                          Subject: Test Email


                          This is a test email.'
                      properties:
                        raw:
                          description: UTF-8 encoded eml file
                          type: string
                      required:
                      - raw
                      type: object
                  required:
                  - result
                  type: object
          description: Raw email content
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get raw email content
      tags:
      - Email Security
      x-api-token-group:
      - 'Cloud Email Security: Write'
      - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/investigate/{postfix_id}/trace:
    get:
      operationId: email_security_get_message_trace
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - in: path
        name: postfix_id
        required: true
        schema:
          description: Message identifier
          example: 4Njp3P0STMz2c02Q
          title: postfix_id
          type: string
      responses:
        4XX:
          $ref: '#/components/responses/email-security_ClientError'
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-security_ApiResponseCommon'
                - properties:
                    result:
                      properties:
                        inbound:
                          properties:
                            lines:
                              items:
                                $ref: '#/components/schemas/email-security_TraceLine'
                              nullable: true
                              type: array
                          type: object
                        outbound:
                          properties:
                            lines:
                              items:
                                $ref: '#/components/schemas/email-security_TraceLine'
                              nullable: true
                              type: array
                          type: object
                      required:
                      - inbound
                      - outbound
                      type: object
                  required:
                  - result
                  type: object
          description: Email trace
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get email trace
      tags:
      - Email Security
      x-api-token-group:
      - 'Cloud Email Security: Write'
      - 'Cloud Email Security: Read'
  /accounts/{account_id}/email-security/phishguard/reports:
    get:
      operationId: email_security_get_phishguard_reports
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/email-security_AccountId'
      - example: '2020-08-01'
        in: query
        name: from_date
        required: true
        schema:
          format: date
          type: string
      - example: '2020-09-01'
        in: query
        name: to_date
        required: true
        schema:
          format: date
          type: string
      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_PhishGuardReport'
                      type: array
                  required:
                  - result
                  type: object
          description: PhishGuard reports
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get PhishGuard reports
      tags:
      - Email Security
components:
  schemas:
    email-security_MessageDeliveryMode:
      enum:
      - DIRECT
      - BCC
      - JOURNAL
      - REVIEW_SUBMISSION
      - DMARC_UNVERIFIED
      - DMARC_FAILURE_REPORT
      - DMARC_AGGREGATE_REPORT
      - THREAT_INTEL_SUBMISSION
      - SIMULATION_SUBMISSION
      - API
      - RETRO_SCAN
      type: string
    email-security_MessageHeader:
      properties:
        name:
          type: string
        value:
          type: string
      required:
      - name
      - value
      type: object
    email-security_Message:
      properties:
        code:
          format: int32
          minimum: 1000
          type: integer
        message:
          type: string
      required:
      - code
      - message
      type: object
    email-security_ThreatCategory:
      properties:
        description:
          nullable: true
          type: string
        id:
          format: int64
          type: integer
        name:
          nullable: true
          type: string
      required:
      - id
      type: object
    email-security_MailsearchMessage:
      allOf:
      - properties:
          action_log: {}
          alert_id:
            nullable: true
            type: string
          client_recipients:
            items:
              type: string
            type: array
          delivery_mode:
            allOf:
            - $ref: '#/components/schemas/email-security_MessageDeliveryMode'
            - nullable: true
              type: string
          detection_reasons:
            items:
              type: string
            type: array
          edf_hash:
            nullable: true
            type: string
          final_disposition:
            allOf:
            - $ref: '#/components/schemas/email-security_DispositionLabel'
            - nullable: true
              type: string
          from:
            nullable: true
            type: string
          from_name:
            nullable: true
            type: string
          is_phish_submission:
            type: boolean
          is_quarantined:
            type: boolean
          message_id:
            type: string
          postfix_id:
            $ref: '#/components/schemas/email-security_PostfixId'
          sent_date:
            nullable: true
            type: string
          subject:
            nullable: true
            type: string
          threat_categories:
            items:
              type: string
            nullable: true
            type: array
          to:
            items:
              type: string
            nullable: true
            type: array
          to_name:
            items:
              type: string
            nullable: true
            type: array
          ts:
            type: string
          validation:
            allOf:
            - properties:
                comment:
                  nullable: true
                  type: string
                dkim:
                  allOf:
                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                  - nullable: true
                    type: string
                dmarc:
                  allOf:
                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                  - nullable: true
                    type: string
                spf:
                  allOf:
                  - $ref: '#/components/schemas/email-security_ValidationStatus'
                  - nullable: true
                    type: string
              type: object
            - nullable: true
              type: object
        required:
        - ts
        - message_id
        - client_recipients
        - postfix_id
        - detection_reasons
        - action_log
        - is_quarantined
        - is_phish_submission
        type: object
      - properties:
          id:
            type: string
        required:
        - id
        type: object
      example:
        action_log: []
        alert_id: 4Njp3P0STMz2c02Q-2022-12-30T02:44:49
        client_recipients:
        - email@example.com
        delivery_mode: DIRECT
        detection_reasons:
        - 'Selector is a source of spam/uce : Smtp-Helo-Server-Ip=<b>127.0.0[dot]186</b>'
        edf_hash: null
        final_disposition: MALICIOUS
        from: d1994@example.com
        from_name: Sender Name
        id: 47JJcT1w6GztQV7-email@example.com
        is_phish_submission: false
        is_quarantined: false
        message_id: <4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>
        postfix_id: 47JJcT1w6GztQV7
        sent_date: 2019-11-21 00:22:01
        subject: listen, I highly recommend u to read that email, just to ensure not a thing will take place
        threat_categories:
        - IPReputation
        - ASNReputation
        to:
        - email@example.com
        to_name:
        - Recipient Name
        ts: 2019-11-20 23:22:01
        validation:
          comment: null
          dkim: pass
          dmarc: none
          spf: fail
    email-security_AccountId:
      description: Account Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      minLength: 32
      readOnly: true
      title: account_id
      type: string
    email-security_ValidationStatus:
      enum:
      - pass
      - neutral
      - fail
      - error
      - none
      type: string
    email-security_PostfixId:
      description: Message identifier
      example: 4Njp3P0STMz2c02Q
      title: postfix_id
      type: string
    email-security_ResultInfo:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          format: int32
          type: integer
        page:
          description: Current page within paginated list of results
          example: 1
          format: int32
          type: integer
        per_page:
          description: Number of results per page of results
          example: 20
          format: int32
          type: integer
        total_count:
          description: Total results available without any search parameters
          example: 2000
          format: int32
          type: integer
      required:
      - count
      - page
      - per_page
      - total_count
      type: object
    email-security_TraceLine:
      properties:
        lineno:
          format: int64
          type: integer
        message:
          type: string
        ts:
          format: date-time
          type: string
      required:
      - ts
      - lineno
      - message
      type: object
    email-security_Link:
      properties:
        href:
          type: string
        text:
          nullable: true
          type: string
      required:
      - href
      type: object
    email-security_PhishGuardReportTag:
      properties:
        category:
          type: string
        value:
          type: string
      required:
      - category
      - value
      type: object
    email-security_PhishGuardReport:
      properties:
        content:
          type: string
        disposition:
          $ref: '#/components/schemas/email-security_DispositionLabel'
        fields:
          properties:
            from:
              nullable: true
              type: string
            postfix_id:
              type: string
            to:
              items:
                type: string
              type: array
            ts:
              format: date-time
              type: string
          required:
          - to
          - ts
          - postfix_id
          type: object
        id:
          format: int32
          type: integer
        priority:
          type: string
        tags:
          items:
            $ref: '#/components/schemas/email-security_PhishGuardReportTag'
          nullable: true
          type: array
        title:
          type: string
        ts:
          format: date-time
          type: string
      required:
      - id
      - ts
      - title
      - content
      - fields
      - priority
      - disposition
      type: object
    email-security_ApiResponseCommon:
      properties:
        errors:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        messages:
          example: []
          items:
            $ref: '#/components/schemas/email-security_Message'
          type: array
        success:
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    email-security_Attachment:
      properties:
        content_type:
          nullable: true
          type: string
        detection:
          allOf:
          - $ref: '#/components/schemas/email-security_DispositionLabel'
          - nullable: true
            type: string
        encrypted:
          nullable: true
          type: boolean
        name:
          nullable: true
          type: string
        size:
          minimum: 0
          type: integer
      required:
      - size
      type: object
    email-security_DispositionLabel:
      enum:
      - MALICIOUS
      - MALICIOUS-BEC
      - SUSPICIOUS
      - SPOOF
      - SPAM
      - BULK
      - ENCRYPTED
      - EXTERNAL
      - UNKNOWN
      - NONE
      type: string
  responses:
    email-security_ClientError:
      content:
        application/json:
          schema:
            properties:
              errors:
                example:
                - code: 7003
                  message: No route for the URI
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              messages:
                example: []
                items:
                  $ref: '#/components/schemas/email-security_Message'
                type: array
              result:
                nullable: true
                type: object
              success:
                example: false
                type: boolean
            required:
            - result
            - success
            - errors
            - messages
            type: object
      description: Client Error
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true