Skip to main content
Effective Date — May 7, 2026
As part of the IAM hierarchy simplification, a new format of the TIR APIs is now available. All endpoints that previously included /teams/:team_id segment will now follow a service-centric structure, with project_id now passed as a query parameter instead of a path segment. You can read more about this change

Instance / VM List

Returns a paginated list of compute resources in the project.

Use the kind query parameter to filter by compute type: pass kind=vm to return only Virtual Machines, or kind=container to return only container-based Instances. You must also pass is_advanced_search=true for the kind filter to take effect — without it, the filter is ignored and all resources are returned.

GET/notebooks/

Query parameters

  • project_idQueryintegerrequired

    Project ID

  • active_iamQueryintegeroptional

    Active IAM ID (To access contact person account) Find your Active IAM ID here

  • locationQuerystringrequired

    Location

  • kindQuerystringoptional

    Filter results by compute type. Pass kind=vm to return only Virtual Machines, or kind=container to return only container-based Instances.

    Important: This filter only takes effect when is_advanced_search=true is also passed. Without it, the kind parameter is ignored and all resources are returned.

  • page_noQueryintegeroptional

    The page number from which you want your page search results to be displayed.

  • per_pageQueryintegeroptional

    Number of results per page

  • order_byQuerystringoptional
  • is_advanced_searchQuerybooleanoptional

    Specifies if advanced filters should be applied.

  • instance_categoryQuerystringrequired
  • nameQuerystringoptional

    Filter by name. Requires is_advanced_search=true to take effect.

  • statusQuerystringoptional

    Filter by resource status. Requires is_advanced_search=true to take effect.

  • customQuerystringoptional

    Filter by image type. Requires is_advanced_search=true to take effect.

  • sku seriesQuerystringoptional

    Filter by SKU series. Requires is_advanced_search=true to take effect.

  • sku_typeQuerystringoptional

    Filter by SKU type. Requires is_advanced_search=true to take effect.

Responses

200Successful response with node details
object
codeinteger
example200
messagestring
exampleSuccess
total_page_numberinteger
example1
total_countinteger
example1
dataarray
errorsobject