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 Routing Destination Addresses API

The Email Routing Destination Addresses API from APIs.io Engineering Platform — 2 operation(s) for email routing destination addresses.

This API exposes 4 operations across 2 paths, and defines 17 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.

4 operations 2 paths 17 schemas 1 DELETE2 GET1 POST

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 Routing Destination Addresses 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Email Routing Destination Addresses 4
GET
/accounts/{account_id}/email/routing/addresses
APIs.io Engineering Platform List destination addresses
email-routing-destination-addresses-list-destination-addresses 5 params → 200
POST
/accounts/{account_id}/email/routing/addresses
APIs.io Engineering Platform Create a destination address
email-routing-destination-addresses-create-a-destination-address 1 param body → 200
DELETE
/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}
APIs.io Engineering Platform Delete destination address
email-routing-destination-addresses-delete-destination-address 2 params → 200
GET
/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}
APIs.io Engineering Platform Get a destination address
email-routing-destination-addresses-get-a-destination-address 2 params → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are email_destination_address_properties (6 properties), email_result_info (4 properties), email_api-response-common (3 properties), email_create_destination_address_properties (1 property). Each schema is shown below with its type and property counts.

email_email
string
The contact email address of the user.
email_destination_address_tag
string
Destination address tag. (Deprecated, replaced by destination address identifier)
email_modified
string
The date and time the destination address was last modified.
email_created
string
The date and time the destination address has been created.
email_destination_address_identifier
string
Destination address identifier.
email_api-response-single
object
email_verified
string
The date and time the destination address has been verified. Null means not verified yet.
email_create_destination_address_properties
object
1 property 1 required
email_api-response-common
object
3 properties 3 required
email_destination_address_response_single
email_identifier
string
Identifier
email_addresses
object
email_destination_addresses_response_collection
email_destination_address_properties
object
6 properties
email_api-response-collection
object
email_messages
array
email_result_info
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-email-routing-destination-addresses-api-openapi.yml Raw ↑