Skip to main content
API Explorer|API Explorer
Infrastructure/Infrastructure Misc
POSTInfrastructureSince 1.0SynchronousAuth Required

ExecuteZQL

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

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • zqlStringRequired

    ZQL expression to execute against the resource store

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

Responses

200 OK

On success, this API returns the following response structure.

  • dataObject

    The data value

    Example: (nested object)

ZQL Guidance

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

Endpoint

POST/api/v1/zql

/api/v1/zql

Operation ID

ExecuteZQL

Permalink

Request Example

curl -X POST '{host}/api/v1/zql' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"zql":"query VmVO where state = 'Running' limit 10"}'

Response Example

200
{
  "data": null
}

Change History

This API has no change history records yet.

View all change history