Public reference

Notification Rules

Every endpoint in this group. Open one for its parameters and a worked example.

7 Endpoints

GET /api/v1/admin/notification-rules Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

POST /api/v1/admin/notification-rules Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

POST /api/v1/admin/notification-rules/bulk Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications
Rate limit: t_egress

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

POST /api/v1/admin/notification-rules/bulk-delete Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

GET /api/v1/admin/notification-rules/log Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

DELETE /api/v1/admin/notification-rules/{id} Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

PATCH /api/v1/admin/notification-rules/{id} Manage usage notifications prm_profiles_notifications

Authentication: Staff token or session
Requires permission: prm_profiles_notifications Manage usage notifications
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Written to be read by machines too

The reference is public and needs no account, so a tool that has never seen X-Radius can reach a correct first call on its own.

/llms.txt: An index of every page, with one-line summaries.
/llms-full.txt: The whole reference as one Markdown file, with no navigation to crawl.
/openapi.json: OpenAPI 3.1, generated from the router that serves this instance.
/skill.md: A ready-made skill file for an assistant: authentication, the response envelope and the error codes in one page.
<page-url>.md: Append .md to any reference URL for the same page as Markdown.
Accept: text/markdown: Send this header on the ordinary URL and the answer comes back as Markdown instead.

Hand this to your assistant

Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.

50 subscribers for 7 days. You pay nothing.