Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Path Parameters

id
string
required

Body

application/json
id
string

n/a

description
string

human-readable description of this backend. Optional

metadata
string

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

backends
string[]

the ids of the child backends in order

Response

Update Failover backend by ID

id
string

unique identifier for this Failover backend

uri
string

URI of the FailoverBackend API resource

created_at
string

timestamp when the backend was created, RFC 3339 format

description
string

human-readable description of this backend. Optional

metadata
string

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

backends
string[]

the ids of the child backends in order