Skip to main content
POST
Create Guard Rail Rules

Body

application/json

The request body resource

name
string
required

Unique name for the rule

Example:

"my-strict-rule"

attributes
string[]

Attributes associated with this guardrail rule

Example:
connection_ids
string[]

List of connection IDs that this guardrail applies to

Example:
description
string

The rule description

Example:

"description about this rule"

input
object

The input rule. Each rule entry accepts an optional "message" field that is shown to the user when that specific rule is hit.

output
object

The output rule. Each rule entry accepts an optional "message" field that is shown to the user when that specific rule is hit.

Response

Created

attributes
string[]

Attributes associated with this guardrail rule

Example:
connection_ids
string[]

List of connection IDs that this guardrail applies to

Example:
created_at
string
read-only

The time the resource was created

Example:

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

description
string

The rule description

Example:

"description about this rule"

id
string<uuid>
read-only

The resource identifier

Example:

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

input
object

The input rule. Each rule entry accepts an optional "message" field that is shown to the user when that specific rule is hit.

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:

"my-strict-rule"

output
object

The output rule. Each rule entry accepts an optional "message" field that is shown to the user when that specific rule is hit.

updated_at
string
read-only

The time the resource was updated

Example:

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