Skip to content
Version
1.8 (Beta)
1.7 (Stable)
Current
1.8 (Beta)
Basics
What is Grav?
Requirements
Installation
Basic Tutorial
Configuration
Folder Structure
Getting Help
Updating Grav & Plugins
API
Getting Started
Authentication
Rest API Reference
Authentication
POST
Get Token
POST
Refresh Token
Pages
GET
List Pages
GET
Get Page
POST
Create Page
PATCH
Update Page
DELETE
Delete Page
POST
Move Page
POST
Reorder Pages
Media
GET
List Page Media
POST
Upload Page Media
DELETE
Delete Page Media
GET
List Site Media
POST
Upload Site Media
DELETE
Delete Site Media
POST
Create Media Folder
DELETE
Delete Media Folder
POST
Rename Site Media
POST
Rename Media Folder
Configuration
GET
List Config Sections
GET
Get Config
PATCH
Update Config
Users
GET
List Users
GET
Get User
POST
Create User
PATCH
Update User
DELETE
Delete User
POST
Upload Avatar
DELETE
Delete Avatar
POST
Generate 2FA Secret
GET
List API Keys
POST
Create API Key
DELETE
Revoke API Key
Package Manager
GET
List Plugins
GET
Get Plugin
POST
Install Package
POST
Remove Package
GET
Check Updates
GET
Search Repository
GET
List Themes
GET
Get Theme
POST
Update Package
POST
Update All Packages
GET
Browse Themes
GET
Get README
GET
Get Changelog
GET
Get Plugin Page
GET
Get Plugin Page Script
System
GET
System Info
POST
Clear Cache
GET
Get Translations
GET
List Blueprints
GET
Ping
GET
List Environments
GET
Get Logs
GET
Reports
Blueprints
GET
List Page Types
GET
Get Page Blueprint
GET
Get User Blueprint
GET
Get Permissions
GET
Get Plugin Page Blueprint
Sidebar
GET
Get Sidebar Items
Dashboard
GET
Dashboard Stats
GET
Page View Statistics
GET
Dashboard Notifications
GET
News Feed
Events
Developer Guide
Content
Pages
Headers / Frontmatter
Page Collections
Markdown Syntax
Page Linking
Image Linking
Media
Taxonomy
Modular Pages
Routing
Multi-Language
Content Types
Themes
Theme Basics
Theme Tutorial
Twig Primer
Twig Tags, Filters & Functions
Twig Tags
Twig Filters
Twig Functions
Theme Configuration
Theme Variables
Asset Manager
Customization
Administration Panel
Introduction
Dashboard
Configuration (System)
Configuration (Site)
Profile
User Accounts and Groups
User Accounts
User Groups
Configuration
Permissions
Pages
Editor (Content)
Editor (Options)
Editor (Advanced)
Editor (Security)
Configuration
Page Permissions
Plugins
Options
Themes
Security
2-Factor Authentication
Flood Protection
Tools
Extending
Admin Event Hooks
FAQ
Forms
Blueprints
Reference: Blueprint Form Fields
Example: Plugin Blueprint
Example: Plugin Configuration
Example: Page Blueprints
Example: Config Blueprints
How to: Add a file upload
Advanced Blueprint Features
Frontend Forms
Reference: Form Options
Reference: Form Field Index
Example: Contact Form
Reference: Form Actions
How to: Forms in modular pages
How to: Ajax Submission
CLI Console
Command Line Intro
Grav command
Plugin Command
GPM Command
Scripted Upgrades
Advanced
Flex Objects
Administration
Getting Started
Content Listing
Content Editor
Configuration
Using Flex Objects
Flex
Flex Directory
Flex Collection
Flex Object
Custom Directory Types
Blueprint
Performance & Caching
Debugging & Logging
Environment Configuration
Multisite Setup
Plugin Prioritization
Scheduler
Backups
Grav Development
Upgrading from Grav <1.6
Upgrading to Grav 1.6
Upgrading to Grav 1.7
Upgrading to Grav 1.8 beta
YAML Syntax
Groups and Permissions
Change the site URL
Web Servers & Hosting
Servers
Nginx
Grav Built-in Web Server
Shared
Rochen Web Hosting
WireNine
Crucial Web Hosting
SiteGround
Arvixe
Dreamhost
alwaysdata
Vps
DigitalOcean
Linode
RoseHosting
Vultr
Paas
Fortrabbit - PHP hosting
Heroku
Cloudways - Managed Cloud for PHP Hosting
Microsoft Azure
Dokku
Local Development with ddev
Deploying with Git
Php-built-in-web-server
Windows Subsystem for Linux
Cookbook
General Recipes
Twig Recipes
Plugin Recipes
Admin Recipes
Tutorials
Build a Blog
Troubleshooting
404 Not Found
Grav Server Error
500 Internal Server Error
403 Forbidden
Invalid Security Token
Permissions
Proxy issues
Common Problems
htaccess
Migration
Migrating from Drupal 7 to Grav
Migrating from WordPress to Grav
Security
Overview
Recommended Configuration
Users
Developers
Server-side
Reports
Hints and Tips
Blogging
Blogging Metadata
Grav CMS
Github
API
Powered by
Grav
+
Helios
ESC
Searching...
No results found
Try a different search term
Type at least 2 characters
Sidebar
1.8 (Beta)
Grav CMS
Github
API
Search
Ctrl
K
Home
API
Rest API Reference
Sidebar
Sidebar
Get Sidebar Items
Previous
Get Plugin Page Blueprint
Next
Get Sidebar Items
