openapi: 3.1.0
info:
  title: Ngrok Abuse Reports Edges HTTPS 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: Edges HTTPS
  description: HTTPS Edges define HTTPS endpoints with routes and modules.
paths:
  /edges/https:
    post:
      operationId: createHttpsEdge
      summary: Ngrok Create HTTPS Edge
      description: Create an HTTPS Edge.
      tags:
      - Edges HTTPS
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                hostports:
                  type: array
                  items:
                    type: string
                  description: Hostports served by this edge.
      responses:
        '201':
          description: HTTPS edge created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    get:
      operationId: listHttpsEdges
      summary: Ngrok List HTTPS Edges
      description: List all HTTPS Edges on this account.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/BeforeId'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of HTTPS edges.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdgeList'
  /edges/https/{id}:
    get:
      operationId: getHttpsEdge
      summary: Ngrok Get HTTPS Edge
      description: Get an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: HTTPS edge details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    patch:
      operationId: updateHttpsEdge
      summary: Ngrok Update HTTPS Edge
      description: Update an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                hostports:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: HTTPS edge updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpsEdge'
    delete:
      operationId: deleteHttpsEdge
      summary: Ngrok Delete HTTPS Edge
      description: Delete an HTTPS Edge by ID.
      tags:
      - Edges HTTPS
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: HTTPS edge 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:
    HttpsEdge:
      type: object
      properties:
        id:
          type: string
        description:
          type: string
        metadata:
          type: string
        created_at:
          type: string
          format: date-time
        uri:
          type: string
        hostports:
          type: array
          items:
            type: string
        routes:
          type: array
          items:
            type: object
    HttpsEdgeList:
      type: object
      properties:
        https_edges:
          type: array
          items:
            $ref: '#/components/schemas/HttpsEdge'
        uri:
          type: string
        next_page_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 '.