Skip to main content
Version: 2026.2

Configuration

Create a Datahub configuration of type "Headless Documents" in Pimcore Studio to expose a set of Headless Documents through the search endpoint. It has four tabs.

General​

Basic settings for the configuration:

  • Active: activate or deactivate the configuration.
  • Name: name of the configuration. It becomes part of the search endpoint URL.
  • Description: description of the configuration.
  • Group: group of the configuration, displayed in the Datahub configuration list (tree).

Workspaces​

Restrict the configuration to specific document paths. Add a path with the + Add button, either by typing it or by dragging a folder from the document tree.

datahub_workspaces.pngdatahub_workspaces.pngdatahub_workspaces.png

Use the checkbox in the Read column to include or exclude a workspace.

Delivery Settings​

Configure the API keys and see the search endpoint URL.

datahub_delivery_settings.pngdatahub_delivery_settings.pngdatahub_delivery_settings.png

Click Generate API Key next to the API Keys field to generate a new key. The field accepts multiple keys, one per line; any of them authenticates a request, see Search Endpoint.

Permissions​

Grant access to the configuration itself, per user or role, in the Role Permissions and User Permissions tables. Add an entry with the Add button, then set its Read, Update, and Delete columns.

datahub_permissions.pngdatahub_permissions.pngdatahub_permissions.png

If neither table has any entry, access falls back to the plugin_datahub_adapter_headlessDocuments permission, see Installation for the full permission model.