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 Alert Types API

The Notification Alert Types API from APIs.io Engineering Platform — 1 operation(s) for notification alert types.

This API exposes 1 operation across 1 path, and defines 12 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 12 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 Alert Types 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 Alert Types 1
GET
/accounts/{account_id}/alerting/v3/available_alerts
APIs.io Engineering Platform Get Alert Types
notification-alert-types-get-alert-types 1 param → 4XX200

Schemas 12

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

aaa_api-response-common
object
3 properties 3 required
aaa_alert-types
object
4 properties
aaa_type
string
Use this value when creating and updating a notification policy.
aaa_response_collection
aaa_description
string
Describes the alert type.
aaa_filter_options
array
Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.
aaa_messages
array
aaa_schemas-api-response-common-failure
object
3 properties 3 required
aaa_display_name
string
Alert type name.
aaa_result_info
object
4 properties
aaa_api-response-collection
object
aaa_account-id
string
The account id

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-notification-alert-types-api-openapi.yml Raw ↑