Options
All
  • Public
  • Public/Protected
  • All
Menu

Class APIKeys

API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

Hierarchy

  • APIKeys

Index

Constructors

Methods

Constructors

constructor

  • new APIKeys(httpClient: Wretcher): APIKeys

  • Do not construct this object directly, use the apiKeys property of an Ngrok client object instead.

    Parameters

    • httpClient: Wretcher

    Returns APIKeys

Methods

create

  • Create a new API key. The generated API key can be used to authenticate to the ngrok API.

    Parameters

    Returns Promise<APIKey>

delete

  • delete(id: any): Promise<void>

  • Delete an API key by ID

    Parameters

    • id: any

    Returns Promise<void>

get

  • get(id: any): Promise<APIKey>

  • Get the details of an API key by ID.

    Parameters

    • id: any

    Returns Promise<APIKey>

list

  • list(beforeId?: string, limit?: string): Promise<APIKey[]>

  • List all API keys owned by this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<APIKey[]>

update

Generated using TypeDoc