Tunnel Group Backends
Create Tunnel Group Backend
Create a new TunnelGroup backend
Request
POST /backends/tunnel_group
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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TunnelGroup backend |
uri | string | URI of the TunnelGroupBackend 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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
tunnels | Ref | tunnels matching this backend |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Delete Tunnel Group Backend
Delete a TunnelGroup backend by ID.
Request
DELETE /backends/tunnel_group/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Tunnel Group Backend
Get detailed information about a TunnelGroup backend by ID
Request
GET /backends/tunnel_group/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TunnelGroup backend |
uri | string | URI of the TunnelGroupBackend 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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
tunnels | Ref | tunnels matching this backend |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
List Tunnel Group Backends
List all TunnelGroup backends on this account
Request
GET /backends/tunnel_group
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
backends | TunnelGroupBackend | the list of all TunnelGroup backends on this account |
uri | string | URI of the TunnelGroup backends list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
TunnelGroupBackend fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TunnelGroup backend |
uri | string | URI of the TunnelGroupBackend 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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
tunnels | Ref | tunnels matching this backend |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Update Tunnel Group Backend
Update TunnelGroup backend by ID
Request
PATCH /backends/tunnel_group/{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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique identifier for this TunnelGroup backend |
uri | string | URI of the TunnelGroupBackend 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 |
labels | Map<string, string> | labels to watch for tunnels on, e.g. app->foo, dc->bar |
tunnels | Ref | tunnels matching this backend |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |