Skip to main content
ZStack
Monitoring & Collection/Grafana Dashboards

CheckDashboardVersion

Check whether the client's expected version matches the current dashboard version to prevent stale writes

POST/api/v1/monitoring/dashboards/{dashboardId}/version-check

Operation ID

CheckDashboardVersion

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • dashboardId
    StringRequired

    UUID of the dashboard to check the version of

Body Fields

  • expectedVersion
    IntegerRequired

    Version number the client expects the dashboard to be at

    Example: 5

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • match
    Boolean

    Whether the client version matches the server version

    Example: true

  • currentVersion
    Integer

    Current server-side version of the dashboard

    Example: 5

  • requestVersion
    Integer

    Client-supplied expected version

    Example: 5

  • diffSummary
    String

    Summary of differences if versions do not match

    Example: 2 panels added, 1 removed

  • errorCode
    String

    Machine-readable error code for version conflicts

    Example: INVALID_CONFIG