Skip to main content
Version: 2026.2

Pimcore Datahub Simple Rest API

This extension adds a simple read-only rest API endpoint to Pimcore Datahub for assets and data objects. All exposed data can be configured, is indexed in OpenSearch or Elasticsearch (based on your configuration) and delivered from there for better query performance and scalability.

Use it to connect Pimcore to other systems or to frontend applications.

Features in a Nutshell​

  • Schema and exposed data configuration like with other Datahub adapters
  • Data indexed in and delivered from OpenSearch or Elasticsearch indices, so the three query endpoints put no additional load on the database
  • Endpoint documentation and test via Swagger UI
  • Four available endpoints:
    • tree-items: loads all elements of a tree level
    • search: searches elements, returns elements of all types, no folder structures
    • get-element: gets one single element by type and id
    • download-asset: delivers the binary of one asset, as original or as a configured thumbnail. This endpoint checks the index for access, then loads the asset from the database and streams the file from storage, so unlike the three query endpoints it does hit the database.
  • Endpoint security via bearer token that has to be sent as a header with every request.
  • MCP Server (Experimental): Model Context Protocol support for AI agent integration

SwaggerSwaggerSwagger Datahub Simple Rest API available endpoints

Documentation Overview​

Further Information​

On other Pimcore Datahub extensions: