Public reference

Portal

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

58 Endpoints

View as Markdown

Portal

58
PATCH /api/v1/portal/account
Authentication
Subscriber session
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/portal/auto-renew
Authentication
Subscriber session
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.

PUT /api/v1/portal/bucket-order
Authentication
Subscriber session
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/portal/captcha
Authentication
Public
Rate limit
portal_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/portal/cards/redeem
Authentication
Subscriber session
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/portal/change-profile
Authentication
Subscriber session
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/portal/config
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/portal/credentials
Authentication
Subscriber session

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

POST /api/v1/portal/deposit
Authentication
Subscriber session
Rate limit
portal_deposit

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

POST /api/v1/portal/exchange
Authentication
Public
Rate limit
portal_exchange

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

POST /api/v1/portal/extend
Authentication
Subscriber session
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/portal/extensions
Authentication
Subscriber session

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

GET /api/v1/portal/extensions/{id}
Authentication
Subscriber session

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

GET /api/v1/portal/guest/context
Authentication
Subscriber session
Rate limit
portal_guest

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

POST /api/v1/portal/guest/register
Authentication
Subscriber session
Rate limit
portal_guest

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

GET /api/v1/portal/invoices
Authentication
Subscriber session

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

GET /api/v1/portal/invoices/{id}
Authentication
Subscriber session

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

GET /api/v1/portal/invoices/{id}/render-data
Authentication
Subscriber session
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.

POST /api/v1/portal/join
Authentication
Public
Rate limit
portal_join

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

GET /api/v1/portal/join/context
Authentication
Public
Rate limit
portal_join

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

GET /api/v1/portal/ledger
Authentication
Subscriber session

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

POST /api/v1/portal/login
Authentication
Public
Rate limit
portal_login

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

GET /api/v1/portal/me
Authentication
Subscriber session

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

GET /api/v1/portal/parental
Authentication
Subscriber session

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

POST /api/v1/portal/parental/pause
Authentication
Subscriber session
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/portal/parental/pin
Authentication
Subscriber session
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.

PUT /api/v1/portal/parental/rules
Authentication
Subscriber session
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/portal/parental/unlock
Authentication
Public
Rate limit
portal_parental_unlock

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

POST /api/v1/portal/password
Authentication
Subscriber session
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/portal/payments/gateways
Authentication
Subscriber session

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

GET /api/v1/portal/payments/transactions
Authentication
Subscriber session

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

GET /api/v1/portal/profiles
Authentication
Subscriber session

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

POST /api/v1/portal/purchase
Authentication
Subscriber session
Rate limit
portal_deposit

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

DELETE /api/v1/portal/push-tokens
Authentication
Subscriber session
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/portal/push-tokens
Authentication
Subscriber session
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/portal/quota-buckets
Authentication
Subscriber session

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

POST /api/v1/portal/quote
Authentication
Subscriber session
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/portal/refresh
Authentication
Public
Rate limit
portal_refresh

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

POST /api/v1/portal/renew
Authentication
Subscriber session
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/portal/sessions
Authentication
Subscriber session

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

POST /api/v1/portal/signup
Authentication
Public
Rate limit
portal_signup

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

GET /api/v1/portal/signup/schema
Authentication
Public

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

DELETE /api/v1/portal/speed
Authentication
Subscriber session
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/portal/speed
Authentication
Subscriber session

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

PUT /api/v1/portal/speed
Authentication
Subscriber session
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/portal/telegram-exchange
Authentication
Public
Rate limit
portal_telegram_exchange

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

GET /api/v1/portal/tickets
Authentication
Subscriber session

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

POST /api/v1/portal/tickets
Authentication
Subscriber session
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/portal/tickets/form
Authentication
Subscriber session

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

GET /api/v1/portal/tickets/{id}
Authentication
Subscriber session

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

POST /api/v1/portal/tickets/{id}/attach
Authentication
Subscriber session
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/portal/tickets/{id}/attachments/{attId}
Authentication
Subscriber session
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/portal/tickets/{id}/attachments/{attId}
Authentication
Subscriber session

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

POST /api/v1/portal/tickets/{id}/messages
Authentication
Subscriber session
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/portal/tunnel-identify
Authentication
Public
Rate limit
portal_tunnel_identify

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

POST /api/v1/portal/tunnel-tenant
Authentication
Public
Rate limit
portal_tunnel_tenant

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

GET /api/v1/portal/usage
Authentication
Subscriber session

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.