​
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 '{"backend_id":"bkdtg_32ELI9VhQossEbRKUhGLP2cfGYZ","enabled":true}' \
https://api.ngrok.com/edges/tls/edgtls_32ELIB7bnGkdHbz1zAFQdLImCXj/backend

​
Parameters

NameTypeDescription
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

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

​
Fields

NameTypeDescription
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

NameTypeDescription
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_32ELIB7bnGkdHbz1zAFQdLImCXj/backend

​
Response

Returns a 200 response on success

​
Example Response

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

​
Fields

NameTypeDescription
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

NameTypeDescription
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_32ELIB7bnGkdHbz1zAFQdLImCXj/backend

​
Response

Returns a 204 response with no body on success