Rest API Reference
Complete REST API endpoint reference with parameters, examples, and response codes. All endpoints are prefixed with the configured route (default: /api/v1).
Base URL
All endpoints are prefixed with: {site_url}/api/v1
Authentication
All endpoints except /auth/token and /auth/refresh require authentication via API Key, JWT Bearer token, or active session. See Authentication.
Common Response Codes
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (successful deletion) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict (ETag mismatch) |
| 422 | Validation Error |
| 429 | Rate Limited |
| 500 | Internal Server Error |
Authentication
Public endpoints for obtaining and refreshing JWT authentication tokens. These endpoints do not require prior authentication.
Pages
Endpoints for managing Grav pages including listing, creating, updating, deleting, moving, and reordering.
Media
Endpoints for managing media files attached to pages and site-level media.
Configuration
Endpoints for reading and updating Grav configuration scopes including system, site, plugins, and themes.
Users
Endpoints for managing user accounts including listing, creating, updating, and deleting users.
Package Manager
Endpoints for managing Grav packages (plugins and themes) via the GPM, including installation, removal, updates, and repository search.
System
Endpoints for system-level operations including information, cache management, translations, and blueprints.
Blueprints
Endpoints for retrieving blueprint schemas used for page templates, user accounts, and permission definitions.
Sidebar
Dashboard
Endpoints for dashboard data including statistics, notifications, news feed, and page view popularity.