dashboards

Update dashboard

Changed on Nov 2, 2026

Replaces the dashboard document for the UID. Set version to the current version, or overwrite: true to skip the check; a stale version returns 412. Creates the dashboard and returns 201 if the UID doesn't exist.

put/dashboards/uid/{uid}

Request

Base URL
https://api.axiom.co/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/dashboards/uid/:uid/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

uidstring required

Request body

labelIdsLabelID[]

Existing label IDs; replaces assignments when supplied, clears with [], and preserves them when omitted or null.

messagestring

overwriteboolean

uidstring

Stable external dashboard identifier (org-scoped unique).

versioninteger

Required for updates when overwrite is false.

Response

Updated dashboard

overwrittenboolean

status'created' | 'updated' required

Changes

Nov 2, 2026v2e3baf3b85e8d Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- info
  added the new optional request property
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 14, 2026v28920e1697284 Revision changes
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status

Operation history