Skip to content

docs: document API key auth for color palette endpoints #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document API key auth for color palette endpoints #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions references/workspace/customizing-the-appearance-of-your-project.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,37 @@ Open the dashboard settings modal to pick a palette for a dashboard. Tiles in th
### Setting a chart-level palette

In the chart editor, the palette picker is at the top of the **Series** tab (cartesian and pie charts) and the **Steps** tab (funnel charts). The preview reflects the staged palette before you save; the override only persists when you click **Save changes**.

## Managing color palettes via the API

You can create, update, delete, and set the active color palette through the Lightdash API. These endpoints accept either a logged-in session or a [personal access token](/references/workspace/personal-tokens), which lets you manage palettes from scripts, CI jobs, or other automations without a browser session.

All endpoints live under `/api/v1/org/color-palettes` and require organization admin permissions:

| Method | Endpoint | Purpose |
| -------- | ---------------------------------------------- | ------------------------------------ |
| `POST` | `/color-palettes` | Create a new palette |
| `PATCH` | `/color-palettes/{colorPaletteUuid}` | Update an existing palette |
| `DELETE` | `/color-palettes/{colorPaletteUuid}` | Delete a palette |
| `POST` | `/color-palettes/{colorPaletteUuid}/active` | Set a palette as the active palette |

Pass your token in the `Authorization` header as `ApiKey ldpat_{{your_personal_access_token}}`.

```bash Create a color palette
curl -X POST \
-H "Authorization: ApiKey ldpat_{{your_personal_access_token}}" \
-H "Content-Type: application/json" \
-d '{
"name": "Brand palette",
"colors": ["#FF6B6B", "#4ECDC4", "#45B7D1", "#FFA07A", "#98D8C8"]
}' \
https://{{your_lightdash_url}}/api/v1/org/color-palettes
```

```bash Set a palette as active
curl -X POST \
-H "Authorization: ApiKey ldpat_{{your_personal_access_token}}" \
https://{{your_lightdash_url}}/api/v1/org/color-palettes/{{colorPaletteUuid}}/active
```

See the [API reference](/api-reference/v1/introduction) for full request and response schemas.
Loading