APIs.io Engineering Platform Notification Destinations with PagerDuty API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Notification Destinations with PagerDuty API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Notification Destinations with PagerDuty
paths:
  /accounts/{account_id}/alerting/v3/destinations/pagerduty:
    delete:
      description: Deletes all the PagerDuty Services connected to the account.
      operationId: notification-destinations-with-pager-duty-delete-pager-duty-services
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_api-response-collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Delete PagerDuty Services response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete PagerDuty Services response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete PagerDuty Services
      tags:
      - Notification Destinations with PagerDuty
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
    get:
      description: Get a list of all configured PagerDuty services.
      operationId: notification-destinations-with-pager-duty-list-pager-duty-services
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_components-schemas-response_collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List PagerDuty services response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_components-schemas-response_collection'
          description: List PagerDuty services response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List PagerDuty services
      tags:
      - Notification Destinations with PagerDuty
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect:
    post:
      description: Creates a new token for integrating with PagerDuty.
      operationId: notification-destinations-with-pager-duty-connect-pager-duty
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_id_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a token for PagerDuty integration failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_sensitive_id_response'
          description: Token for PagerDuty integration
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create PagerDuty integration token
      tags:
      - Notification Destinations with PagerDuty
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
  /accounts/{account_id}/alerting/v3/destinations/pagerduty/connect/{token_id}:
    get:
      description: Links PagerDuty with the account using the integration token.
      operationId: notification-destinations-with-pager-duty-connect-pager-duty-token
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      - in: path
        name: token_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_integration-token'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_id_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Create a Notification policy response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Create a Notification policy response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Connect PagerDuty
      tags:
      - Notification Destinations with PagerDuty
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
components:
  schemas:
    aaa_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/aaa_messages'
        messages:
          $ref: '#/components/schemas/aaa_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
      x-auditable: true
    aaa_id_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/aaa_uuid'
            type: object
    aaa_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/aaa_pagerduty'
            type: array
    aaa_integration-token:
      description: The token integration key
      example: 8c71e667571b4f61b94d9e4b12158038
      maxLength: 32
      readOnly: true
      type: string
    aaa_pagerduty:
      properties:
        id:
          $ref: '#/components/schemas/aaa_uuid'
        name:
          $ref: '#/components/schemas/aaa_name'
      type: object
    aaa_sensitive_id_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/aaa_token'
            type: object
    aaa_token:
      description: token in form of UUID
      example: a313ba7d-3e46-4c0e-a408-08fafbc3816a
      maxLength: 36
      readOnly: true
      type: string
    aaa_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    aaa_api-response-single:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      type: object
    aaa_name:
      description: The name of the pagerduty service.
      example: My PagerDuty Service
      type: string
    aaa_schemas-api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/aaa_messages'
          example: []
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    aaa_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    aaa_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/aaa_result_info'
      type: object
    aaa_account-id:
      description: The account id
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true