Public reference

Public

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

29 Endpoints

View as Markdown

Public

29
POST /api/v1/public/auth/resolve-host
Authentication
Public
Rate limit
resolve_host

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

GET /api/v1/public/backup/oauth/{provider}/callback
Authentication
Public

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

GET /api/v1/public/csat/{token}
Authentication
Public

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

POST /api/v1/public/csat/{token}
Authentication
Public

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

POST /api/v1/public/csp-report
Authentication
Public
Rate limit
csp_report

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

GET /api/v1/public/pay/gateways
Authentication
Public
Rate limit
pay_guest_gateways

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

POST /api/v1/public/pay/guest-checkout
Authentication
Public
Rate limit
pay_guest_init

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

POST /api/v1/public/pay/lookup
Authentication
Public
Rate limit
pay_guest_lookup

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

POST /api/v1/public/pay/recover
Authentication
Public
Rate limit
pay_guest_recover

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

GET /api/v1/public/pay/status/{state}
Authentication
Public
Rate limit
pay_status

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

GET /api/v1/public/pay/{gateway}/redirect/{tenant_id}/{token}/{outcome}
Authentication
Public
Rate limit
pay_return

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

GET /api/v1/public/pay/{gateway}/return/{state}
Authentication
Public
Rate limit
pay_return

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

POST /api/v1/public/pay/{gateway}/webhook/{tenant_id}/{secret}
Authentication
Public
Rate limit
pay_webhook

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

GET /api/v1/public/register/captcha
Authentication
Public
Rate limit
register_captcha

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

GET /api/v1/public/register/policy
Authentication
Public
Rate limit
register_policy

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

GET /api/v1/public/register/slug-available
Authentication
Public
Rate limit
slug_available

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

GET /api/v1/public/site/captcha
Authentication
Public
Rate limit
site_captcha

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

POST /api/v1/public/site/leads
Authentication
Public
Rate limit
site_leads

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

CONNECT /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

DELETE /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

GET /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

HEAD /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

OPTIONS /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

PATCH /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

POST /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

PUT /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

QUERY /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

TRACE /api/v1/public/sysbackup/{name}
Authentication
Public
Rate limit
sysbackup

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

POST /api/v1/public/telegram/{bot_kind}/webhook/{license_id}/{secret}
Authentication
Public

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.

Try it on your own network.

50 subscribers for 7 days. You pay nothing.