Skip to main content
GET
List rules visible to the caller.

Authorizations

X-API-Key
string
header
required

Infrawatch API key. Supply the complete key directly as the header value.

Query Parameters

q
string
Maximum string length: 200
limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
ownership
enum<string>

Restrict results to rules owned by the caller's personal account or by a permitted organisation. Omit this filter to include both ownership types and canonical platform-global rules.

Available options:
personal,
organisation
status
enum<string>
Available options:
enabled,
disabled,
invalid
admission
enum<string>
Available options:
pending,
approved,
revoked
category
string[]
Maximum array length: 50
Required string length: 1 - 100
Pattern: ^[a-z0-9][a-z0-9-]{0,99}(/[a-z0-9][a-z0-9-]{0,99})*$
tag_uuid
string<uuid>

Return only rules carrying this tag. A tag has many rules, so this is the reverse lookup behind a tag's rule listing. The tag must itself be visible to the caller.

Response

Personal, permitted organisation, and platform-global rules visible to the caller.

pagination
object
required
rules
object[]
required