Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Grafana Dashboards
POSTGrafanaSince 1.0SynchronousAuth Required

CheckDashboardVersion

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • dashboardIdStringRequired

    UUID of the dashboard to check the version of

Body Fields

  • expectedVersionIntegerRequired

    Version number the client expects the dashboard to be at

    Example: 5

Responses

200 OK

On success, this API returns the following response structure.

  • matchBoolean

    Whether the client version matches the server version

    Example: true

  • currentVersionInteger

    Current server-side version of the dashboard

    Example: 5

  • requestVersionInteger

    Client-supplied expected version

    Example: 5

  • diffSummaryString

    Summary of differences if versions do not match

    Example: 2 panels added, 1 removed

  • errorCodeString

    Machine-readable error code for version conflicts

    Example: INVALID_CONFIG

Endpoint

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

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

Operation ID

CheckDashboardVersion

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/dashboards/{dashboardId}/version-check' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"expectedVersion":5}'

Response Example

200
{
  "match": true,
  "currentVersion": 5,
  "requestVersion": 5,
  "diffSummary": "2 panels added, 1 removed",
  "errorCode": "INVALID_CONFIG"
}

Change History

This API has no change history records yet.

View all change history