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

QueueGrafanaChange

Queue a Grafana operation change to be applied when connectivity is restored

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • operationStringRequired

    Type of operation to queue (create, update, delete)

    Example: update

  • resourceIdStringRequired

    UUID of the Grafana resource to apply the change to

    Example: dash-001-abc

  • payloadStringRequired

    JSON payload of the change

    Example: {}

  • queuedByStringRequired

    User ID queueing this change

    Example: user-001-abc

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the queued change

    Example: qc-001-abc

  • operationString

    Type of operation queued (create, update, delete)

    Example: update

  • resourceIdString

    UUID of the Grafana resource targeted by this change

    Example: dash-001-abc

  • payloadString

    JSON payload of the change to be applied

    Example: {}

  • queuedAtString

    Queued at

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

  • queuedByString

    User ID who queued this change

    Example: user-001-abc

  • retryCountInteger

    Number of sync retry attempts made for this change

    Example: 20

  • statusString

    Current status of this queued change (pending, retrying, conflict)

    Example: pending

Endpoint

POST/api/v1/monitoring/grafana/sync/queue

/api/v1/monitoring/grafana/sync/queue

Operation ID

QueueGrafanaChange

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/grafana/sync/queue' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"operation":"update","resourceId":"dash-001-abc","payload":"{}","queuedBy":"user-001-abc"}'

Response Example

200
{
  "id": "qc-001-abc",
  "operation": "update",
  "resourceId": "dash-001-abc",
  "payload": "{}",
  "queuedAt": "example",
  "queuedBy": "user-001-abc",
  "retryCount": 20,
  "status": "pending"
}

Change History

This API has no change history records yet.

View all change history