APIs.io Engineering Platform Notification Policies 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 Policies 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 Policies
paths:
  /accounts/{account_id}/alerting/v3/policies:
    get:
      description: Get a list of all Notification policies.
      operationId: notification-policies-list-notification-policies
      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_policies_components-schemas-response_collection'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: List Notification policies response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_policies_components-schemas-response_collection'
          description: List Notification policies response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Notification policies
      tags:
      - Notification Policies
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
    post:
      description: Creates a new Notification policy.
      operationId: notification-policies-create-a-notification-policy
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                alert_interval:
                  $ref: '#/components/schemas/aaa_alert_interval'
                alert_type:
                  $ref: '#/components/schemas/aaa_alert_type'
                description:
                  $ref: '#/components/schemas/aaa_schemas-description'
                enabled:
                  $ref: '#/components/schemas/aaa_enabled'
                filters:
                  $ref: '#/components/schemas/aaa_filters'
                mechanisms:
                  $ref: '#/components/schemas/aaa_mechanisms'
                name:
                  $ref: '#/components/schemas/aaa_schemas-name'
              required:
              - name
              - alert_type
              - enabled
              - mechanisms
        required: true
      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 Create a Notification policy
      tags:
      - Notification Policies
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
  /accounts/{account_id}/alerting/v3/policies/{policy_id}:
    delete:
      description: Delete a Notification policy.
      operationId: notification-policies-delete-a-notification-policy
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      - in: path
        name: policy_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_policy-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 a Notification policy response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_api-response-collection'
          description: Delete a Notification policy response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a Notification policy
      tags:
      - Notification Policies
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
    get:
      description: Get details for a single policy.
      operationId: notification-policies-get-a-notification-policy
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      - in: path
        name: policy_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_policy-id'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_single_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Get a Notification policy response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_single_response'
          description: Get a Notification policy response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get a Notification policy
      tags:
      - Notification Policies
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Notifications Write
      - Notifications Read
      - Account Settings Write
      - Account Settings Read
    put:
      description: Update a Notification policy.
      operationId: notification-policies-update-a-notification-policy
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_account-id'
      - in: path
        name: policy_id
        required: true
        schema:
          $ref: '#/components/schemas/aaa_policy-id'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                alert_interval:
                  $ref: '#/components/schemas/aaa_alert_interval'
                alert_type:
                  $ref: '#/components/schemas/aaa_alert_type'
                description:
                  $ref: '#/components/schemas/aaa_schemas-description'
                enabled:
                  $ref: '#/components/schemas/aaa_enabled'
                filters:
                  $ref: '#/components/schemas/aaa_filters'
                mechanisms:
                  $ref: '#/components/schemas/aaa_mechanisms'
                name:
                  $ref: '#/components/schemas/aaa_schemas-name'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aaa_id_response'
                - $ref: '#/components/schemas/aaa_schemas-api-response-common-failure'
          description: Update a Notification policy response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aaa_id_response'
          description: Update a Notification policy response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a Notification policy
      tags:
      - Notification Policies
      x-api-token-group:
      - Notifications Write
      - Account Settings Write
components:
  schemas:
    aaa_id_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/aaa_uuid'
            type: object
    aaa_alert_interval:
      description: Optional specification of how often to re-alert from the same incident, not support on all alert types.
      example: 30m
      type: string
    aaa_policy-id:
      description: The unique identifier of a notification policy
      example: 0da2b59e-f118-439d-8097-bdfb215203c9
      maxLength: 36
      readOnly: true
      type: string
    aaa_schemas-name:
      description: Name of the policy.
      example: SSL Notification Event Policy
      type: string
    aaa_api-response-single:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-common'
      type: object
    aaa_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      readOnly: true
      type: string
      x-auditable: true
    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_schemas-description:
      description: Optional description for the Notification policy.
      example: Something describing the policy.
      type: string
    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_alert_type:
      description: 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 values.
      enum:
      - access_custom_certificate_expiration_type
      - advanced_ddos_attack_l4_alert
      - advanced_ddos_attack_l7_alert
      - advanced_http_alert_error
      - bgp_hijack_notification
      - billing_usage_alert
      - block_notification_block_removed
      - block_notification_new_block
      - block_notification_review_rejected
      - brand_protection_alert
      - brand_protection_digest
      - clickhouse_alert_fw_anomaly
      - clickhouse_alert_fw_ent_anomaly
      - cloudforce_one_request_notification
      - custom_analytics
      - custom_ssl_certificate_event_type
      - dedicated_ssl_certificate_event_type
      - device_connectivity_anomaly_alert
      - dos_attack_l4
      - dos_attack_l7
      - expiring_service_token_alert
      - failing_logpush_job_disabled_alert
      - fbm_auto_advertisement
      - fbm_dosd_attack
      - fbm_volumetric_attack
      - health_check_status_notification
      - hostname_aop_custom_certificate_expiration_type
      - http_alert_edge_error
      - http_alert_origin_error
      - incident_alert
      - image_notification
      - load_balancing_health_alert
      - load_balancing_pool_enablement_alert
      - logo_match_alert
      - magic_tunnel_health_check_event
      - magic_wan_tunnel_health
      - maintenance_event_notification
      - mtls_certificate_store_certificate_expiration_type
      - pages_event_alert
      - radar_notification
      - real_origin_monitoring
      - scriptmonitor_alert_new_code_change_detections
      - scriptmonitor_alert_new_hosts
      - scriptmonitor_alert_new_malicious_hosts
      - scriptmonitor_alert_new_malicious_scripts
      - scriptmonitor_alert_new_malicious_url
      - scriptmonitor_alert_new_max_length_resource_url
      - scriptmonitor_alert_new_resources
      - secondary_dns_all_primaries_failing
      - secondary_dns_primaries_failing
      - secondary_dns_warning
      - secondary_dns_zone_successfully_updated
      - secondary_dns_zone_validation_warning
      - sentinel_alert
      - stream_live_notifications
      - synthetic_test_latency_alert
      - synthetic_test_low_availability_alert
      - traffic_anomalies_alert
      - tunnel_health_event
      - tunnel_update_event
      - universal_ssl_event_type
      - web_analytics_metrics_update
      - zone_aop_custom_certificate_expiration_type
      example: universal_ssl_event_type
      type: string
    aaa_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      readOnly: true
      type: string
    aaa_policies_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/aaa_policies'
            type: array
    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_enabled:
      default: true
      description: Whether or not the Notification policy is enabled.
      example: true
      type: boolean
    aaa_account-id:
      description: The account id
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    aaa_filters:
      description: 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 types. See alert type documentation for more details.
      example:
        slo:
        - '99.9'
      properties:
        actions:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        affected_asns:
          description: Used for configuring radar_notification
          items:
            type: string
          type: array
        affected_components:
          description: Used for configuring incident_alert
          example: 4c231tkdlpcl
          items:
            type: string
          type: array
        affected_locations:
          description: Used for configuring radar_notification
          items:
            type: string
          type: array
        airport_code:
          description: Used for configuring maintenance_event_notification
          items:
            type: string
          type: array
        alert_trigger_preferences:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        alert_trigger_preferences_value:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        enabled:
          description: Used for configuring load_balancing_pool_enablement_alert
          items:
            minItems: 1
            type: string
          type: array
        environment:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        event:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        event_source:
          description: Used for configuring load_balancing_health_alert
          items:
            type: string
          type: array
        event_type:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        group_by:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        health_check_id:
          description: Used for configuring health_check_status_notification
          items:
            type: string
          type: array
        incident_impact:
          description: Used for configuring incident_alert
          items:
            enum:
            - INCIDENT_IMPACT_NONE
            - INCIDENT_IMPACT_MINOR
            - INCIDENT_IMPACT_MAJOR
            - INCIDENT_IMPACT_CRITICAL
            type: string
          type: array
        input_id:
          description: Used for configuring stream_live_notifications
          items:
            type: string
          type: array
        limit:
          description: Used for configuring billing_usage_alert
          items:
            minItems: 1
            type: string
          type: array
        logo_tag:
          description: Used for configuring logo_match_alert
          items:
            type: string
          type: array
        megabits_per_second:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        new_health:
          description: Used for configuring load_balancing_health_alert
          items:
            type: string
          type: array
        new_status:
          description: Used for configuring tunnel_health_event
          items:
            type: string
          type: array
        packets_per_second:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        pool_id:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        pop_name:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        product:
          description: Used for configuring billing_usage_alert
          items:
            minItems: 1
            type: string
          type: array
        project_id:
          description: Used for configuring pages_event_alert
          items:
            minItems: 1
            type: string
          type: array
        protocol:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        query_tag:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        requests_per_second:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        selectors:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        services:
          description: Used for configuring clickhouse_alert_fw_ent_anomaly
          items:
            minItems: 1
            type: string
          type: array
        slo:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        status:
          description: Used for configuring health_check_status_notification
          items:
            minItems: 1
            type: string
          type: array
        target_hostname:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        target_ip:
          description: Used for configuring advanced_ddos_attack_l4_alert
          items:
            type: string
          type: array
        target_zone_name:
          description: Used for configuring advanced_ddos_attack_l7_alert
          items:
            type: string
          type: array
        traffic_exclusions:
          description: Used for configuring traffic_anomalies_alert
          items:
            enum:
            - security_events
            maxItems: 1
            type: string
          type: array
        tunnel_id:
          description: Used for configuring tunnel_health_event
          items:
            type: string
          type: array
        tunnel_name:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        where:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
        zones:
          description: Usage depends on specific alert type
          items:
            type: string
          type: array
      type: object
    aaa_mechanisms:
      additionalProperties:
        items:
          properties:
            id:
              oneOf:
              - $ref: '#/components/schemas/aaa_uuid'
              - description: The email address
                type: string
          type: object
        type: array
      description: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
      example:
        email:
        - id: test@example.com
        pagerduty:
        - id: e8133a15-00a4-4d69-aec1-32f70c51f6e5
        webhooks:
        - id: 14cc1190-5d2b-4b98-a696-c424cb2ad05f
      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_single_response:
      allOf:
      - $ref: '#/components/schemas/aaa_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/aaa_policies'
    aaa_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    aaa_policies:
      properties:
        alert_interval:
          $ref: '#/components/schemas/aaa_alert_interval'
        alert_type:
          $ref: '#/components/schemas/aaa_alert_type'
        created:
          $ref: '#/components/schemas/aaa_timestamp'
        description:
          $ref: '#/components/schemas/aaa_schemas-description'
        enabled:
          $ref: '#/components/schemas/aaa_enabled'
        filters:
          $ref: '#/components/schemas/aaa_filters'
        id:
          $ref: '#/components/schemas/aaa_policy-id'
        mechanisms:
          $ref: '#/components/schemas/aaa_mechanisms'
        modified:
          $ref: '#/components/schemas/aaa_timestamp'
        name:
          $ref: '#/components/schemas/aaa_schemas-name'
      type: object
  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