Static Backends#

Do not construct this object directly, instead access the static_backends property of an ngrok.Client object.

class ngrok.services.StaticBackendsClient(client)[source]#

A static backend sends traffic to a TCP address (hostname and port) that is reachable on the public internet.

create(description='', metadata='', address='', tls=None)[source]#

Create a new static backend

Parameters:

  • description (str) – human-readable description of this backend. Optional

  • metadata (str) – arbitrary user-defined machine-readable data of this backend. Optional

  • address (str) – the address to forward to

  • tls (StaticBackendTLS) – tls configuration to use

https://ngrok.com/docs/api#api-static-backends-create

Return type:

StaticBackend

delete(id)[source]#

Delete a static backend by ID.

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-static-backends-delete

get(id)[source]#

Get detailed information about a static backend by ID

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-static-backends-get

Return type:

StaticBackend

list(before_id=None, limit=None)[source]#

List all static backends on this account

Parameters:

  • before_id (str) –

  • limit (str) –

https://ngrok.com/docs/api#api-static-backends-list

Return type:

StaticBackendList

update(id, description=None, metadata=None, address='', tls=None)[source]#

Update static backend by ID

Parameters:

  • id (str) –

  • description (str) – human-readable description of this backend. Optional

  • metadata (str) – arbitrary user-defined machine-readable data of this backend. Optional

  • address (str) – the address to forward to

  • tls (StaticBackendTLS) – tls configuration to use

https://ngrok.com/docs/api#api-static-backends-update

Return type:

StaticBackend