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

GetDashboardLockConfig

Retrieve the global dashboard lock configuration (TTL, force unlock policy)

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • lockTtlMinutesInteger

    Lock time-to-live in minutes before auto-expiry

    Example: 15

  • allowForceUnlockBoolean

    Whether administrators can forcefully release other users' locks

    Example: true

  • requireIfMatchHeaderBoolean

    Whether clients must send an If-Match version header on updates

    Example: false

Endpoint

GET/api/v1/monitoring/dashboards/lock/config

/api/v1/monitoring/dashboards/lock/config

Operation ID

GetDashboardLockConfig

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/dashboards/lock/config' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "lockTtlMinutes": 15,
  "allowForceUnlock": true,
  "requireIfMatchHeader": false
}

Change History

This API has no change history records yet.

View all change history