FailoverBackends

Create

Create a new Failover backend

post/backends/failover

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/backends/failover
  • Auth
    HTTP bearer

Headers

ngrok-versioninteger required

Request body

descriptionstring

human-readable description of this backend. Optional

metadatastring

arbitrary user-defined machine-readable data of this backend. Optional

backendsstring[]

the ids of the child backends in order

Response

Create a new Failover backend

idstring

unique identifier for this Failover backend

uristring

URI of the FailoverBackend API resource

created_atstring

timestamp when the backend was created, RFC 3339 format

descriptionstring

human-readable description of this backend. Optional

metadatastring

arbitrary user-defined machine-readable data of this backend. Optional

backendsstring[]

the ids of the child backends in order

Changes

No recorded changes to this operation across all 10 revisions of this API.