APIs.io Engineering Platform Email Security Settings API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 28 operations across 10 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.

28 operations 10 paths 16 schemas 10 DELETE9 GET5 PATCH4 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

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Email Security Settings 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 28

Across 10 paths, the API surfaces 28 operations — 10 DELETE, 9 GET, 5 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Email Security Settings 28

DELETE

/accounts/{account_id}/email-security/settings/allow_patterns

APIs.io Engineering Platform Delete multiple email allow patterns

email_security_delete_allow_patterns 1 param body → 4XX200

GET

/accounts/{account_id}/email-security/settings/allow_patterns

APIs.io Engineering Platform List email allow patterns

email_security_list_allow_patterns 11 params → 4XX200

POST

/accounts/{account_id}/email-security/settings/allow_patterns

APIs.io Engineering Platform Create an email allow pattern

email_security_create_allow_pattern 1 param body → 4XX201

DELETE

/accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}

APIs.io Engineering Platform Delete an email allow pattern

email_security_delete_allow_pattern 2 params → 4XX200

GET

/accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}

APIs.io Engineering Platform Get an email allow pattern

email_security_get_allow_pattern 2 params → 4XX200

PATCH

/accounts/{account_id}/email-security/settings/allow_patterns/{pattern_id}

APIs.io Engineering Platform Update an email allow pattern

email_security_update_allow_pattern 2 params body → 4XX200

DELETE

/accounts/{account_id}/email-security/settings/block_senders

APIs.io Engineering Platform Delete multiple blocked email senders

email_security_delete_blocked_senders 1 param body → 4XX200

GET

/accounts/{account_id}/email-security/settings/block_senders

APIs.io Engineering Platform List blocked email senders

email_security_list_blocked_senders 7 params → 4XX200

POST

/accounts/{account_id}/email-security/settings/block_senders

APIs.io Engineering Platform Create a blocked email sender

email_security_create_blocked_sender 1 param body → 4XX201

DELETE

/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

APIs.io Engineering Platform Delete a blocked email sender

email_security_delete_blocked_sender 2 params → 4XX200

GET

/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

APIs.io Engineering Platform Get a blocked email sender

email_security_get_blocked_sender 2 params → 4XX200

PATCH

/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

APIs.io Engineering Platform Update a blocked email sender

email_security_update_blocked_sender 2 params body → 4XX200

DELETE

/accounts/{account_id}/email-security/settings/domains

APIs.io Engineering Platform Unprotect multiple email domains

email_security_delete_domains 1 param body → 4XX200

GET

/accounts/{account_id}/email-security/settings/domains

APIs.io Engineering Platform List protected email domains

email_security_list_domains 8 params → 4XX200

DELETE

/accounts/{account_id}/email-security/settings/domains/{domain_id}

APIs.io Engineering Platform Unprotect an email domain

email_security_delete_domain 2 params → 4XX200

PATCH

/accounts/{account_id}/email-security/settings/domains/{domain_id}

APIs.io Engineering Platform Update an email domain

email_security_update_domain 2 params body → 4XX200

DELETE

/accounts/{account_id}/email-security/settings/impersonation_registry

APIs.io Engineering Platform Delete multiple entries from impersonation registry

email_security_delete_display_names 1 param body → 4XX200

GET

/accounts/{account_id}/email-security/settings/impersonation_registry

APIs.io Engineering Platform List entries in impersonation registry

email_security_list_display_names 7 params → 4XX200

POST

/accounts/{account_id}/email-security/settings/impersonation_registry

APIs.io Engineering Platform Create an entry in impersonation registry

email_security_create_display_name 1 param body → 4XX201

DELETE

/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

APIs.io Engineering Platform Delete an entry from impersonation registry

email_security_delete_display_name 2 params → 4XX200

GET

/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

APIs.io Engineering Platform Get an entry in impersonation registry

email_security_get_display_name 2 params → 4XX200

PATCH

/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

APIs.io Engineering Platform Update an entry in impersonation registry

email_security_update_display_name 2 params body → 4XX200

DELETE

/accounts/{account_id}/email-security/settings/trusted_domains

APIs.io Engineering Platform Delete multiple trusted email domains

email_security_delete_trusted_domains 1 param body → 4XX200

GET

/accounts/{account_id}/email-security/settings/trusted_domains

APIs.io Engineering Platform List trusted email domains

email_security_list_trusted_domains 8 params → 4XX200

POST

/accounts/{account_id}/email-security/settings/trusted_domains

APIs.io Engineering Platform Create a trusted email domain

email_security_create_trusted_domain 1 param body → 4XX201

DELETE

/accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}

APIs.io Engineering Platform Delete a trusted email domain

email_security_delete_trusted_domain 2 params → 4XX200

GET

/accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}

APIs.io Engineering Platform Get a trusted email domain

email_security_get_trusted_domain 2 params → 4XX200

PATCH

/accounts/{account_id}/email-security/settings/trusted_domains/{pattern_id}

APIs.io Engineering Platform Update a trusted email domain

email_security_update_trusted_domain 2 params body → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are email-security_DisplayName (10 properties), email-security_CreateAllowPattern (8 properties), email-security_Domain (8 properties), email-security_CreateTrustedDomain (5 properties). Each schema is shown below with its type and property counts.

email-security_DisplayName

object

10 properties 5 required

email-security_CreateAllowPattern

object

8 properties 7 required

email-security_Message

object

2 properties 2 required

email-security_AccountId

string

Account Identifier

email-security_CreateDisplayName

object

3 properties 3 required

email-security_CreateTrustedDomain

object

5 properties 4 required

email-security_CreateBlockedSender

object

4 properties 3 required

email-security_PatternType

string

email-security_ResultInfo

object

4 properties 4 required

email-security_SortingDirection

string

email-security_DeliveryMode

string

email-security_ApiResponseCommon

object

3 properties 3 required

email-security_TrustedDomain

email-security_AllowPattern

email-security_BlockedSender

email-security_Domain

object

8 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Email Security Settings

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Email Security Settings API

Metadata

Authentication & Security 1

Paths & Operations 28

Schemas 16

Specification

Source

API Details

Provider

Explore more