PHphala
CVMs

List CVMs (paginated)

Changed on

Returns paginated CVMs in current workspace with total count.

get/api/v1/cvms/paginated

Request

Query parameters

family'all' | 'cpu' | 'gpu'

Filter by instance family

instance_typesstring[] nullable

Filter by one or more instance type IDs

searchstring nullable

Search name, app_id, vm_uuid, instance_id

statusstring[] nullable

CVM status filter

base_imagestring nullable

OS image name filter

kms_slugstring nullable

KMS slug filter

kms_typestring nullable

KMS type filter

nodestring nullable

Node name filter (matches teepod or node name)

regionstring nullable

Region identifier filter

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max 100)

Response

Paginated CVM list with total count

OR

Changes

  • c71a8dc90391Revision changes
    • breaking

      response property anyOf[subschema #1: PaginatedHostedCvms]/items/items/managed_user/anyOf[subschema #1: ManagedUser]/id list-of-types was widened by adding types string to media type application/json of response 200

    • warning

      deleted the query request parameter teepod_id

    • warning

      deleted the query request parameter user_id

    • warning

      added the new local enum value to the //// response property for the response status

    • info

      the endpoint scheme security APIKeyHeader was removed from the API

    • info

      added the new optional query request parameter base_image

    • info

      added the new optional query request parameter family

    • info

      added the new optional query request parameter instance_types

    • info

      added the new optional query request parameter kms_slug

    • info

      added the new optional query request parameter kms_type

    • info

      added the new optional query request parameter node

    • info

      added the new optional query request parameter region

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added to the ////// response property anyOf list for the response status

    • info

      removed from the ////// response property anyOf list for the response status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status