TLS Edges#
Do not construct this object directly, instead access the
edges_tls
property of an ngrok.Client
object.
- class ngrok.services.EdgesTLSClient(client)[source]#
- create(description='', metadata='', hostports=None, backend=None, ip_restriction=None, mutual_tls=None, tls_termination=None, traffic_policy=None)[source]#
Create a TLS 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 edgebackend (
EndpointBackendMutate
) – edge modulesip_restriction (
EndpointIPPolicyMutate
) –mutual_tls (
EndpointMutualTLSMutate
) –tls_termination (
EndpointTLSTermination
) –traffic_policy (
EndpointTrafficPolicy
) – the traffic policy associated with this edge or null
https://ngrok.com/docs/api#api-edges-tls-create
- Return type:
- get(id)[source]#
Get a TLS Edge by ID
- Parameters:
id (
str
) – a resource identifier
https://ngrok.com/docs/api#api-edges-tls-get
- Return type:
- list(before_id=None, limit=None)[source]#
Returns a list of all TLS Edges on this account
- Parameters:
before_id (
str
) –limit (
str
) –
https://ngrok.com/docs/api#api-edges-tls-list
- Return type:
- update(id, description=None, metadata=None, hostports=None, backend=None, ip_restriction=None, mutual_tls=None, tls_termination=None, traffic_policy=None)[source]#
Updates a TLS 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 edgedescription (
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 edgebackend (
EndpointBackendMutate
) – edge modulesip_restriction (
EndpointIPPolicyMutate
) –mutual_tls (
EndpointMutualTLSMutate
) –tls_termination (
EndpointTLSTermination
) –traffic_policy (
EndpointTrafficPolicy
) – the traffic policy associated with this edge or null
https://ngrok.com/docs/api#api-edges-tls-update
- Return type: