Static Backends
Create Static Backend
Create a new static backend
Request
POST /backends/static
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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this static backend |
uri | string | URI of the StaticBackend 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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |
Delete Static Backend
Delete a static backend by ID.
Request
DELETE /backends/static/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Static Backend
Get detailed information about a static backend by ID
Request
GET /backends/static/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this static backend |
uri | string | URI of the StaticBackend 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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |
List Static Backends
List all static backends on this account
Request
GET /backends/static
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
backends | StaticBackend | the list of all static backends on this account |
uri | string | URI of the static backends list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
StaticBackend fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this static backend |
uri | string | URI of the StaticBackend 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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |
Update Static Backend
Update static backend by ID
Request
PATCH /backends/static/{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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this static backend |
uri | string | URI of the StaticBackend 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 |
address | string | the address to forward to |
tls | StaticBackendTLS | tls configuration to use |
StaticBackendTLS fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | if TLS is checked |