The REST content API for apps
This folder is for app developers who read or write content through the REST content API of Exponential. The API
comes from the ezprestapi extension; one provider serves the prefixes ezp and ezpl, reads answer at v1 and
v2, writes at v2 only (REST API v1 and v2: one extension).
Contents
The base URL
https://example.com/api/ezp/v2/<route>/api is rest.ini [System] ApiPrefix; ezp the provider prefix (ezpl is an alias with the same routes); v1 or
v2 the version. Every example in the guides calls it directly below the host, as above.
What an app can do with it
| Task | Route | Versions |
|---|---|---|
| Read a node or object, with metadata, locations and fields | GET /content/node/<id>, GET /content/object/<id> | v1, v2 |
| List the children of a node, paged and sorted | GET /content/node/<id>/list/... | v1, v2 |
| Count the children | GET /content/node/<id>/childrenCount | v1, v2 |
| Read all fields or one field | GET .../fields, GET .../field/<identifier> | v1, v2 |
| Create and publish | POST /content/node/create | v2 |
| Remove | DELETE /content/node/delete/<id> | v2 |
Pages in this folder
| Page | Answers |
|---|---|
| Your first request | How to make and check the first authenticated call |
| Routes reference | Every route with method, versions and controller action |
| Reading a node | One node or object, its metadata and links |
| Response groups | How to ask for locations and fields |
| Listing children and pagination | Lists, paging, sorting and counts |
| Fields and field values | The field object and how values are written per datatype |
| Rendered XHTML output | OutputFormat=xhtml and the templates it needs |
| Creating and removing content | The two v2 writes and their answers |
| Errors and status codes | Every status your client must handle |
| API versions v1 and v2 | Which version to call and the deprecated provider |
Before you start
- You need a credential: the API requires authentication by default (Authentication).
- You need an installation where
ezprestapiis active: probe it first (Probe before you build). - The routes are the same for every client language; the examples use
curlso they can be pasted into a shell.
Related pages
- REST API v1 and v2 for applications
- REST API v1 and v2: one extension
- ezprestapi
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.