Tcp Edge Backend Module
Replace TCP Edge Backend Module
Request
PUT /edges/tcp/{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_2na2LVwora6zllflu40ZHJcVGAu","enabled":true}' \
https://api.ngrok.com/edges/tcp/edgtcp_2na2LWZvdxgin14SnfZM5buXWKe/backend
Parameters
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
backend_id | string | backend to be used to back this endpoint |
Response
Returns a 200 response on success
Example Response
{
"backend": {
"id": "bkdtg_2na2LVwora6zllflu40ZHJcVGAu",
"uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2na2LVwora6zllflu40ZHJcVGAu"
},
"enabled": true
}
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
backend | Ref | backend to be used to back this endpoint |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Get TCP Edge Backend Module
Request
GET /edges/tcp/{id}/backend
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tcp/edgtcp_2na2LWZvdxgin14SnfZM5buXWKe/backend
Response
Returns a 200 response on success
Example Response
{
"backend": {
"id": "bkdtg_2na2LVwora6zllflu40ZHJcVGAu",
"uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2na2LVwora6zllflu40ZHJcVGAu"
},
"enabled": true
}
Fields
| Name | Type | Description |
|---|---|---|
enabled | boolean | true if the module will be applied to traffic, false to disable. default true if unspecified |
backend | Ref | backend to be used to back this endpoint |
Ref fields
| Name | Type | Description |
|---|---|---|
id | string | a resource identifier |
uri | string | a uri for locating a resource |
Delete TCP Edge Backend Module
Request
DELETE /edges/tcp/{id}/backend
Example Request
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/edges/tcp/edgtcp_2na2LWZvdxgin14SnfZM5buXWKe/backend
Response
Returns a 204 response with no body on success