Skip to main content

HTTPS Edge TLS Termination Module

Replace HTTPS Edge TLS Termination Module​

Request​

PUT /edges/https/{id}/tls_termination

Example Request​

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true,"min_version":"1.3"}' \
https://api.ngrok.com/edges/https/edghts_2TMGJkZATzGrG1XRRyQSSRAoB7o/tls_termination

Parameters​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
min_versionstringThe minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.

Response​

Returns a 200 response on success

Example Response​

{
    "enabled": true,
    "terminate_at": "edge",
    "min_version": "1.3"
}

Fields​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
terminate_atstringedge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
min_versionstringThe minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.

Get HTTPS Edge TLS Termination Module​

Request​

GET /edges/https/{id}/tls_termination

Example Request​

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2TMGJkZATzGrG1XRRyQSSRAoB7o/tls_termination

Response​

Returns a 200 response on success

Example Response​

{
    "enabled": true,
    "terminate_at": "edge",
    "min_version": "1.3"
}

Fields​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
terminate_atstringedge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
min_versionstringThe minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.

Delete HTTPS Edge TLS Termination Module​

Request​

DELETE /edges/https/{id}/tls_termination

Example Request​

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2TMGJkZATzGrG1XRRyQSSRAoB7o/tls_termination

Response​

Returns a 204 response with no body on success