Class SSHCredentials

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

Hierarchy

SSHCredentials

Index

Constructors

constructor

Methods

Constructors

constructor

new SSHCredentials(httpClient: Wretcher): SSHCredentials

- Defined in services.ts:3499
Do not construct this object directly, use the sshCredentials property of an Ngrok client object instead.

Parameters
- httpClient: Wretcher
Returns SSHCredentials

Methods

create

create(arg: SSHCredentialCreate): Promise<SSHCredential>

- Defined in services.ts:3505
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
- arg: SSHCredentialCreate
Returns Promise<SSHCredential>

delete

delete(id: any): Promise<void>

- Defined in services.ts:3517
Delete an ssh_credential by ID

Parameters
- id: any
Returns Promise<void>

get

get(id: any): Promise<SSHCredential>

- Defined in services.ts:3527
Get detailed information about an ssh_credential

Parameters
- id: any
Returns Promise<SSHCredential>

list

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

- Defined in services.ts:3537
List all ssh credentials on this account

Parameters
- Optional beforeId: string
- Optional limit: string
Returns Promise<SSHCredential[]>

update

update(arg: SSHCredentialUpdate): Promise<SSHCredential>

- Defined in services.ts:3587
Update attributes of an ssh_credential by ID

Parameters
- arg: SSHCredentialUpdate
Returns Promise<SSHCredential>

Generated using TypeDoc