Failover Backends
Create Failover Backend
Create a new Failover backend
Request
POST /backends/failover
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
backends | List<string> | the ids of the child backends in order |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
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 | List<string> | the ids of the child backends in order |
Delete Failover Backend
Delete a Failover backend by ID.
Request
DELETE /backends/failover/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Failover Backend
Get detailed information about a Failover backend by ID
Request
GET /backends/failover/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
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 | List<string> | the ids of the child backends in order |
List Failover Backends
List all Failover backends on this account
Request
GET /backends/failover
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
backends | FailoverBackend | the list of all Failover backends on this account |
uri | string | URI of the Failover backends list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
FailoverBackend fields
| Name | Type | Description |
|---|---|---|
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 | List<string> | the ids of the child backends in order |
Update Failover Backend
Update Failover backend by ID
Request
PATCH /backends/failover/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | |
description | string | human-readable description of this backend. Optional |
metadata | string | arbitrary user-defined machine-readable data of this backend. Optional |
backends | List<string> | the ids of the child backends in order |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
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 | List<string> | the ids of the child backends in order |