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 Notification Mechanism Eligibility API

The Notification Mechanism Eligibility API from APIs.io Engineering Platform — 1 operation(s) for notification mechanism eligibility.

This API exposes 1 operation across 1 path, and defines 11 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.

1 operations 1 paths 11 schemas 1 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 Notification Mechanism Eligibility 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 1

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

Notification Mechanism Eligibility 1
GET
/accounts/{account_id}/alerting/v3/destinations/eligible
APIs.io Engineering Platform Get delivery mechanism eligibility
notification-mechanism-eligibility-get-delivery-mechanism-eligibility 1 param → 4XX200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are aaa_result_info (4 properties), aaa_api-response-common (3 properties), aaa_schemas-api-response-common-failure (3 properties), aaa_eligibility (3 properties). Each schema is shown below with its type and property counts.

aaa_api-response-common
object
3 properties 3 required
aaa_eligible
boolean
Determines whether or not the account is eligible for the delivery mechanism.
aaa_schemas-response_collection
aaa_api-response-collection
object
aaa_ready
boolean
Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.
aaa_messages
array
aaa_schemas-api-response-common-failure
object
3 properties 3 required
aaa_result_info
object
4 properties
aaa_account-id
string
The account id
aaa_schemas-type
string
Determines type of delivery mechanism.
aaa_eligibility
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-notification-mechanism-eligibility-api-openapi.yml Raw ↑