Sign in
FailoverBackends

Update

Update Failover backend by ID

patch/backends/failover/{id}

Path parameters

idstring required

Headers

ngrok-versioninteger required

Request body

idstring

n/a

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

Update Failover backend by ID

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 endpoint across all 9 revisions of this API.