How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.

APIs.io Engineering Platform Notification Policies API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification Policies. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

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.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Notification Policies API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

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_single_response
aaa_policy-id
string
The unique identifier of a notification policy
aaa_schemas-description
string
Optional description for the Notification policy.
aaa_api-response-collection
object
aaa_messages
array
aaa_policies
object
10 properties
aaa_enabled
boolean
Whether or not the Notification policy is enabled.
aaa_uuid
string
UUID
aaa_timestamp
string
aaa_schemas-name
string
Name of the policy.
aaa_alert_interval
string
Optional specification of how often to re-alert from the same incident, not support on all alert types.
aaa_schemas-api-response-common-failure
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_account-id
string
The account id
aaa_api-response-common
object
3 properties 3 required
aaa_id_response
aaa_policies_components-schemas-response_collection
aaa_result_info
object
4 properties
aaa_api-response-single
object
aaa_mechanisms
object
List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Notification Policies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.