Skip to main content

Terminates an existing tunnel session

DELETE 
/api/v1/devices/{deviceId}/tunnels/sessions/{tunnelSessionId}

Initiates a graceful or immediate shutdown of the specified tunnel session.

Preconditions: The session must NOT already be in a terminal or transitioning state. A 400 error is returned if the current sessionStatus is TERMINATED, TERMINATING, or FAILED.

Request body:

  • reason — Human-readable explanation for the termination.
  • graceful — When true, the agent honours the forceTimeout before hard-closing existing connections.
  • forceTimeout — Maximum seconds to wait for graceful closure before forcing (only applies when graceful=true).

Request​

Responses​

Accepted