Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- License Hub
Community
Partners

Try
Buy

View all results ›

Formatting text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Config options
- Urls
- Roots
- Requirements
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- QrCode
- Query
- Str
- Tpl
- Url
- V
- Xml

GET /api/site

Retrieve information about the site
PATCH /api/site/

Update the site content
GET /api/site/children

List all subpages
POST /api/site/children

Create a new subpage
GET|POST /api/site/:id/search

Search for pages (index)
GET /api/site/blueprints

List all allowed blueprints for site
GET /api/site/files

List files
POST /api/site/files

Upload a new file
PATCH /api/site/files/sort

Sort files
GET /api/site/files/:filename

Retrieve a file
GET|POST /api/site/:id/files/search

Search for site files
PATCH /api/site/files/:filename

Update file content
DELETE /api/site/files/:filename

Delete a file
PATCH /api/site/files/:filename/name

Rename a file
GET /api/site/files/:filename/sections/:name

Retrieve a file section
GET /api/site/sections/:name

Retrieve a site section
PATCH /api/site/title

Change the site title
POST /api/site/changes/discard

Discard unsaved changes for site
POST /api/site/changes/publish

Publish unsaved changes for site
POST /api/site/changes/save

Update unsaved changes for site
POST /api/site/files/:filename/changes/discard

Discard unsaved changes for file
POST /api/site/files/:filename/changes/publish

Publish unsaved changes for file
POST /api/site/files/:filename/changes/save

Update unsaved changes for file

`GET` /api/site/blueprints

List all allowed blueprints for site

Query parameters

Parameter	Example	Description
`section`	`?section=gallery`	List blueprints for this section.

Did you find an error? Help us improve our docs and edit this page on GitHub. Make sure to check out our styleguide

Edit this page on GitHub

Kirby

The CMS that adapts to any project. Made for developers, designers, creators and clients.

🇪🇺 Made in Europe

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- Pixels
- License Hub
Community
Kirby
- Security
- Privacy
- License
- Presskit
- Team
- Contact
With support of