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

The Notification Policies API from APIs.io Engineering Platform — 2 operation(s) for notification policies.

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

5 operations 2 paths 21 schemas 1 DELETE2 GET1 POST1 PUT

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 Policies 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 5

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

Notification Policies 5
GET
/accounts/{account_id}/alerting/v3/policies
APIs.io Engineering Platform List Notification policies
notification-policies-list-notification-policies 1 param → 4XX200
POST
/accounts/{account_id}/alerting/v3/policies
APIs.io Engineering Platform Create a Notification policy
notification-policies-create-a-notification-policy 1 param body → 4XX200
DELETE
/accounts/{account_id}/alerting/v3/policies/{policy_id}
APIs.io Engineering Platform Delete a Notification policy
notification-policies-delete-a-notification-policy 2 params → 4XX200
GET
/accounts/{account_id}/alerting/v3/policies/{policy_id}
APIs.io Engineering Platform Get a Notification policy
notification-policies-get-a-notification-policy 2 params → 4XX200
PUT
/accounts/{account_id}/alerting/v3/policies/{policy_id}
APIs.io Engineering Platform Update a Notification policy
notification-policies-update-a-notification-policy 2 params body → 4XX200

Schemas 21

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

aaa_id_response
aaa_alert_interval
string
Optional specification of how often to re-alert from the same incident, not support on all alert types.
aaa_policy-id
string
The unique identifier of a notification policy
aaa_schemas-name
string
Name of the policy.
aaa_api-response-single
object
aaa_uuid
string
UUID
aaa_result_info
object
4 properties
aaa_schemas-description
string
Optional description for the Notification policy.
aaa_api-response-common
object
3 properties 3 required
aaa_alert_type
string
Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible v…
aaa_timestamp
string
aaa_policies_components-schemas-response_collection
aaa_schemas-api-response-common-failure
object
3 properties 3 required
aaa_enabled
boolean
Whether or not the Notification policy is enabled.
aaa_account-id
string
The account id
aaa_filters
object
Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert ty…
41 properties
aaa_mechanisms
object
List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
aaa_api-response-collection
object
aaa_single_response
aaa_messages
array
aaa_policies
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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