Weighted Backends
Create Weighted Backend
Create a new Weighted backend
Request
POST /backends/weighted
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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this Weighted backend |
uri | string | URI of the WeightedBackend 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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |
Delete Weighted Backend
Delete a Weighted backend by ID.
Request
DELETE /backends/weighted/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Weighted Backend
Get detailed information about a Weighted backend by ID
Request
GET /backends/weighted/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this Weighted backend |
uri | string | URI of the WeightedBackend 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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |
List Weighted Backends
List all Weighted backends on this account
Request
GET /backends/weighted
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
backends | WeightedBackend | the list of all Weighted backends on this account |
uri | string | URI of the Weighted backends list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
WeightedBackend fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this Weighted backend |
uri | string | URI of the WeightedBackend 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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |
Update Weighted Backend
Update Weighted backend by ID
Request
PATCH /backends/weighted/{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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this Weighted backend |
uri | string | URI of the WeightedBackend 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 | Map<string, int64> | the ids of the child backends to their weights [0-10000] |