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

ListWarmupRules

List all configured cache warmup 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.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the warmup rule

      Example: rule-001-abc

    • nameString

      Display name of the warmup rule

      Example: Peak Hour Warmup

    • enabledBoolean

      Whether this warmup rule is currently active

      Example: true

    • queriesList

      Queries for this resource

      Example: (nested array)

      • metricString

        Name of the metric to pre-warm in cache

        Example: cpu_usage_percent

      • aggregationString

        Aggregation function to use (e.g. avg, max, sum)

        Example: avg

      • timeRangeString

        Time range for the warmup query (e.g. 1h, 24h)

        Example: 1h

      • priorityInteger

        Execution priority; lower value means higher priority

        Example: 1

    • triggerString

      Trigger condition for this rule (e.g. schedule, manual)

      Example: schedule

    • createDateString

      Create date

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

  • totalInteger

    Total number of warmup rules

    Example: 5

  • limitInteger

    Maximum number of items returned per page

    Example: 20

  • offsetInteger

    Number of items skipped before this page

    Example: 20

Endpoint

GET/api/v1/monitoring/cache/warmup-rules

/api/v1/monitoring/cache/warmup-rules

Operation ID

ListWarmupRules

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/cache/warmup-rules' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 5,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history