Delete request tunnel
DELETE
/v1/requests/{id}/tunnel
const url = 'https://localhost:8080/v1/requests/example/tunnel';const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://localhost:8080/v1/requests/example/tunnel \ --header 'Authorization: <Authorization>'Deletes the active tunnel for a request environment
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request ID
Responses
Section titled “Responses”OK
Media typeapplication/json
object
data
object
tcp_tunnel_slot
TCPTunnelSlot reports the system-wide TCP-tunnel slot occupancy. Values: “free” | “in_use”. Surfaced only on proxied-request GETs.
string
tcp_tunnels_configured
TCPTunnelsConfigured reports whether the operator has configured the ngrok TCP backend. Surfaced only on proxied-request GETs.
boolean
tunnel
Tunnel is the existing tunnel row; nil when no tunnel exists for the request.
object
api_url
string
connection_template
string
created_at
string
credentials
Array<object>
object
id
string
is_active
boolean
last_used_at
string
secret_preview
string
type
string
use_count
integer
username
string
edge_url
string
explorer_url
string
id
string
kind
string
last_error
string
local_forward_command
string
provider
string
public_host
string
public_port
integer
public_url
string
sidecar_name
string
status
string
updated_at
string
usage_events
Array<object>
object
action_type
string
id
string
ip_address
string
metadata
timestamp
string
success
boolean
Example generated
{ "data": { "tcp_tunnel_slot": "example", "tcp_tunnels_configured": true, "tunnel": { "api_url": "example", "connection_template": "example", "created_at": "example", "credentials": [ { "id": "example", "is_active": true, "last_used_at": "example", "secret_preview": "example", "type": "example", "use_count": 1, "username": "example" } ], "edge_url": "example", "explorer_url": "example", "id": "example", "kind": "example", "last_error": "example", "local_forward_command": "example", "provider": "example", "public_host": "example", "public_port": 1, "public_url": "example", "sidecar_name": "example", "status": "example", "updated_at": "example", "usage_events": [ { "action_type": "example", "id": "example", "ip_address": "example", "metadata": "example", "timestamp": "example" } ] } }, "success": true}Unauthorized
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}Not Found
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}Internal Server Error
Media typeapplication/json
object
error
string
message
string
success
boolean
Example
{ "error": "", "message": "Success", "success": true}