Tunnel Group Backends¶
Do not construct this object directly, instead access the
tunnel_group_backends
property of an ngrok.Client
object.
-
class
ngrok.services.
TunnelGroupBackendsClient
(client)[source]¶ A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
-
create
(description='', metadata='', labels={})[source]¶ Create a new TunnelGroup backend
- Parameters
description (
str
) – human-readable description of this backend. Optionalmetadata (
str
) – arbitrary user-defined machine-readable data of this backend. Optionallabels (
Mapping
[str
,str
]) – labels to watch for tunnels on, e.g. app->foo, dc->bar
https://ngrok.com/docs/api#api-tunnel-group-backends-create
- Return type
-
get
(id)[source]¶ Get detailed information about a TunnelGroup backend by ID
- Parameters
id (
str
) – a resource identifier
https://ngrok.com/docs/api#api-tunnel-group-backends-get
- Return type
-
list
(before_id=None, limit=None)[source]¶ List all TunnelGroup backends on this account
- Parameters
before_id (
Optional
[str
]) –limit (
Optional
[str
]) –
https://ngrok.com/docs/api#api-tunnel-group-backends-list
- Return type
-
update
(id, description=None, metadata=None, labels={})[source]¶ Update TunnelGroup backend by ID
- Parameters
id (
str
) –description (
Optional
[str
]) – human-readable description of this backend. Optionalmetadata (
Optional
[str
]) – arbitrary user-defined machine-readable data of this backend. Optionallabels (
Mapping
[str
,str
]) – labels to watch for tunnels on, e.g. app->foo, dc->bar
https://ngrok.com/docs/api#api-tunnel-group-backends-update
- Return type
-