Public reference

Tools

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

48 Endpoints

Tools

GET /api/v1/admin/tools/announcements Manage announcements prm_tools_announcements

Authentication: Staff token or session
Requires permission: prm_tools_announcements Manage announcements

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

Open the full reference

POST /api/v1/admin/tools/announcements Manage announcements prm_tools_announcements

Authentication: Staff token or session
Requires permission: prm_tools_announcements Manage announcements
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.

Open the full reference

POST /api/v1/admin/tools/announcements/preview-count Manage announcements prm_tools_announcements

Authentication: Staff token or session
Requires permission: prm_tools_announcements Manage announcements
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.

Open the full reference

GET /api/v1/admin/tools/announcements/{id} Manage announcements prm_tools_announcements

Authentication: Staff token or session
Requires permission: prm_tools_announcements Manage announcements

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

Open the full reference

GET /api/v1/admin/tools/backup Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore

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

Open the full reference

POST /api/v1/admin/tools/backup Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
Rate limit: t_heavy

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

Open the full reference

POST /api/v1/admin/tools/backup/bulk-delete Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
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.

Open the full reference

GET /api/v1/admin/tools/backup/jobs Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore

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

Open the full reference

GET /api/v1/admin/tools/backup/jobs/{id} Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore

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

Open the full reference

GET /api/v1/admin/tools/backup/schedule Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore

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

Open the full reference

PUT /api/v1/admin/tools/backup/schedule Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
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.

Open the full reference

POST /api/v1/admin/tools/backup/upload Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
Rate limit: t_heavy

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

Open the full reference

DELETE /api/v1/admin/tools/backup/{id} Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
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.

Open the full reference

GET /api/v1/admin/tools/backup/{id}/download Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
Rate limit: t_heavy

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

Open the full reference

POST /api/v1/admin/tools/backup/{id}/download-ticket Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
Rate limit: t_heavy

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

Open the full reference

POST /api/v1/admin/tools/backup/{id}/restore Backup & restore prm_tools_backup

Authentication: Staff token or session
Requires permission: prm_tools_backup Backup & restore
Rate limit: t_heavy

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

Open the full reference

GET /api/v1/admin/tools/bandwidth Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control

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

Open the full reference

POST /api/v1/admin/tools/bandwidth/apply Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control
Rate limit: t_heavy

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

Open the full reference

GET /api/v1/admin/tools/bandwidth/history Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control

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

Open the full reference

GET /api/v1/admin/tools/bandwidth/schedules Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control

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

Open the full reference

POST /api/v1/admin/tools/bandwidth/schedules Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control
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.

Open the full reference

POST /api/v1/admin/tools/bandwidth/schedules/bulk-delete Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control
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.

Open the full reference

DELETE /api/v1/admin/tools/bandwidth/schedules/{id} Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control
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.

Open the full reference

PATCH /api/v1/admin/tools/bandwidth/schedules/{id} Bandwidth control prm_tools_bandwidth_control

Authentication: Staff token or session
Requires permission: prm_tools_bandwidth_control Bandwidth control
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.

Open the full reference

POST /api/v1/admin/tools/bulk/apply Bulk changes prm_tools_bulk_changes

Authentication: Staff token or session
Requires permission: prm_tools_bulk_changes Bulk changes
Rate limit: t_heavy

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

Open the full reference

GET /api/v1/admin/tools/bulk/jobs Bulk changes prm_tools_bulk_changes

Authentication: Staff token or session
Requires permission: prm_tools_bulk_changes Bulk changes

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

Open the full reference

GET /api/v1/admin/tools/bulk/jobs/{id} Bulk changes prm_tools_bulk_changes

Authentication: Staff token or session
Requires permission: prm_tools_bulk_changes Bulk changes

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

Open the full reference

POST /api/v1/admin/tools/bulk/preview Bulk changes prm_tools_bulk_changes

Authentication: Staff token or session
Requires permission: prm_tools_bulk_changes Bulk changes
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.

Open the full reference

GET /api/v1/admin/tools/dashboards Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager

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

Open the full reference

POST /api/v1/admin/tools/dashboards Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager
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.

Open the full reference

POST /api/v1/admin/tools/dashboards/bulk-delete Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager
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.

Open the full reference

POST /api/v1/admin/tools/dashboards/restore-defaults Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager
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.

Open the full reference

DELETE /api/v1/admin/tools/dashboards/{id} Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager
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.

Open the full reference

GET /api/v1/admin/tools/dashboards/{id} Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager

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

Open the full reference

PUT /api/v1/admin/tools/dashboards/{id} Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager
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.

Open the full reference

POST /api/v1/admin/tools/factory-reset Factory reset prm_tools_factory_reset

Authentication: Staff token or session
Requires permission: prm_tools_factory_reset Factory reset
Rate limit: t_heavy

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

Open the full reference

GET /api/v1/admin/tools/factory-reset/preview Factory reset prm_tools_factory_reset

Authentication: Staff token or session
Requires permission: prm_tools_factory_reset Factory reset

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

Open the full reference

GET /api/v1/admin/tools/maintenance/operations System maintenance prm_tools_maintenance

Authentication: Staff token or session
Requires permission: prm_tools_maintenance System maintenance
Rate limit: t_heavy

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

Open the full reference

POST /api/v1/admin/tools/maintenance/run System maintenance prm_tools_maintenance

Authentication: Staff token or session
Requires permission: prm_tools_maintenance System maintenance
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.

Open the full reference

GET /api/v1/admin/tools/maintenance/runs System maintenance prm_tools_maintenance

Authentication: Staff token or session
Requires permission: prm_tools_maintenance System maintenance

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

Open the full reference

GET /api/v1/admin/tools/widget-data/sources Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager

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

Open the full reference

GET /api/v1/admin/tools/widget-data/{id} Dashboard Manager prm_tools_dashboard_manager

Authentication: Staff token or session
Requires permission: prm_tools_dashboard_manager Dashboard Manager

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

Open the full reference

GET /api/v1/admin/tools/widgets Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory

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

Open the full reference

POST /api/v1/admin/tools/widgets Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory
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.

Open the full reference

POST /api/v1/admin/tools/widgets/bulk-delete Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory
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.

Open the full reference

DELETE /api/v1/admin/tools/widgets/{id} Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory
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.

Open the full reference

GET /api/v1/admin/tools/widgets/{id} Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory

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

Open the full reference

PUT /api/v1/admin/tools/widgets/{id} Widget Factory prm_tools_widget_factory

Authentication: Staff token or session
Requires permission: prm_tools_widget_factory Widget Factory
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.

Open the full reference

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.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.

Try it free Talk to us