What's next from Grafana Labsbreadcrumb arrow Deprecation notice for legacy dashboard star and unstar API endpoints
What's next from Grafana Labs
What's next from Grafana Labs
Deprecation notice
Open Source Enterprise Dashboards and visualizations
Announcement
2026-08-27
Planned rollout in Cloud
2026-09-24
Targeted self-managed release
grafana-v13.3.0

Deprecation notice for legacy dashboard star and unstar API endpoints

The dashboard-specific endpoints for starring and unstarring a dashboard are deprecated in favor of the generic Collections Stars API, which stars any kind of resource through one shared endpoint shape instead of a separate endpoint per resource kind.

The old endpoints still work, but are now marked deprecated:

  • POST /api/user/stars/dashboard/uid/{dashboard_uid} (star a dashboard)
  • DELETE /api/user/stars/dashboard/uid/{dashboard_uid} (unstar a dashboard)

The replacement is:

  • PUT /apis/collections.grafana.app/v1alpha1/namespaces/{namespace}/stars/user-{your_user_uid}/update/dashboard.grafana.app/Dashboard/{dashboard_uid} (star)
  • DELETE /apis/collections.grafana.app/v1alpha1/namespaces/{namespace}/stars/user-{user_uid}/update/dashboard.grafana.app/Dashboard/{dashboard_uid} (unstar)

No request body is needed; the star target is fully described by the URL path.

Why we’re changing it

Starring used to need one endpoint per resource kind. The new Collections Stars API stars any resource kind (dashboards today, with other kinds such as folders already supported) through the same endpoint shape, so integrations that work with starring don’t need a separate code path for every type of resource.

What to know before this rolls out

  • If you call POST or DELETE on the deprecated path directly (outside the Grafana UI), plan to move to PUT/DELETE on the new path.

  • Look up your own user UID from the uid field of GET /api/user to build the user-{uid} resource name; it is not your username or numeric user ID.

  • Use the same {namespace} you already use for other Grafana App Platform APIs (default for the default organization on self-managed, or your stack’s namespace on Grafana Cloud).

  • Treat 200 OK as success for both star and unstar, and 204 No Content as a no-op success when unstarring something that was never starred.