Skip to main content

Edge Route Websocket Tcp Converter Module

Replace HTTPS Edge Route Websocket TCP Converter Module

Request

PUT /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

Example Request

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true}' \
https://api.ngrok.com/edges/https/edghts_2hrGzMAUMXgOMka9rh9fjaZJMaI/routes/edghtsrt_2hrGzIDnZYYPqjIs3FULX9lvkQP/websocket_tcp_converter

Parameters

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified

Response

Returns a 200 response on success

Example Response

{
"enabled": true
}

Fields

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified

Get HTTPS Edge Route Websocket TCP Converter Module

Request

GET /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2hrGzMAUMXgOMka9rh9fjaZJMaI/routes/edghtsrt_2hrGzIDnZYYPqjIs3FULX9lvkQP/websocket_tcp_converter

Response

Returns a 200 response on success

Example Response

{
"enabled": true
}

Fields

NameTypeDescription
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified

Delete HTTPS Edge Route Websocket TCP Converter Module

Request

DELETE /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/https/edghts_2hrGzMAUMXgOMka9rh9fjaZJMaI/routes/edghtsrt_2hrGzIDnZYYPqjIs3FULX9lvkQP/websocket_tcp_converter

Response

Returns a 204 response with no body on success