FleetDeckDocs

API reference / Sessions and actions

Release a session

Closes this key’s session and cancels its queued work.

DELETE/api/v1/sessions/{sessionId}

Authorization

Bearer tokenSame key that acquired the session

Send Authorization: Bearer <FLEETDECK_API_KEY> with the scope above. The key must also grant access to the target device. Authentication guide ↗

Request example
Request · cURL
curl --request DELETE \
  --url 'https://fleetdeck.co/api/v1/sessions/session_123' \
  --header "Authorization: Bearer $FLEETDECK_API_KEY"

Replace example IDs with returned values. Read credentials from your private environment.

Response examples
200 · success
{
  "released": true
}

Path parameters

sessionIdstringrequired

Session ID returned by Acquire a session. Use the key that owns that session.

min 1 charactersmax 128 characters
Example: "session_123"
Validation pattern^[A-Za-z0-9._:-]+$

Request body

This endpoint does not require a request body.

Behavior and limits

Closes this key’s session and cancels its queued work. Returns released:true even when there is no matching open session. A running action may finish; its lease can keep the device busy. No request body.

Response 200

Released · application/json

releasedbooleanalways present

True when the release request is acknowledged. It does not reverse input already delivered.

Allowed:true

Errors

Expand a code for its recovery steps. Responses use error and code; validation errors also include issues.

401UNAUTHORIZEDMissing, malformed, expired or revoked credential; user verification/password state can also deny access.

Recovery: Use Authorization: Bearer with a valid scoped key. For dashboard routes, sign in. Job children require an active parent job and timely renewal.

Full error reference ↗
500INTERNALUnexpected service error.

Recovery: Save nonsecret request context and time for support. Query action status before repeating a mutation; never assume it did not execute.

Full error reference ↗

Example error messages are illustrative. Match the code and HTTP status; do not depend on exact message wording.