Options
All
  • Public
  • Public/Protected
  • All
Menu

SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.

Hierarchy

  • SSHCredentials

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns SSHCredentials

Methods

create

  • Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

    Parameters

    Returns Promise<SSHCredential>

delete

  • delete(arg: Item): Promise<void>
  • Delete an ssh_credential by ID

    Parameters

    Returns Promise<void>

get

  • Get detailed information about an ssh_credential

    Parameters

    Returns Promise<SSHCredential>

list

  • List all ssh credentials on this account

    Returns Promise<SSHCredential[]>

update

Generated using TypeDoc