Endpoint Configuration Details

Every Datahub configuration creates a separate endpoint with its own settings and its own data. The following configuration options are possible for each endpoint.

The API meant for other systems is the REST endpoint under /pimcore-datahub-webservices/simplerest, not the Studio API that backs the configuration panel itself.

General

See type and name of configuration and define description and if the endpoint is active or not.

Schema Definition

Define available data entities and their schema (= available fields) for the endpoint. Also define if assets should be considered in tree items and search requests and if originals and/or what thumbnails should be used for delivery.

The asset settings govern delivery as well as indexing: the download-asset endpoint and the MCP asset resources hand out only the variants configured here. With "Allow original image" switched off, the original of an image cannot be downloaded, and only the thumbnails listed here can be requested by name. Assets that the endpoint does not index at all cannot be downloaded through it either.

"Allow original image" applies to images only. For documents, videos and every other non-image type the endpoint publishes only the original, so it is always delivered, and asking for a thumbnail of such an asset is rejected rather than answered with the original.

Two caveats worth knowing:

• For SVG assets, Pimcore resolves a thumbnail whose configuration does not rasterize SVG to the original file, so publishing such a thumbnail also makes the original SVG bytes reachable even with "Allow original image" switched off.
• The variant settings are read from the current configuration, so changing them takes effect immediately. The binaryData entries in search and MCP tool output come from the index and still list the previously published variants until the endpoint is re-indexed; those links are refused when followed. Workspaces behave differently on the two routes: the MCP asset resources re-check the workspace on every read, while download-asset relies on index membership, so a narrowed workspace only takes effect there once the endpoint has been re-indexed.

Workspaces

Define workspaces for assets and data objects and so manage what data should be actually exposed via the endpoint. It is possible to include and explicitly exclude folders.

Label Settings

Define nice looking labels for different languages for each field. Each request includes the labels for used fields in response in an additional data structure. They then can be used by the client application.

Additionally define what fields will be considered for aggregation calculation for facet navigation.

note

The field list is built from indexed data. Save the configuration and process the index queue to see an up-to-date list here. The current queue status is shown in the bottom toolbar of the configuration editor.

Delivery Settings

Define (or generate) an API key for securing the endpoint. This API key needs to be sent as security header with every request.

Experimental: Optionally enable MCP Server to expose the endpoint to AI agents via Model Context Protocol. The same API key is used for both REST and MCP authentication. See MCP Server Integration for details.