Skip to main content
POST
Create AI Session Analyzer Rule

Body

application/json

The request body resource

connection_names
string[]
required

Connection names this rule applies to

Example:
name
string
required

Unique name for the rule

Example:

"block-dangerous-queries"

risk_evaluation
object
required

Risk evaluation actions per level

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"

Response

Created

connection_names
string[]

Connection names this rule applies to

Example:
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"

risk_evaluation
object

Risk evaluation actions per level

updated_at
string
read-only

The time the resource was updated

Example:

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