PHphala
Apps

List apps

Changed on

Returns paginated app list with filtering. Response schema varies by API version.

get/api/v1/apps

Request

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page

searchstring nullable

Search name, app_id, vm_uuid, instance_id

statusstring[] nullable

CVM status filter

listedboolean nullable

Listed status filter

base_imagestring nullable

OS image name filter

instance_typestring nullable

Instance type filter

instance_typesstring[] nullable

Instance type list filter (one or many)

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

Instance family 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

summary_onlyboolean

Skip per-app KMS display fields and revision timestamps; for count/pagination-only callers

Response

Paginated app list

OR

Example response

{
  "dstack_apps": [
    {
      "id": "prj_0123abcd",
      "current_cvm": {
        "kms_id": "kms_0123abcd",
        "kms_contract_id": "kc_0123abcd"
      },
      "cvms": [
        {
          "kms_id": "kms_0123abcd",
          "kms_contract_id": "kc_0123abcd"
        }
      ]
    }
  ]
}

Changes

  • c71a8dc90391Revision changes
    • 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 summary_only

    • info

      added to the response body anyOf list for the response status

    • info

      removed from the response body anyOf list for the response status