Skip to main content
ZStack
Monitoring & Collection/Grafana Dashboards

AcquireDashboardLock

Acquire an exclusive edit lock on a dashboard to prevent concurrent edits

POST/api/v1/monitoring/dashboards/{dashboardId}/lock

Operation ID

AcquireDashboardLock

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 acquire a lock on

Body Fields

  • userId
    StringRequired

    UUID of the user requesting the lock

    Example: user-001-abc

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • lockId
    String

    Unique identifier of the edit lock

    Example: lock-001-abc

  • dashboardId
    String

    UUID of the dashboard this lock applies to

    Example: dash-001-abc

  • heldBy
    String

    User ID holding the lock

    Example: user-001-abc

  • acquiredAt
    String

    Acquired at

    Example: 2026-01-15T08:00:00Z

  • expiresAt
    String

    Expires at

    Example: 2026-01-15T08:00:00Z

  • isExpired
    Boolean

    Whether the lock has expired

    Example: false