Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
   eZ Publish 4.x / legacy

eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

The eZ Publish 5 REST API allows you to interact with an eZ Publish installation using the HTTP protocol, following a REST interaction model.

Accessing the REST API

The REST API is available at the URI /api/ezp/v2. The API from eZ Publish 4.x remains available at the same URI, /api/ezp/v1. HTTPS is available as long as your server is properly configured. Refer to the Getting started page to start using the API.


The API provides a set of resources ( URIs), each of them providing access to operations on a certain resource. For instance, the URI /content/objects/59 will allow you to interact with the Content with ID 59, while /content/types/1 will allow you to interact with the ContentType with ID 1.


It uses HTTP verbs (GET, POST, but also PUT, DELETE, ...), as well as HTTP headers to specify the type of request. Depending on the used HTTP verb, different actions will be possible. Example:

  • GET /content/objects/2 will provide you with data about Content #2,
  • PATCH /content/objects/2 will update the Content #2's metadata (section, main language, main location...),
  • DELETE /content/objects/2 will delete Content #2,
  • COPY /content/objects/2 will create a copy of this Content.