Public reference
Maintenance Windows
Every endpoint in this group. Open one for its parameters and a worked example.
Maintenance Windows
8GET /api/v1/maintenance-windows View maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_viewView maintenance windows
Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.
POST /api/v1/maintenance-windows Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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.
DELETE /api/v1/maintenance-windows/{id} Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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/maintenance-windows/{id} View maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_viewView maintenance windows
Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.
PATCH /api/v1/maintenance-windows/{id} Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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/maintenance-windows/{id}/cancel Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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/maintenance-windows/{id}/complete Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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/maintenance-windows/{id}/start Schedule and manage maintenance windows
- Authentication
- Staff token or session
- Requires permission
-
prm_maintenance_manageSchedule and manage maintenance windows - 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.
No endpoint matches that search.
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.
Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.