Skip to content

AdminRuleList

The rules.

object
items
required
Array<object>

A rule of the instance. Its ID stays the same across revisions, so reports keep citing it.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
position
required

The sort key of the rule; the rules in effect are listed by it. Retiring a rule leaves a gap until the next move.

integer
>= 1
text
required

The rule, on one line, as plain text.

string
hint

An explanation of the rule, as plain text; omitted when there is none.

string
created_at
required
string format: date-time
revised_at
required

When the current revision was recorded.

string format: date-time
retired_at

When the rule was retired; omitted for a rule in effect.

string format: date-time

Example generated

{
"items": [
{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"position": 1,
"text": "example",
"hint": "example",
"created_at": "2026-04-15T12:00:00Z",
"revised_at": "2026-04-15T12:00:00Z",
"retired_at": "2026-04-15T12:00:00Z"
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site