Skip to main content
DELETE
Bulk Delete Tunnels Endpoint

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to bulk delete tunnels.

tunnel_ids
string[] | null

List of tunnel IDs to delete

Required array length: 1 - 500 elements
labels
string[] | null

List of labels - delete all tunnels with ALL these labels

Required array length: 1 - 50 elements
status
enum<string> | null

Delete only tunnels currently in this status. Must be an active status (pending, connected, disconnected)

Available options:
pending,
connected,
disconnected,
expired,
terminated
teamId
string | null

Scope deletion to tunnels in this team

userId
string | null

Scope deletion to tunnels owned by this user

allUsers
boolean
default:false

Delete tunnels across all users in the given team

Response

Successful Response

Response for bulk tunnel deletion.

message
string
required

Summary message

succeeded
string[]

Successfully deleted tunnel IDs

failed
Failed · object[]

Failed deletions with error messages