Public reference

Monitoring

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

45 Endpoints

Monitoring

GET /api/v1/admin/monitoring/alerts View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/alerts/bulk-delete Acknowledge alerts prm_monitoring_ack

Authentication: Staff token or session
Requires permission: prm_monitoring_ack Acknowledge alerts
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/monitoring/alerts/clear-all Acknowledge alerts prm_monitoring_ack

Authentication: Staff token or session
Requires permission: prm_monitoring_ack Acknowledge alerts
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/monitoring/alerts/unacked-count View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/alerts/{id}/ack Acknowledge alerts prm_monitoring_ack

Authentication: Staff token or session
Requires permission: prm_monitoring_ack Acknowledge alerts
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/monitoring/alerts/{id}/deliveries View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/devices/bulk-delete Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/devices/{id} Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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

PUT /api/v1/admin/monitoring/devices/{id} Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/devices/{kind}/{ref} View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices/{kind}/{ref}/geo Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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

PUT /api/v1/admin/monitoring/devices/{kind}/{ref}/geo Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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

PUT /api/v1/admin/monitoring/devices/{kind}/{ref}/icon Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/devices/{kind}/{ref}/impact View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/devices/{kind}/{ref}/live-traffic View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring
Rate limit: t_probe

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/monitoring/devices/{kind}/{ref}/live-traffic/stream View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring
Rate limit: t_probe

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/monitoring/devices/{kind}/{ref}/notify View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices/{kind}/{ref}/notify Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/devices/{kind}/{ref}/owners View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices/{kind}/{ref}/owners Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/devices/{kind}/{ref}/ping Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
Rate limit: t_probe

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/monitoring/devices/{kind}/{ref}/ping/stream Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
Rate limit: t_probe

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/monitoring/devices/{kind}/{ref}/snmp-interfaces Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
Rate limit: t_probe

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/monitoring/devices/{kind}/{ref}/stability View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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/monitoring/devices/{kind}/{ref}/users View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/devices/{kind}/{ref}/users Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/geo View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/geo/hygiene View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/geo/import Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/geo/incidents View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/geo/links View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/geo/links Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/geo/links/bulk-delete Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/geo/links/{id} Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/geo/links/{id}/reverse Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/map View network map prm_map_view

Authentication: Staff token or session
Requires permission: prm_map_view View network map

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/monitoring/map Edit network map prm_map_edit

Authentication: Staff token or session
Requires permission: prm_map_edit Edit network map
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/monitoring/sensors Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/sensors/bulk-delete Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/sensors/{id} Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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

PUT /api/v1/admin/monitoring/sensors/{id} Manage monitored devices & sensors prm_monitoring_manage

Authentication: Staff token or session
Requires permission: prm_monitoring_manage Manage monitored devices & sensors
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/monitoring/sensors/{id}/samples View monitoring prm_monitoring_view

Authentication: Staff token or session
Requires permission: prm_monitoring_view View monitoring

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