Sessions

Delete a session and its context

Removes the session row and purges its context permanently. Unlike release, the id stops resolving afterwards. Request-log entries that reference the session survive.

Pitfalls:

  • Idempotent: deleting an unknown or already-deleted id returns 204 (including another tenant's id), so a 204 does not prove the session existed.
  • While a render holds the lease, returns 409 ERR::SESSION::BUSY with Retry-After. Wait, or repeat with force=true to delete anyway and fail the running task.
delete/v1/sessions/{sessionID}

Request

  • Base URL: https://api.spicrawl.com
  • URL: https://api.spicrawl.com/v1/sessions/{sessionID}
  • Auth: HTTP bearer

Query parameters

forceboolean

Set true to end the session even while a render holds its lease; the running task fails. Parsed as a Go boolean (true, false, 1, 0, t, f, any case); other values are refused with 400.

Response

Deleted, or did not exist.

Changes

No recorded changes to this operation across all 1 revision of this API.