Endpoint Configurations

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

class ngrok.services.EndpointConfigurationsClient(client)[source]

Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.

create(type='', description='', metadata='', circuit_breaker=None, compression=None, request_headers=None, response_headers=None, ip_policy=None, mutual_tls=None, tls_termination=None, webhook_validation=None, oauth=None, logging=None, saml=None, oidc=None)[source]

Create a new endpoint configuration

Parameters
  • type (str) – they type of traffic this endpoint configuration can be applied to. one of: http, https, tcp

  • description (str) – human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes

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

  • circuit_breaker (Optional[EndpointCircuitBreaker]) – circuit breaker module configuration or null

  • compression (Optional[EndpointCompression]) – compression module configuration or null

  • request_headers (Optional[EndpointRequestHeaders]) – request headers module configuration or null

  • response_headers (Optional[EndpointResponseHeaders]) – response headers module configuration or null

  • ip_policy (Optional[EndpointIPPolicyMutate]) – ip policy module configuration or null

  • mutual_tls (Optional[EndpointMutualTLSMutate]) – mutual TLS module configuration or null

  • tls_termination (Optional[EndpointTLSTermination]) – TLS termination module configuration or null

  • webhook_validation (Optional[EndpointWebhookValidation]) – webhook validation module configuration or null

  • oauth (Optional[EndpointOAuth]) – oauth module configuration or null

  • logging (Optional[EndpointLoggingMutate]) – logging module configuration or null

  • saml (Optional[EndpointSAMLMutate]) – saml module configuration or null

  • oidc (Optional[EndpointOIDC]) – oidc module configuration or null

https://ngrok.com/docs/api#api-endpoint-configurations-create

Return type

EndpointConfiguration

delete(id)[source]

Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-endpoint-configurations-delete

get(id)[source]

Returns detailed information about an endpoint configuration

Parameters

id (str) – a resource identifier

https://ngrok.com/docs/api#api-endpoint-configurations-get

Return type

EndpointConfiguration

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

Returns a list of all endpoint configurations on this account

Parameters
  • before_id (Optional[str]) –

  • limit (Optional[str]) –

https://ngrok.com/docs/api#api-endpoint-configurations-list

Return type

EndpointConfigurationList

update(id, description=None, metadata=None, circuit_breaker=None, compression=None, request_headers=None, response_headers=None, ip_policy=None, mutual_tls=None, tls_termination=None, webhook_validation=None, oauth=None, logging=None, saml=None, oidc=None)[source]

Updates an endpoint configuration. 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 endpoint configuration

  • description (Optional[str]) – human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes

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

  • circuit_breaker (Optional[EndpointCircuitBreaker]) – circuit breaker module configuration or null

  • compression (Optional[EndpointCompression]) – compression module configuration or null

  • request_headers (Optional[EndpointRequestHeaders]) – request headers module configuration or null

  • response_headers (Optional[EndpointResponseHeaders]) – response headers module configuration or null

  • ip_policy (Optional[EndpointIPPolicyMutate]) – ip policy module configuration or null

  • mutual_tls (Optional[EndpointMutualTLSMutate]) – mutual TLS module configuration or null

  • tls_termination (Optional[EndpointTLSTermination]) – TLS termination module configuration or null

  • webhook_validation (Optional[EndpointWebhookValidation]) – webhook validation module configuration or null

  • oauth (Optional[EndpointOAuth]) – oauth module configuration or null

  • logging (Optional[EndpointLoggingMutate]) – logging module configuration or null

  • saml (Optional[EndpointSAMLMutate]) – saml module configuration or null

  • oidc (Optional[EndpointOIDC]) – oidc module configuration or null

https://ngrok.com/docs/api#api-endpoint-configurations-update

Return type

EndpointConfiguration