openapi: 3.1.0
info:
  title: Ngrok Abuse Reports Credentials 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: Credentials
  description: Tunnel Credentials are authtokens used to start ngrok tunnels.
paths:
  /credentials:
    post:
      operationId: createCredential
      summary: Ngrok Create Credential
      description: Create a new tunnel authtoken credential.
      tags:
      - Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                acl:
                  type: array
                  items:
                    type: string
                  description: Access control list of IP CIDRs.
                owner_id:
                  type: string
      responses:
        '201':
          description: Credential created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
    get:
      operationId: listCredentials
      summary: Ngrok List Credentials
      description: List all tunnel authtoken credentials on this account.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/BeforeId'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: List of credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialList'
  /credentials/{id}:
    get:
      operationId: getCredential
      summary: Ngrok Get Credential
      description: Get the details of a tunnel authtoken credential by ID.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '200':
          description: Credential details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
    patch:
      operationId: updateCredential
      summary: Ngrok Update Credential
      description: Update attributes of a tunnel authtoken credential by ID.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/Id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                metadata:
                  type: string
                acl:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Credential updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
    delete:
      operationId: deleteCredential
      summary: Ngrok Delete Credential
      description: Delete a tunnel authtoken credential by ID.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/Id'
      responses:
        '204':
          description: Credential 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:
    Credential:
      type: object
      properties:
        id:
          type: string
        uri:
          type: string
        created_at:
          type: string
          format: date-time
        description:
          type: string
        metadata:
          type: string
        token:
          type: string
          description: Only present in create response.
        acl:
          type: array
          items:
            type: string
        owner_id:
          type: string
    CredentialList:
      type: object
      properties:
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/Credential'
        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 '.