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 '{"enabled":true,"backend_id":"bkdtg_2TMGJmLjx9llDv6g2NJweJgP9Uk"}' \
https://api.ngrok.com/edges/tcp/edgtcp_2TMGJnuMeKmKMJnoqPO3nLVGvPo/backend

Parameters

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

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

Fields

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

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_2TMGJnuMeKmKMJnoqPO3nLVGvPo/backend

Response

Returns a 200 response on success

Example Response

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

Fields

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

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_2TMGJnuMeKmKMJnoqPO3nLVGvPo/backend

Response

Returns a 204 response with no body on success