List Sessions

List Sessions

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

{
  "data": [
    {
      "connection": "pgdemo",
      "connection_subtype": "postgres",
      "connection_tags": {
        "team": "banking;environment:prod"
      },
      "end_date": "2024-07-25T15:56:35.361101Z",
      "event_size": 569,
      "event_stream": [
        123
      ],
      "exit_code": 123,
      "id": "1CBC8DB5-FBF8-4293-8E35-59A6EEA40207",
      "integrations_metadata": {},
      "labels": {},
      "metadata": {},
      "metrics": {},
      "org_id": "0CD7F941-2BB8-4F9F-93B0-11620D4652AB",
      "review": {
        "access_duration": 0,
        "created_at": "2024-07-25T15:56:35.317601Z",
        "id": "9F9745B4-C77B-4D52-84D3-E24F67E3623C",
        "review_groups_data": [
          {
            "group": "sre",
            "id": "20A5AABE-C35D-4F04-A5A7-C856EE6C7703",
            "review_date": "2024-07-25T19:36:41Z",
            "reviewed_by": {
              "email": "[email protected]",
              "id": "D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90",
              "name": "John Wick",
              "slack_id": "U053ELZHB53"
            },
            "status": "APPROVED"
          }
        ],
        "revoke_at": "",
        "status": "PENDING",
        "type": "onetime"
      },
      "script": {
        "data": "SELECT NOW()"
      },
      "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
}

GET

sessions

List Sessions

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

{
  "data": [
    {
      "connection": "pgdemo",
      "connection_subtype": "postgres",
      "connection_tags": {
        "team": "banking;environment:prod"
      },
      "end_date": "2024-07-25T15:56:35.361101Z",
      "event_size": 569,
      "event_stream": [
        123
      ],
      "exit_code": 123,
      "id": "1CBC8DB5-FBF8-4293-8E35-59A6EEA40207",
      "integrations_metadata": {},
      "labels": {},
      "metadata": {},
      "metrics": {},
      "org_id": "0CD7F941-2BB8-4F9F-93B0-11620D4652AB",
      "review": {
        "access_duration": 0,
        "created_at": "2024-07-25T15:56:35.317601Z",
        "id": "9F9745B4-C77B-4D52-84D3-E24F67E3623C",
        "review_groups_data": [
          {
            "group": "sre",
            "id": "20A5AABE-C35D-4F04-A5A7-C856EE6C7703",
            "review_date": "2024-07-25T19:36:41Z",
            "reviewed_by": {
              "email": "[email protected]",
              "id": "D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90",
              "name": "John Wick",
              "slack_id": "U053ELZHB53"
            },
            "status": "APPROVED"
          }
        ],
        "revoke_at": "",
        "status": "PENDING",
        "type": "onetime"
      },
      "script": {
        "data": "SELECT NOW()"
      },
      "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
}

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's email of a review

review.status

string

Filter by the review status

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

Response

data

object[]

Show child attributes

data.connection

string

The connection name of this resource

Example:

"pgdemo"

data.connection_subtype

string

The subtype of the connection

Example:

"postgres"

data.connection_tags

object

The tags of the connection resource

Show child attributes

data.connection_tags.{key}

string

Example:

{ "team": "banking;environment:prod" }

data.end_date

string

When the execution ended. A null value indicates the session is still running

Example:

"2024-07-25T15:56:35.361101Z"

data.event_size

integer

The stored resource size in bytes. When any parsing is applied to the request the value display the computed parsed size. The pre-computed size will be available in the attribute metrics.event_size

Example:

569

data.event_stream

integer[]

The stream containing the output of the execution in the following format

[[0.268589438, "i", "ZW52"], ...]

<event-time> - relative time in miliseconds to start_date
<event-type> - the event type as string (i: input, o: output e: output-error)
<base64-content> - the content of the session encoded as base64 string

data.exit_code

integer

The Linux exit code if it's available

data.id

string<uuid>

The resource unique identifier

Example:

"1CBC8DB5-FBF8-4293-8E35-59A6EEA40207"

data.integrations_metadata

object

Metadata attributes related to integrations with third party services

Show child attributes

data.integrations_metadata.{key}

any

data.labels

object

DEPRECATED in flavor of metrics and metadata

Show child attributes

data.labels.{key}

string

data.metadata

object

Show child attributes

data.metadata.{key}

any

data.metrics

object

Refactor to use a struct

Show child attributes

data.metrics.{key}

any

data.org_id

string<uuid>

The organization unique identifier

Example:

"0CD7F941-2BB8-4F9F-93B0-11620D4652AB"

data.review

object

Review of this session. In case the review doesn't exist this field will be null

Show child attributes

data.review.access_duration

integer

default:1800000000000

The amount of time (nanoseconds) to allow access to the connection. It's valid only for jit type reviews

Example:

0

data.review.created_at

string

The time the resource was created

Example:

"2024-07-25T15:56:35.317601Z"

data.review.id

string<uuid>

Resource identifier

Example:

"9F9745B4-C77B-4D52-84D3-E24F67E3623C"

data.review.review_groups_data

object[]

Contains the groups that requires to approve this review

Show child attributes

data.review.review_groups_data.group

string

The group to approve this review

Example:

"sre"

data.review.review_groups_data.id

string<uuid>

The resource identifier

Example:

"20A5AABE-C35D-4F04-A5A7-C856EE6C7703"

data.review.review_groups_data.review_date

string

The date which this review was performed

Example:

"2024-07-25T19:36:41Z"

data.review.review_groups_data.reviewed_by

object

The review owner

Show child attributes

data.review.review_groups_data.reviewed_by.email

string

The email of the owner

Example:

"[email protected]"

data.review.review_groups_data.reviewed_by.id

string<uuid>

The resource identifier

Example:

"D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90"

data.review.review_groups_data.reviewed_by.name

string

The display name of the owner

Example:

"John Wick"

data.review.review_groups_data.reviewed_by.slack_id

string

The Slack ID of the owner

Example:

"U053ELZHB53"

data.review.review_groups_data.status

enum<string>

The reviewed status

APPROVED - Approve the review resource
REJECTED - Reject the review resource
REVOKED - Revoke an approved review

Available options:

APPROVED,

REJECTED,

REVOKED

Example:

"APPROVED"

data.review.revoke_at

string

The time when this review was revoked

Example:

""

data.review.status

enum<string>

The status of the review

PENDING - The resource is waiting to be reviewed
APPROVED - The resource is fully approved
REJECTED - The resource is fully rejected
REVOKED - The resource was revoked after being approved
PROCESSING - The review is being executed
EXECUTED - The review was executed
UNKNOWN - Unable to know the status of the review

Available options:

PENDING,

APPROVED,

REJECTED,

REVOKED,

PROCESSING,

EXECUTED,

UNKNOWN

data.review.type

enum<string>

The type of the review

onetime - Represents a one time execution
jit - Represents a time based review

Available options:

onetime,

jit

data.script

object

The input of the session. This value is only set for the verb exec

Show child attributes

data.script.{key}

string

Example:

{ "data": "SELECT NOW()" }

data.start_date

string

When the execution started

Example:

"2024-07-25T15:56:35.317601Z"

data.status

enum<string>

Status of the resource

ready - the resource is ready to be executed, after being approved by a user
open - the session started and it's running
done - the session has finished

Available options:

open,

ready,

done

data.type

string

The connection type of this resource

Example:

"database"

data.user

string

The user email of the resource

data.user_id

string

The user subject identifier of the resource

Example:

"nJ1xV3ASWGTi7L8Y6zvnKqxNlnZM2TxV1bRdc0706vZ"

data.user_name

string

The user display name of this resource

Example:

"John Wick"

data.verb

enum<string>

Verb is how the client has interacted with this resource

exec - Is an ad-hoc shell execution
connect - Interactive execution, protocol port forwarding or interactive shell session

Available options:

connect,

exec

has_next_page

boolean

total

integer

Example:

100

Delete User Exec

⌘I

Agents

Authentication

Connections

Data Masking Rules

AWS

Features

Guard Rails

Server Management

Jira

Organization Management

Plugins

Runbooks

Proxy Manager

Reports

Resources

Reviews

Search

User Management

Sessions

Query Parameters

Response