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 Destinations with PagerDuty API

The Notification Destinations with PagerDuty API from APIs.io Engineering Platform — 3 operation(s) for notification destinations with pagerduty.

This API exposes 4 operations across 3 paths, and defines 15 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.

4 operations 3 paths 15 schemas 1 DELETE2 GET1 POST

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 Destinations with PagerDuty 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 4

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

Notification Destinations with PagerDuty 4
DELETE
/accounts/{account_id}/alerting/v3/destinations/pagerduty
APIs.io Engineering Platform Delete PagerDuty Services
notification-destinations-with-pager-duty-delete-pager-duty-services 1 param → 4XX200
GET
/accounts/{account_id}/alerting/v3/destinations/pagerduty
APIs.io Engineering Platform List PagerDuty services
notification-destinations-with-pager-duty-list-pager-duty-services 1 param → 4XX200
POST
/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect
APIs.io Engineering Platform Create PagerDuty integration token
notification-destinations-with-pager-duty-connect-pager-duty 1 param → 4XX201
GET
/accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}
APIs.io Engineering Platform Connect PagerDuty
notification-destinations-with-pager-duty-connect-pager-duty-token 2 params → 4XX200

Schemas 15

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

aaa_api-response-common
object
3 properties 3 required
aaa_uuid
string
UUID
aaa_id_response
aaa_components-schemas-response_collection
aaa_integration-token
string
The token integration key
aaa_pagerduty
object
2 properties
aaa_sensitive_id_response
aaa_token
string
token in form of UUID
aaa_messages
array
aaa_api-response-single
object
aaa_name
string
The name of the pagerduty service.
aaa_schemas-api-response-common-failure
object
3 properties 3 required
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-destinations-with-pagerduty-api-openapi.yml Raw ↑