Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Monitoring Cache
POSTMonitoringSince 1.0SynchronousAuth Required

TriggerWarmup

Manually trigger a cache warmup cycle for all enabled rules

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.

  • statusString

    Current status of the warmup cycle (running, completed, failed)

    Example: running

  • totalQueriesInteger

    Total number of queries in this warmup cycle

    Example: 50

  • completedInteger

    Number of queries successfully completed

    Example: 30

  • failedInteger

    Number of queries that failed during warmup

    Example: 2

  • startTimeString

    Start time

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

  • etaString

    Estimated time to completion (e.g. 2m30s)

    Example: 2m30s

Endpoint

POST/api/v1/monitoring/cache/warmup

/api/v1/monitoring/cache/warmup

Operation ID

TriggerWarmup

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/cache/warmup' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "status": "running",
  "totalQueries": 50,
  "completed": 30,
  "failed": 2,
  "startTime": "example",
  "eta": "2m30s"
}

Change History

This API has no change history records yet.

View all change history