Skip to main content
ZStack
Infrastructure/Infrastructure Misc

CursorQuery

Start a new cursor-based query and return its first page. When hasMore is true, call GET /api/v1/resources/cursor-next?cursor={nextCursor}&pageSize={pageSize} using the returned nextCursor. Calling cursor-query again starts a new query.

GET/api/v1/resources/cursor-query

Operation ID

CursorQuery

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

Query Parameters

  • resourceType
    String

    Type of resource to query (e.g. vm, host, volume) Type of resource to query (e.g. vm, host, volume)

  • sort
    String

    Field name to sort results by Field name to sort results by

  • order
    String

    Sort direction: asc or desc Sort direction: asc or desc

  • pageSize
    Integer

    Number of records to return per page Number of records to return per page

    Example: 0

  • filter
    List

    Filter

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

  • total
    Integer

    Total number of records matching the query

    Example: 200

  • nextCursor
    String

    Opaque cursor token to use for the next page request

    Example: eyJsYXN0SWQiOiJ2bS0wNTAifQ==

  • hasMore
    Boolean

    Whether additional records exist beyond this page

    Example: true