The Images endpoint fetches images from the content repository.
Introduction
The Delivery API 2.0's Images endpoint fetches images from the content repository.
API Base URL
https://<your_brx_host>.bloomreach.io/delivery/site/v2/images
Authorization
The Delivery API 2.0 Images endpoint is public by default. Optionally, customers can configure the endpoint to be accessible only for authorized access using a JSON Web Token (JWT).
Reference
- Get image by id or path
- Get Images by query
- Schemas
- Open API Specification (JSON) (Open in Swagger)
- Delivery API 2.0 Development Aids
- Delivery API 2.0 Query Operators
Example Queries
- Get all images:
https://developers.bloomreach.io/delivery/site/v2/images/ - Get all images in a folder:
https://developers.bloomreach.io/delivery/site/v2/images/?folder=/channel-templates - Get images by id:
https://developers.bloomreach.io/delivery/site/v2/images?id=8a847a9b-c983-4df0-9258-1201db3f5cf1 - Get images by path:
https://developers.bloomreach.io/delivery/site/v2/images?path=/channel-templates,/brxsaas/pages/home - Filter images by modified timestamp:
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified=1602703215008 - Filter images by specific field (e.g., height):
https://developers.bloomreach.io/delivery/site/v2/images?height=300 - Filter images published after a certain timestamp:
https://developers.bloomreach.io/delivery/site/v2/images?lastModified(gt)=1602703215008 - Filter images published after or at a certain timestamp (greater or equal than):
https://developers.bloomreach.io/delivery/site/v2/documents?lastModified(gte)=1602703215008 - Filter images published before a certain timestamp:
https://developers.bloomreach.io/delivery/site/v2/images?lastModified(lt)=1602703215008 - Filter images published before or at a certain timestamp (less or equal than):
https://developers.bloomreach.io/delivery/site/v2/images?lastModified(lte)=1602703215008