Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Credentials

Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ngrok config add-authtoken command or by specifying it in the ngrok.yml configuration file with the authtoken property.

Hierarchy

  • Credentials

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns Credentials

Methods

create

  • Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.

    Parameters

    Returns Promise<Credential>

delete

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

  • Delete a tunnel authtoken credential by ID

    Parameters

    • id: any

    Returns Promise<void>

get

  • Get detailed information about a tunnel authtoken credential

    Parameters

    • id: any

    Returns Promise<Credential>

list

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

  • List all tunnel authtoken credentials on this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<Credential[]>

update

Generated using TypeDoc