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 History API

The Notification History API from APIs.io Engineering Platform — 1 operation(s) for notification history.

This API exposes 1 operation across 1 path, and defines 19 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 19 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 History 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 History 1
GET
/accounts/{account_id}/alerting/v3/history
APIs.io Engineering Platform List History
notification-history-list-history 5 params → 4XX200

Schemas 19

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

aaa_alert_body
string
Message body included in the notification sent.
aaa_history_components-schemas-response_collection
aaa_mechanism
string
The mechanism to which the notification has been dispatched.
aaa_policy-id
string
The unique identifier of a notification policy
aaa_schemas-name
string
Name of the policy.
aaa_history
object
9 properties
aaa_result_info
object
4 properties
aaa_uuid
string
UUID
aaa_api-response-common
object
3 properties 3 required
aaa_schemas-alert_type
string
Type of notification that has been dispatched.
aaa_before
string
Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.
aaa_schemas-api-response-common-failure
object
3 properties 3 required
aaa_account-id
string
The account id
aaa_per_page
number
Number of items per page.
aaa_api-response-collection
object
aaa_sent
string
Timestamp of when the notification was dispatched in ISO 8601 format.
aaa_components-schemas-description
string
Description of the notification policy (if present).
aaa_messages
array
aaa_mechanism_type
string
The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-notification-history-api-openapi.yml Raw ↑