Skip to content

Returns all registered routes in the application.

GET
/api/server/routes

This can be used by the frontend to dynamically generate URLs using vue-router or to synchronize
client-side routing with server-side routes.

                  Routes are separated into:
                  - api: API routes (paths starting with /api/)
                  - routes: Regular page/controller routes (all other routes)

                  Note: The route collection is cached since getRouteCollection() is slow.
                  - Production: 24 hours cache (routes don't change at runtime)
                  - Development: 10 seconds cache (for faster testing)
                  - Cache is automatically invalidated when version changes (deployment)

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Responses

Success - Returns all routes separated into API and regular routes

application/json
JSON
{
"version": "string",
"api": [
{
"name": "string",
"path": "string",
"methods": [
"string"
],
"parameters": [
"string"
]
}
],
"routes": [
{
"name": "string",
"path": "string",
"methods": [
"string"
],
"parameters": [
"string"
]
}
]
}

Playground

Authorization

Samples

cURL
JavaScript
PHP
Python