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

AcquireDashboardLock

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

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

Body Fields

  • userIdStringRequired

    UUID of the user requesting the lock

    Example: user-001-abc

Responses

200 OK

On success, this API returns the following response structure.

  • lockIdString

    Unique identifier of the edit lock

    Example: lock-001-abc

  • dashboardIdString

    UUID of the dashboard this lock applies to

    Example: dash-001-abc

  • heldByString

    User ID holding the lock

    Example: user-001-abc

  • acquiredAtString

    Acquired at

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

  • expiresAtString

    Expires at

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

  • isExpiredBoolean

    Whether the lock has expired

    Example: false

Endpoint

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

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

Operation ID

AcquireDashboardLock

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/dashboards/{dashboardId}/lock' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"userId":"user-001-abc"}'

Response Example

200
{
  "lockId": "lock-001-abc",
  "dashboardId": "dash-001-abc",
  "heldBy": "user-001-abc",
  "acquiredAt": "example",
  "expiresAt": "example",
  "isExpired": false
}

Change History

This API has no change history records yet.

View all change history