sessions

List persistent sessions

List active persistent agent sessions for one environment, most recently updated first. Expired and internal sessions are excluded from sessions, total, and app_names. Session state omits keys in the reserved connic: namespace.

Required permission: retrieval.manage.

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

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/sessions/{environment_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.

Query parameters

searchstring nullable

Case-insensitive session ID pattern. Text is matched anywhere; an unescaped percent (%) matches any sequence and an unescaped underscore (_) matches one character. An empty value applies no search filter.

app_namestring nullable

Only sessions with this exact app_name, as listed in app_names. An empty value applies no filter.

limitinteger

Maximum number of sessions to return.

offsetinteger

Number of sessions to skip.

Response

Successful Response

totalinteger required

Sessions matching the filters, ignoring limit and offset.

app_namesstring[] required

Distinct app_name values across all sessions in the environment, regardless of filters.

Changes

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