Public reference

Incidents

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

18 Endpoints

Incidents

GET /api/v1/incidents View incidents prm_incidents_view

Authentication: Staff token or session
Requires permission: prm_incidents_view View incidents

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/incidents Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id} Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id} View incidents prm_incidents_view

Authentication: Staff token or session
Requires permission: prm_incidents_view View incidents

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/incidents/{id} Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id}/broadcast Reply to / resolve an incident's linked tickets prm_incidents_reply

Authentication: Staff token or session
Requires permission: prm_incidents_reply Reply to / resolve an incident's linked tickets
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/incidents/{id}/candidate-tickets Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents

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/incidents/{id}/compensations View incidents prm_incidents_view

Authentication: Staff token or session
Requires permission: prm_incidents_view View incidents
Requires any one of: prm_users_compensate prm_users_compensate_approve

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/incidents/{id}/compensations/approve Approve/reject compensation requests prm_users_compensate_approve

Authentication: Staff token or session
Requires permission: prm_users_compensate_approve Approve/reject compensation requests
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/incidents/{id}/compensations/generate Compensate users prm_users_compensate

Authentication: Staff token or session
Requires permission: prm_users_compensate Compensate users
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/incidents/{id}/compensations/reject Approve/reject compensation requests prm_users_compensate_approve

Authentication: Staff token or session
Requires permission: prm_users_compensate_approve Approve/reject compensation requests
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/incidents/{id}/events View incidents prm_incidents_view

Authentication: Staff token or session
Requires permission: prm_incidents_view View incidents

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/incidents/{id}/notes Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id}/resolve-tickets Reply to / resolve an incident's linked tickets prm_incidents_reply

Authentication: Staff token or session
Requires permission: prm_incidents_reply Reply to / resolve an incident's linked tickets
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/incidents/{id}/status Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id}/tickets View incidents prm_incidents_view

Authentication: Staff token or session
Requires permission: prm_incidents_view View incidents

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/incidents/{id}/tickets Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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/incidents/{id}/tickets/{ticketId} Create and manage incidents prm_incidents_manage

Authentication: Staff token or session
Requires permission: prm_incidents_manage Create and manage incidents
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.

5000 subscribers for 90 days. You pay nothing.

Try it free Talk to us