Skip to main content
POST
Create a rule

Authorizations

Authorization
string
header
required

A VisIQ API key presented as Authorization: Bearer vq_prod_.... Mint keys under Connectors -> API Keys in the dashboard.

Body

application/json
operations
enum<string>[]
required
Required array length: 1 - 3 elements
Available options:
action,
retrieval,
delegation
name
string
required
Required string length: 1 - 255
rego_source
string
required
Required string length: 1 - 100000
description
string
Maximum string length: 1000
natural_language
string
Maximum string length: 2000
priority
integer
default:0
enabled
boolean
default:true
target_app
string | null
Maximum string length: 255
action_pattern
string | null
Maximum string length: 255
trust_tier
string | null
Maximum string length: 64
surface
string | null
Maximum string length: 128
principal_exclusions
string[] | null
Required string length: 1 - 255

Response

The created rule.

id
string<uuid>
rule_code
string
name
string
description
string | null
rego_source
string
natural_language
string | null
priority
integer
enabled
boolean
applies_to
enum<string>[]
Available options:
action,
retrieval,
delegation
target_app
string | null
action_pattern
string | null
trust_tier
string | null
surface
string | null
principal_exclusions
string[] | null
created_at
string<date-time>
updated_at
string<date-time>