Skip to main content
ZStack
Monitoring & Collection/Monitoring Query & Overview

ValidateMonitoringQuery

Validate a query definition without executing it against the metrics backend

POST/api/v1/monitoring/query-builder/validate

Operation ID

ValidateMonitoringQuery

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

application/json

Body Fields

  • metric
    StringRequired

    Metric name to validate the query against

    Example: cpu_usage_percent

  • filters
    LinkedHashMapRequired

    Filter criteria to narrow down results

    Example: (nested object)

  • condition
    StringRequired

    Filter condition expression to validate

    Example: resource_type='vm'

  • timeRange
    StringRequired

    Time range for the query

    Example: 1h

  • aggregation
    StringRequired

    Aggregation function to validate

    Example: avg

Responses

200 OK
200 OK

On success, this API returns an empty JSON object {}.