Delivery endpoint API

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

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

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

YAML configuration

The delivery endpoint requires a YAML configuration - otherwise it cannot deliver cannot. Add the configuration to the folder your-light-module/restEndpoints/.

class: info.magnolia.rest.delivery.jcr.JcrDeliveryEndpointDefinition
implementationClass: info.magnolia.rest.delivery.jcr.v1.JcrDeliveryEndpoint
params:
  website:
    depth: 3
    includeSystemProperties: false
    nodeTypes:
      - mgnl:page
      - mgnl:area
      - mgnl:component
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: true
  dam:
    depth: 1
    includeSystemProperties: false
    nodeTypes:
      - mgnl:asset
      - mgnl:folder
    rootPath: /
    limit: 10
    bypassWorkspaceAcls: false

Methods

readNode

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

Request URL

..

Parameters

..

Example

...

queryNodes

..