Skip to main content
POST
/
guardrails
Create Guard Rail Rules
curl --request POST \
  --url https://use.hoop.dev/api/guardrails \
  --header 'Content-Type: application/json' \
  --data '{
  "connection_ids": [
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
  ],
  "description": "description about this rule",
  "input": {},
  "name": "my-strict-rule",
  "output": {}
}'
{
  "connection_ids": [
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
    "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
  ],
  "created_at": "2024-07-25T15:56:35.317601Z",
  "description": "description about this rule",
  "id": "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "input": {},
  "name": "my-strict-rule",
  "output": {},
  "updated_at": "2024-07-25T15:56:35.317601Z"
}

Body

application/json

The request body resource

​
name
string
required

Unique name for the rule

Example:

"my-strict-rule"

​
connection_ids
string[]

List of connection IDs that this guardrail applies to

Example:
[
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
]
​
description
string

The rule description

Example:

"description about this rule"

​
input
object

The input rule

{
		"name": "deny-select",
		"description": "<optional-description>",
		"input": {
			"rules": [
				{"type": "deny_words_list", "words": ["SELECT"], "pattern_regex": ""}
			]
		},
		"output": {
			"rules": [
				{"type": "pattern_match", "words": [], "pattern_regex": "[A-Z0-9]+"}
			]
		}
	}
​
output
object

The output rule

{
		"name": "deny-select",
		"description": "<optional-description>",
		"input": {
			"rules": [
				{"type": "deny_words_list", "words": ["SELECT"], "pattern_regex": ""}
			]
		},
		"output": {
			"rules": [
				{"type": "pattern_match", "words": [], "pattern_regex": "[A-Z0-9]+"}
			]
		}
	}

Response

Created

​
connection_ids
string[]

List of connection IDs that this guardrail applies to

Example:
[
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D7",
  "15B5A2FD-0706-4A47-B1CF-B93CCFC5B3D8"
]
​
created_at
string

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>

The resource identifier

Example:

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

​
input
object

The input rule

{
		"name": "deny-select",
		"description": "<optional-description>",
		"input": {
			"rules": [
				{"type": "deny_words_list", "words": ["SELECT"], "pattern_regex": "", "name": "<optional-name>"}
			]
		},
		"output": {
			"rules": [
				{"type": "pattern_match", "words": [], "pattern_regex": "[A-Z0-9]+"}
			]
		}
	}
​
name
string

Unique name for the rule

Example:

"my-strict-rule"

​
output
object

The output rule

{
		"name": "deny-select",
		"description": "<optional-description>",
		"input": {
			"rules": [
				{"type": "deny_words_list", "words": ["SELECT"], "pattern_regex": "", "name": "<optional-name>"}
			]
		},
		"output": {
			"rules": [
				{"type": "pattern_match", "words": [], "pattern_regex": "[A-Z0-9]+"}
			]
		}
	}
​
updated_at
string

The time the resource was updated

Example:

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