Skip to content

Commit e2322e6

Browse files
authored
chore: deprecate remove tunnel API (#707)
1 parent 173fada commit e2322e6

2 files changed

Lines changed: 8 additions & 7 deletions

File tree

src/resources/devboxes/devboxes.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -415,10 +415,10 @@ export class Devboxes extends APIResource {
415415
}
416416

417417
/**
418-
* [Deprecated] Tunnels remain active until devbox is shutdown. This endpoint
419-
* removes a legacy tunnel.
418+
* @deprecated Only works with legacy tunnels created via {@link createTunnel}.
419+
* V2 tunnels (from {@link enableTunnel}) remain active until devbox shutdown and cannot be removed.
420420
*
421-
* @deprecated
421+
* Remove a legacy tunnel from the devbox.
422422
*/
423423
removeTunnel(
424424
id: string,

src/sdk/devbox.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,19 +155,20 @@ export class DevboxNetOps {
155155
}
156156

157157
/**
158-
* [Deprecated] Tunnels remain active until devbox is shutdown. This removes legacy tunnels only.
158+
* @deprecated Only works with legacy tunnels created via {@link createTunnel}.
159+
* V2 tunnels (from {@link enableTunnel}) remain active until devbox shutdown and cannot be removed.
159160
*
160-
* Remove a tunnel from the devbox.
161+
* Remove a legacy tunnel from the devbox.
161162
*
162163
* @example
163164
* ```typescript
165+
* // Deprecated - only for legacy tunnels
164166
* await devbox.net.removeTunnel({ port: 8080 });
165167
* ```
166168
*
167-
* @param {DevboxRemoveTunnelParams} params - Tunnel removal parameters
169+
* @param {DevboxRemoveTunnelParams} params - Tunnel removal parameters including port
168170
* @param {Core.RequestOptions} [options] - Request options
169171
* @returns {Promise<DevboxRemoveTunnelResponse>} Tunnel removal result
170-
* @deprecated Legacy tunnels only. V2 tunnels (from enableTunnel) remain active until devbox shutdown.
171172
*/
172173
async removeTunnel(params: DevboxRemoveTunnelParams, options?: Core.RequestOptions) {
173174
return this.client.devboxes.removeTunnel(this.devboxId, params, options);

0 commit comments

Comments
 (0)