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

CursorQuery

Begin a cursor-based paginated query over a resource collection.

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • resourceTypeString

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

  • sortString

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

  • orderString

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

  • pageSizeInteger

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

    Example: 0

  • filterList

    Filter

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

  • totalInteger

    Total number of records matching the query

    Example: 200

  • nextCursorString

    Opaque cursor token to use for the next page request

    Example: eyJsYXN0SWQiOiJ2bS0wNTAifQ==

  • hasMoreBoolean

    Whether additional records exist beyond this page

    Example: true

Endpoint

GET/api/v1/resources/cursor-query

/api/v1/resources/cursor-query

Operation ID

CursorQuery

Permalink

Request Example

curl -X GET '{host}/api/v1/resources/cursor-query' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [],
  "total": 200,
  "nextCursor": "eyJsYXN0SWQiOiJ2bS0wNTAifQ==",
  "hasMore": true
}

Change History

This API has no change history records yet.

View all change history