Get Session - BlobHub

Retrieve details of a specific session. The session’s status reports where it is in its lifecycle — open, closing, closed or deleting. See Session Lifecycle for what each permits.

POST `/revisions/:id/data/query` (Command: `get_session`)

Request Body

Parameter	Type	Required	Description
`command`	string	Yes	Must be `get_session`.
`session_id`	string	Yes	The ID or alias of the session.

See Alias Grammar for the character rules, length limits and which commands accept an alias in place of an id.

Response

Parameter	Type	Description
`session`	object	The session object.

The session object carries held, keyed by limit id: held["workflow.executions_per_session"] is how many executions the session holds against workflow.executions_per_session. Retention frees a slot each time it removes one of the session’s executions. A session that holds nothing may have no held at all; read that as 0.

Example

{
  "command": "get_session",
  "session_id": "sess_001"
}

{
  "status": "success",
  "session": {
    "id": "sess_001",
    "alias": "primary",
    "status": "open",
    "held": {"workflow.executions_per_session": 42}
  }
}

Alias resolution reads a secondary index that is eventually consistent, so an alias assigned moments earlier may not resolve yet. Hold the id returned by create_session rather than re-resolving the session by alias on every call.