{
  "opencollection": "1.0.0",
  "info": {
    "name": "APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Email Security API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Email Security",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "APIs.io Engineering Platform Search email messages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "start",
                "value": "2022-07-25T14:30:00Z",
                "type": "query",
                "description": "The beginning of the search date range.\nDefaults to `now - 30 days`."
              },
              {
                "name": "end",
                "value": "2022-06-25T14:30:00Z",
                "type": "query",
                "description": "The end of the search date range.\nDefaults to `now`."
              },
              {
                "name": "query",
                "value": "bob jones",
                "type": "query",
                "description": "Space delimited query term(s).\nThe search is case-insensitive.\n\nThe content of the following email metadata fields are searched:\n* alert_id\n* CC\n* From (envelope_from)\n* From Name\n* final_disposition\n* md5 hash (of any attachment)\n* sha1 hash (of any attachment)\n* sha256 hash (of any attachment)\n* name (of any attachment)\n* Reason\n* Received DateTime (yyyy-mm-ddThh:mm:ss)\n* Sent DateTime (yyyy-mm-ddThh:mm:ss)\n* ReplyTo\n* To (envelope_to)\n* To Name\n* Message-ID\n* smtp_helo_server_ip\n* smtp_previous_hop_ip\n* x_originating_ip\n* Subject"
              },
              {
                "name": "detections_only",
                "value": "",
                "type": "query",
                "description": "If `false`, the search includes non-detections."
              },
              {
                "name": "action_log",
                "value": "",
                "type": "query",
                "description": "Controls whether the message action log in included in the response."
              },
              {
                "name": "final_disposition",
                "value": "",
                "type": "query",
                "description": "Filter messages by the provided disposition."
              },
              {
                "name": "metric",
                "value": "",
                "type": "query"
              },
              {
                "name": "message_action",
                "value": "",
                "type": "query",
                "description": "Filter messages by actions applied to them"
              },
              {
                "name": "recipient",
                "value": "me@example.com",
                "type": "query"
              },
              {
                "name": "sender",
                "value": "noreply@example.com",
                "type": "query"
              },
              {
                "name": "alert_id",
                "value": "4Njp3P0STMz2c02Q-2022-12-30T02:44:49",
                "type": "query"
              },
              {
                "name": "domain",
                "value": "example.com",
                "type": "query",
                "description": "Filter by the sender domain"
              },
              {
                "name": "message_id",
                "value": "<4VAZPrAdg7IGNxdt1DWRNu0gvOeL_iZiwP4BQfo4DaE.Yw-woXuugQbeFhBpzwFQtqq_v2v1HOKznoMBqbciQpE@example.com>",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number of paginated results."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results to display."
              }
            ]
          },
          "docs": "This endpoint returns information for each email that matches the search parameter(s)."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get message details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate/:postfix_id",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "postfix_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "APIs.io Engineering Platform Get message details"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get message detection details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate/:postfix_id/detections",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "postfix_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "For emails that have a detection, this endpoint returns detection details\nsuch as threat categories, sender information, and links."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get email preview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate/:postfix_id/preview",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "postfix_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "For emails that have a detection, this endpoint returns a preview of the\nmessage body as a base64 encoded PNG image."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get raw email content",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate/:postfix_id/raw",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "postfix_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "For emails that have a detection, this endpoint returns the raw email\nas an EML file."
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get email trace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/investigate/:postfix_id/trace",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "postfix_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "APIs.io Engineering Platform Get email trace"
        },
        {
          "info": {
            "name": "APIs.io Engineering Platform Get PhishGuard reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://apigateway.{region}.amazonaws.com/accounts/:account_id/email-security/phishguard/reports",
            "params": [
              {
                "name": "account_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "from_date",
                "value": "2020-08-01",
                "type": "query"
              },
              {
                "name": "to_date",
                "value": "2020-09-01",
                "type": "query"
              }
            ]
          },
          "docs": "APIs.io Engineering Platform Get PhishGuard reports"
        }
      ]
    }
  ],
  "bundled": true
}