TCP Edges#

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

class ngrok.services.EdgesTCPClient(client)[source]#
create(description='', metadata='', hostports=None, backend=None, ip_restriction=None, traffic_policy=None)[source]#

Create a TCP Edge

Parameters:

  • description (str) – human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (str) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • hostports (Sequence[str]) – hostports served by this edge

  • backend (EndpointBackendMutate) – edge modules

  • ip_restriction (EndpointIPPolicyMutate) –

  • traffic_policy (EndpointTrafficPolicy) – the traffic policy associated with this edge or null

https://ngrok.com/docs/api#api-edges-tcp-create

Return type:

TCPEdge

delete(id)[source]#

Delete a TCP Edge by ID

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-edges-tcp-delete

get(id)[source]#

Get a TCP Edge by ID

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-edges-tcp-get

Return type:

TCPEdge

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

Returns a list of all TCP Edges on this account

Parameters:

  • before_id (str) –

  • limit (str) –

https://ngrok.com/docs/api#api-edges-tcp-list

Return type:

TCPEdgeList

update(id, description=None, metadata=None, hostports=None, backend=None, ip_restriction=None, traffic_policy=None)[source]#

Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

Parameters:

  • id (str) – unique identifier of this edge

  • description (str) – human-readable description of what this edge will be used for; optional, max 255 bytes.

  • metadata (str) – arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.

  • hostports (Sequence[str]) – hostports served by this edge

  • backend (EndpointBackendMutate) – edge modules

  • ip_restriction (EndpointIPPolicyMutate) –

  • traffic_policy (EndpointTrafficPolicy) – the traffic policy associated with this edge or null

https://ngrok.com/docs/api#api-edges-tcp-update

Return type:

TCPEdge