Skip to main content
ZStack
Monitoring & Collection/Monitoring Cache

ListWarmupRules

List all configured cache warmup rules

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

Operation ID

ListWarmupRules

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • uuid
      String

      Unique identifier of the warmup rule

      Example: rule-001-abc

    • name
      String

      Display name of the warmup rule

      Example: Peak Hour Warmup

    • enabled
      Boolean

      Whether this warmup rule is currently active

      Example: true

    • queries
      List

      Queries for this resource

      Example: (nested array)

      • metric
        String

        Name of the metric to pre-warm in cache

        Example: cpu_usage_percent

      • aggregation
        String

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

        Example: avg

      • timeRange
        String

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

        Example: 1h

      • priority
        Integer

        Execution priority; lower value means higher priority

        Example: 1

    • trigger
      String

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

      Example: schedule

    • createDate
      String

      Create date

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

  • total
    Integer

    Total number of warmup rules

    Example: 5

  • limit
    Integer

    Maximum number of items returned per page

    Example: 20

  • offset
    Integer

    Number of items skipped before this page

    Example: 20