Skip to main content
ZStack
Infrastructure/Infrastructure Misc

ExecuteZQL

Execute a ZQL (ZStack Query Language) expression against the resource store.

POST/api/v1/zql

Operation ID

ExecuteZQL

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

  • zql
    StringRequired

    ZQL expression to execute against the resource store

    Example: query VmVO where state = 'Running' limit 10

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • data
    Object

    The data value

    Example: (nested object)

ZQL Guidance

Start from the example request below and adapt the query expression carefully.