Sending your key
Put the key in theX-API-Key header:
Query parameter fallback
?api_key=dlk_live_... also authenticates, for contexts where you cannot set a header.
Creating a key
1
Open the dashboard
Go to Settings → API Keys in the Dashlink dashboard.
2
Create the key
Give it a name describing where it will be used —
zapier-production, internal-reporting — so you can revoke the right one later without guessing.3
Choose a type
REST API (
dlk_live_) for dashboard endpoints. Dynamic Link (dlk_sdk_) for the native SDK. A Dynamic Link key cannot call REST; a REST key cannot authenticate JSON resolve.4
Choose a scope and permissions
See below. Narrower is better. Dynamic Link keys are locked to All for resolve and tracking only.
5
Copy it now
The key is shown once. Dashlink stores only a SHA-256 hash of it, so it genuinely cannot be shown again — if you lose it, you create a new one and revoke the old.
Key format
REST keys:dlk_live_ for /api/v1, dlk_sdk_ for JSON resolve only. A Dynamic Link key on REST returns 401. A REST key on edge JSON resolve returns 401.
Types
Create the type in Settings → API Keys → Type. Scope (organization vs self) is a separate field.
Scopes
A key’s scope decides whose data it can reach.
Most integrations want
organization, because links created by a departed colleague should not fall out of your integration’s view.
Permissions
Permissions decide what the key can do.- all
- read_only
- restricted
Read and write across every module. Convenient, and the right choice only when the integration genuinely does everything.
Restricted keys
A restricted key is granted a permission level per module:
Levels are
read, write and all, in increasing order — write implies read, and all implies both.
App dynamic links are Shortlinks underneath, so they are covered by the
shortlinks grant rather than a module of their own.analytics accepts only read. There is no analytics write path, so a write grant there would promise something that does not exist.When authentication fails
A
403 on a restricted key almost always means the module grant is missing or is read where the call needs write.
Keeping keys safe
REST keys never in apps
REST keys never in apps
A dashboard REST key (
dlk_live_) in a browser or APK can mutate the workspace. Call REST from your backend. The exception is a Dynamic Link key (dlk_sdk_…): it must live in the app so JSON resolve can authenticate, and it cannot call REST.Use separate keys per integration
Use separate keys per integration
One key per system means revoking a compromised key takes down one integration rather than all of them, and access logs tell you which system did what.
Grant the narrowest permission that works
Grant the narrowest permission that works
A reporting key with
read_only cannot delete your links even if the code that holds it has a bug.Rotate by overlapping
Rotate by overlapping
Create the new key, deploy it, confirm traffic has moved, then revoke the old one. Revoking first means downtime.