sessions

Get persistent session

Get one active persistent session by its exact app_name, user_id, and session ID, with its most recent events. Session state omits keys in the reserved connic: namespace. Expired and internal sessions return 404.

Required permission: retrieval.manage.

get/v1/projects/{project_id}/sessions/{environment_id}/{session_id}

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/sessions/{environment_id}/{session_id}
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

environment_idstring uuid required

Environment ID from GET /environments.

session_idstring required

Session ID from GET /sessions/{environment_id}.

Query parameters

app_namestring required

The session's app_name from GET /sessions/{environment_id}.

user_idstring required

The session's user_id from GET /sessions/{environment_id}.

event_limitinteger

Maximum number of most recent events to return.

Response

Successful Response

idstring uuid required
session_idstring required

session-<agent name>-<key>, where the key is the value resolved from the agent's session.key, or default when no key is set.

app_namestring required

runner- followed by the agent name with hyphens replaced by underscores.

user_idstring required

User identity of the session. Pass it with app_name to get or delete this exact session.

stateobject required

Session state saved by the agent's runs. Keys in the reserved connic: namespace are omitted.

event_countinteger required

Total events recorded in the session.

expires_atstring date-time nullable

Expiry time, extended each time a run uses the session; null when the agent sets no session.ttl.

last_update_timestring date-time required

Time a run last used or updated the session.

created_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.