List Sessions

List session resources

GET /sessions

List Sessions

cURL

curl --request GET \
  --url https://use.hoop.dev/api/sessions

200

{
  "data": [
    {
      "ai_analysis": {
        "action": "allow_execution",
        "explanation": "The script contains queries that may expose sensitive data.",
        "model": "<string>",
        "risk_level": "high",
        "steps": [
          {
            "is_error": true,
            "thinking": "<string>",
            "timestamp": "<string>",
            "tool_input": "<string>",
            "tool_name": "<string>",
            "tool_output": "<string>",
            "type": "tool_call"
          }
        ],
        "summary": "<string>",
        "title": "Potential Data Leakage"
      },
      "connection": "pgdemo",
      "connection_subtype": "postgres",
      "connection_tags": {
        "team": "banking;environment:prod"
      },
      "correlation_id": "task-12345",
      "end_date": "2024-07-25T15:56:35.361101Z",
      "event_size": 569,
      "event_stream": [
        123
      ],
      "exit_code": 123,
      "guardrails_info": [
        {
          "direction": "input",
          "elapsed": 12.5,
          "matched_words": [
            "password",
            "secret"
          ],
          "message": "This query was blocked by your organization's data policy",
          "rule": {
            "pattern_regex": "^[A-Z0-9]+",
            "type": "deny_words_list",
            "words": [
              "password",
              "secret"
            ]
          },
          "rule_name": "block-sensitive-data"
        }
      ],
      "id": "1CBC8DB5-FBF8-4293-8E35-59A6EEA40207",
      "identity_type": "user",
      "integrations_metadata": {},
      "labels": {},
      "machine_identity_id": "BF997324-5A27-4778-806A-41EE83598494",
      "metadata": {},
      "metrics": {},
      "org_id": "0CD7F941-2BB8-4F9F-93B0-11620D4652AB",
      "recording_format": "pty",
      "resource_name": "my-resource",
      "review": {
        "access_duration": 0,
        "access_request_rule_name": "default-access-request-rule",
        "created_at": "2024-07-25T15:56:35.317601Z",
        "force_approval_groups": [
          "sre-team"
        ],
        "id": "9F9745B4-C77B-4D52-84D3-E24F67E3623C",
        "listener_name": "appdb",
        "min_approvals": 2,
        "rejection_reason": "This command is not allowed in production.",
        "review_groups_data": [
          {
            "forced_review": false,
            "group": "sre",
            "id": "20A5AABE-C35D-4F04-A5A7-C856EE6C7703",
            "review_date": "2024-07-25T19:36:41Z",
            "reviewed_by": {
              "email": "[e-mail]",
              "id": "D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90",
              "name": "John Wick",
              "slack_id": "U053ELZHB53"
            },
            "status": "APPROVED"
          }
        ],
        "revoke_at": "",
        "status": "PENDING",
        "time_window": {
          "configuration": {
            "end_time": "18:00",
            "start_time": "09:00"
          },
          "type": "time_range"
        },
        "type": "onetime"
      },
      "role_name": "pgdemo",
      "script": {
        "data": "SELECT NOW()"
      },
      "script_size": 12,
      "session_batch_id": "batch-abc-123",
      "start_date": "2024-07-25T15:56:35.317601Z",
      "status": "open",
      "type": "database",
      "user": "<string>",
      "user_id": "nJ1xV3ASWGTi7L8Y6zvnKqxNlnZM2TxV1bRdc0706vZ",
      "user_name": "John Wick",
      "verb": "connect"
    }
  ],
  "has_next_page": true,
  "total": 100,
  "total_is_capped": true
}

Query Parameters

user · string

Filter by user's subject id

connection · string

Filter by connection's name

type · string

Filter by connection's type

review.approver · string

Filter by the approver email of an approval request

review.status · string

Filter by the approval status

correlation_id · string

Filter by external workflow/task correlation id

jira_issue_key · string

Filter by Jira issue key

status · enum<string>

Filter by the session status

Available options: open, ready, done

verb · enum<string>

Filter by the session verb

Available options: connect, exec

input · string

Filter by text in the session input, case-insensitive, at most 256 bytes. Only % is a wildcard. Native client sessions are not searched.

start_date · string<RFC3339>

Filter starting on this date

end_date · string<RFC3339>

Filter ending on this date

limit · integer

Limit the amount of records to return (max: 100)

offset · integer

Offset to paginate through resources (max: 10000)

count · enum<string>

How to compute the total: capped at 10000 (default), exact, or none

Available options: exact, capped, none

Response

200

application/json

OK

data · object[]

Show child attributes

has_next_page · boolean

total · integer | null

The number of sessions matching the filter.

Capped by default: the value is the exact total up to 10000, and beyond that it stops at 10000 with total_is_capped set. Ask for ?count=exact to pay for the precise figure. null when the request asked for ?count=none, which is distinct from a count of zero: it means the total was never computed.

Example:

100

total_is_capped · boolean

Reports that total is a lower bound rather than the exact number of matching sessions. Render it as 10000+. Always false under ?count=exact, and for any result set smaller than the cap.