Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Email Security API

The Email Security API from APIs.io Engineering Platform — 7 operation(s) for email security.

This API exposes 7 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

7 operations 7 paths 16 schemas 7 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Email Security API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.

Email Security 7
GET
/accounts/{account_id}/email-security/investigate
APIs.io Engineering Platform Search email messages
email_security_investigate 16 params → 4XX200
GET
/accounts/{account_id}/email-security/investigate/{postfix_id}
APIs.io Engineering Platform Get message details
email_security_get_message 2 params → 4XX200
GET
/accounts/{account_id}/email-security/investigate/{postfix_id}/detections
APIs.io Engineering Platform Get message detection details
email_security_get_message_detections 2 params → 4XX200
GET
/accounts/{account_id}/email-security/investigate/{postfix_id}/preview
APIs.io Engineering Platform Get email preview
email_security_get_message_preview 2 params → 4XX200
GET
/accounts/{account_id}/email-security/investigate/{postfix_id}/raw
APIs.io Engineering Platform Get raw email content
email_security_get_message_raw 2 params → 4XX200
GET
/accounts/{account_id}/email-security/investigate/{postfix_id}/trace
APIs.io Engineering Platform Get email trace
email_security_get_message_trace 2 params → 4XX200
GET
/accounts/{account_id}/email-security/phishguard/reports
APIs.io Engineering Platform Get PhishGuard reports
email_security_get_phishguard_reports 3 params → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are email-security_PhishGuardReport (8 properties), email-security_Attachment (5 properties), email-security_ResultInfo (4 properties), email-security_ThreatCategory (3 properties). Each schema is shown below with its type and property counts.

email-security_MessageDeliveryMode
string
email-security_MessageHeader
object
2 properties 2 required
email-security_Message
object
2 properties 2 required
email-security_ThreatCategory
object
3 properties 1 required
email-security_MailsearchMessage
email-security_AccountId
string
Account Identifier
email-security_ValidationStatus
string
email-security_PostfixId
string
Message identifier
email-security_ResultInfo
object
4 properties 4 required
email-security_TraceLine
object
3 properties 3 required
email-security_Link
object
2 properties 1 required
email-security_PhishGuardReportTag
object
2 properties 2 required
email-security_PhishGuardReport
object
8 properties 7 required
email-security_ApiResponseCommon
object
3 properties 3 required
email-security_Attachment
object
5 properties 1 required
email-security_DispositionLabel
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-email-security-api-openapi.yml Raw ↑