Page History

This page explains Use the delivery endpoint, which can be used API to obtain JCR data as JSON.

The endpoint provides two REST resources - readNode and queryNodes - both must be called with HTTP 

The delivery endpoint can be configured via YAML. Its next version will allow multiple configurations which can be distinguish by URL path parameter.

readNode

Returns a node including its properties and child nodes down to a certain depth.

Request URL

..

Parameters

..

Example

...

queryNodes

..

This REST resource is customizable and flexible to use.

Two versions of the delivery endpoint exist. Both versions can resolve references to nodes of other JCR workspaces. But only version 2 can deliver localized content.

Delivery endpoint v2

Version 2 was introduced with Magnolia REST 2.1 and provides more flexibility. You can use it to define multiple endpoint configurations, deliver localized content and resolve references to nodes of other workspaces including assets and asset renditions.

See Delivery endpoint API v2.

Delivery endpoint v1

Version 1 was introduced with Magnolia REST 2.0. You can configure a single endpoint for your project.

See Delivery endpoint API v1.