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

CreateWarmupRule

Create a new cache warmup rule defining which queries to pre-warm

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Display name for the new warmup rule

    Example: Nightly Warmup

  • enabledBooleanRequired

    Whether to enable this rule immediately upon creation

    Example: true

  • queriesListRequired

    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

  • triggerStringRequired

    Trigger type for this rule (e.g. schedule, event)

    Example: schedule

  • priorityIntegerRequired

    Execution priority for this rule relative to others

    Example: 1

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

CreateWarmupRule

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/cache/warmup-rules' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Nightly Warmup","enabled":true,"queries":"(nested array)","trigger":"schedule","priority":1}'

Response Example

200
{
  "uuid": "rule-001-abc",
  "name": "Peak Hour Warmup",
  "enabled": true,
  "queries": [
    {}
  ],
  "trigger": "schedule",
  "createDate": "example"
}

Change History

This API has no change history records yet.

View all change history