openapi: 3.1.0
info:
  title: Ngrok Abuse Reports Event Destinations API
  description: The ngrok API provides programmatic access to all of ngrok's resources. The API is REST-ish. It follows most of the conventions of a REST API but diverges slightly when the REST model does not fit well. The API listens only on port 443 to help avoid any accidental unencrypted requests. All API access requires an API key.
  version: 2.0.0
  contact:
    name: Ngrok
    url: https://ngrok.com
  license:
    name: Proprietary
    url: https://ngrok.com/tos
servers:
- url: https://api.ngrok.com
  description: Ngrok API Production Server
security:
- bearerAuth: []
- apiKeyAuth: []
tags:
- name: Event Destinations
  description: Event Destinations define where event data is sent.
paths:
  /event_destinations:
    post:
      operationId: createEventDestination
      summary: Ngrok Create Event Destination
      description: Create a new Event Destination.
      tags:
      - Event Destinations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                format:
                  type: string
                  description: The output format, such as json or plain.
                target:
                  type: object
                  description: An object that encapsulates where and how to send event data.
                  properties:
                    firehose:
                      type: object
                    kinesis:
                      type: object
                    cloudwatch_logs:
                      type: object
                    datadog:
                      type: object
                    azure_logs_ingestion:
                      type: object
      responses:
        '201':
          description: Event destination created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventDestination'
    get:
      operationId: listEventDestinations
      summary: Ngrok List Event Destinations
      description: List all Event Destinations on this account.
      tags:
      - Event Destinations
      parameters:
      - $ref: '#/components/parameters/BeforeId'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of event destinations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventDestinationList'
  /event_destinations/{id}:
    get:
      operationId: getEventDestination
      summary: Ngrok Get Event Destination
      description: Get the details of an Event Destination by ID.
      tags:
      - Event Destinations
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Event destination details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventDestination'
    patch:
      operationId: updateEventDestination
      summary: Ngrok Update Event Destination
      description: Update attributes of an Event Destination by ID.
      tags:
      - Event Destinations
      parameters:
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                format:
                  type: string
                target:
                  type: object
      responses:
        '200':
          description: Event destination updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventDestination'
    delete:
      operationId: deleteEventDestination
      summary: Ngrok Delete Event Destination
      description: Delete an Event Destination by ID.
      tags:
      - Event Destinations
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Event destination deleted.
components:
  parameters:
    Id:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: A unique identifier for the resource.
    BeforeId:
      name: before_id
      in: query
      required: false
      schema:
        type: string
      description: An ID to use for pagination. Results returned will be before this ID.
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: string
      description: The maximum number of results to return. Maximum is 100.
  schemas:
    EventDestinationList:
      type: object
      properties:
        event_destinations:
          type: array
          items:
            $ref: '#/components/schemas/EventDestination'
        uri:
          type: string
        next_page_uri:
          type: string
    EventDestination:
      type: object
      properties:
        id:
          type: string
        metadata:
          type: string
        created_at:
          type: string
          format: date-time
        description:
          type: string
        format:
          type: string
        target:
          type: object
        uri:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use an ngrok API key as a Bearer token. Create API keys from the ngrok dashboard or via the API Keys endpoints.
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Pass the API key in the Authorization header prefixed with 'Bearer '.