Get AI Session Analyzer Rule by Connection

Get the AI session analyzer rule configured for a specific connection

GET /connections/{nameOrId}/ai-session-analyzer-rule

Get AI Session Analyzer Rule by Connection

cURL

curl --request GET \
  --url https://use.hoop.dev/api/connections/{nameOrId}/ai-session-analyzer-rule

200

{
  "agentic": false,
  "approval_ttl_sec": 600,
  "connection_names": [
    "pgdemo",
    "mysql-prod"
  ],
  "created_at": "2024-07-25T15:56:35.317601Z",
  "custom_prompt": "Treat any query that touches the payments schema as high risk.",
  "description": "Blocks high-risk SQL commands",
  "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "managed_by": "hoop",
  "name": "block-dangerous-queries",
  "pending_ttl_sec": 900,
  "reviewers_groups": [
    "dba-leads"
  ],
  "risk_evaluation": {
    "high_risk": {
      "action": "require_access_request",
      "access_request_rule_name": "prod-approvals"
    },
    "high_risk_action": "block_execution",
    "low_risk": {
      "action": "require_access_request",
      "access_request_rule_name": "prod-approvals"
    },
    "low_risk_action": "allow_execution",
    "medium_risk": {
      "action": "require_access_request",
      "access_request_rule_name": "prod-approvals"
    },
    "medium_risk_action": "allow_execution"
  },
  "sidecar_spec": {},
  "sidecar_targets": [
    {
      "listener_name": "appdb",
      "sidecar_id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"
    }
  ],
  "updated_at": "2024-07-25T15:56:35.317601Z"
}

Path Parameters

nameOrId · string · required

The name or ID of the connection

Response

200

application/json

OK

agentic · boolean

When true, the analyzer runs an agentic tool-calling loop over past sessions and resource metadata before classifying.

Example:

false

approval_ttl_sec · integer

Seconds an approval lasts from the approval. Present as pending_ttl_sec is

Example:

600

connection_names · string[]

Connection names this rule applies to

Example:

["pgdemo", "mysql-prod"]

created_at · string · read-only

The time the resource was created

Example:

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

custom_prompt · string

Optional extra instructions appended to the default system prompt

Example:

"Treat any query that touches the payments schema as high risk."

description · string

Optional description

Example:

"Blocks high-risk SQL commands"

id · string<uuid> · read-only

The resource identifier

Example:

"15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7"

managed_by · string · read-only

Set to "hoop" when the rule is materialized and lifecycle-managed by a protection profile; managed rules are read-only through this API

Example:

"hoop"

name · string

Unique name for the rule

Example:

"block-dangerous-queries"

pending_ttl_sec · integer

Seconds a held statement's approval request may wait for a decision. Present only while the rule holds and the limit is set

Example:

900

reviewers_groups · string[]

The groups whose members may release a statement this rule holds. Present while the rule holds.

Example:

["dba-leads"]

risk_evaluation · object

Risk evaluation actions per level

Show child attributes

sidecar_spec · object

SidecarSpec is this rule in the sidecar's own vocabulary; see the request type. Present when the rule carries one.

sidecar_targets · object[]

The sidecar listeners this rule is bound to, and therefore distributed to

Show child attributes

updated_at · string · read-only

The time the resource was updated

Example:

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