Skip to content

Commit be07aa5

Browse files
committed
Add minimum required endpoints for embedding
Document API endpoints that must be whitelisted for embedding dashboards behind a reverse proxy or firewall. Generated-By: mintlify-agent
1 parent 2ac33a9 commit be07aa5

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

references/embedding.mdx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,35 @@ This document provides complete API reference for JWT structure and configuratio
2222

2323
Embedded Lightdash content is available to view by anyone (not just folks with a Lightdash login). Content is secured using JWT (JSON Web Tokens) with configurable expiration times.
2424

25+
## Minimum required endpoints for embedding
26+
27+
If you're running Lightdash behind a reverse proxy or firewall, the following endpoints must be whitelisted for embedding to work. The embed system uses JWT-based authentication via the `Lightdash-Embed-Token` HTTP header, separate from Lightdash's session-based auth.
28+
29+
### SPA entry point and static assets
30+
31+
| Endpoint | Description |
32+
|----------|-------------|
33+
| `/embed/*` | SPA entry point that serves the embed UI |
34+
| `/assets/*` | Static assets (JS, CSS, fonts, images) |
35+
36+
### API endpoints
37+
38+
| Method | Endpoint | Description |
39+
|--------|----------|-------------|
40+
| GET | `/api/v1/health` | App config, feature flags, embedding settings (unauthenticated) |
41+
| GET | `/api/v1/user/account` | Loads the anonymous embed account with its permissions |
42+
| GET | `/api/v1/org` | Org-level settings (appearance/theming) |
43+
| GET | `/api/v1/projects/*` | Project config and explore/table metadata |
44+
| GET | `/api/v1/saved/*` | Chart definitions for each dashboard tile |
45+
| POST | `/api/v1/embed/*` | Embed-specific endpoints (dashboard, tile queries, filters, totals) |
46+
| GET | `/api/v2/projects/*/query/*` | Query result polling and pagination |
47+
| POST | `/api/v2/projects/*/query/*` | Query execution |
48+
| GET | `/api/v2/feature-flag/*` | Runtime feature toggles |
49+
50+
<Info>
51+
All API endpoints except `/api/v1/health` require JWT authentication via the `Lightdash-Embed-Token` header. The JWT scopes access to only the specific dashboard/chart and project in the token.
52+
</Info>
53+
2554
## Known limitations
2655

2756
- Embedding only works for dashboards and charts directly. To embed explores, use the `canExplore` flag in a dashboard.

0 commit comments

Comments
 (0)