Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FailoverBackends

A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.

Hierarchy

  • FailoverBackends

Index

Constructors

Methods

Constructors

constructor

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

    Parameters

    • httpClient: Wretcher

    Returns FailoverBackends

Methods

create

delete

  • delete(id: any): Promise<void>
  • Delete a Failover backend by ID.

    Parameters

    • id: any

    Returns Promise<void>

get

list

  • List all Failover backends on this account

    Parameters

    • Optional beforeId: string
    • Optional limit: string

    Returns Promise<FailoverBackend[]>

update

Generated using TypeDoc