Skip to main content

TLS Edge Backend Module

Replace TLS Edge Backend Module​

Request​

PUT /edges/tls/{id}/backend

Example Request​

curl \
-X PUT \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"enabled":true,"backend_id":"bkdtg_2TMGJmOgKZR9AARwnUs3NNzN9Tn"}' \
https://api.ngrok.com/edges/tls/edgtls_2TMGJpoHQcJPa4v8ac9jyXyGA9i/backend

Parameters​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
backend_idstringbackend to be used to back this endpoint

Response​

Returns a 200 response on success

Example Response​

{
  "enabled": true,
  "backend": {
    "id": "bkdtg_2TMGJmOgKZR9AARwnUs3NNzN9Tn",
    "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2TMGJmOgKZR9AARwnUs3NNzN9Tn"
  }
}

Fields​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
backendRefbackend to be used to back this endpoint

Ref fields​

   
idstringa resource identifier
uristringa uri for locating a resource

Get TLS Edge Backend Module​

Request​

GET /edges/tls/{id}/backend

Example Request​

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

Response​

Returns a 200 response on success

Example Response​

{
  "enabled": true,
  "backend": {
    "id": "bkdtg_2TMGJmOgKZR9AARwnUs3NNzN9Tn",
    "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2TMGJmOgKZR9AARwnUs3NNzN9Tn"
  }
}

Fields​

   
enabledbooleantrue if the module will be applied to traffic, false to disable. default true if unspecified
backendRefbackend to be used to back this endpoint

Ref fields​

   
idstringa resource identifier
uristringa uri for locating a resource

Delete TLS Edge Backend Module​

Request​

DELETE /edges/tls/{id}/backend

Example Request​

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

Response​

Returns a 204 response with no body on success