Skip to main content

​
getAppList

GET /apps Returns a paginated, filterable list of apps. Parameters:
FieldTypeRequiredDescription
pagenumberNoPage number
page_sizenumberNoItems per page (max 100)
searchstringNoSearch by name
statusstring[]NoFilter by status
listedbooleanNoFilter by public listing
base_imagestringNoFilter by OS image
instance_typestringNoFilter by instance type
kms_slugstringNoFilter by KMS slug
kms_typestringNoFilter by KMS type
nodestringNoFilter by node
regionstringNoFilter by region
Returns: Paginated list of apps (version-aware schema). Example: 
const apps = await client.getAppList({
  page: 1,
  page_size: 20,
  status: ["running"],
});

​
getAppInfo

GET /apps/{app_id} Returns detailed information about a specific app. Parameters:
FieldTypeRequiredDescription
app_idstringYesApp identifier
Returns: AppInfo — version-aware app details.

​
getAppCvms

GET /apps/{app_id}/cvms Returns the list of CVMs associated with an app. Parameters:
FieldTypeRequiredDescription
app_idstringYesApp identifier
Returns: Array of CVM objects.

​
getAppRevisions

GET /apps/{app_id}/revisions Returns the revision history for an app. Parameters:
FieldTypeRequiredDescription
app_idstringYesApp identifier
Returns: Array of app revisions.

​
getAppRevisionDetail

GET /apps/{app_id}/revisions/{revision_id} Returns details about a specific app revision. Parameters:
FieldTypeRequiredDescription
app_idstringYesApp identifier
revision_idstringYesRevision identifier
Returns: AppRevisionDetail — revision details including compose file and configuration.

​
getAppFilterOptions

GET /apps/filter-options Returns the available filter values for app list queries. Parameters: None Returns: AppFilterOptions — available values for status, base_image, instance_type, kms_slug, etc. Example: 
const filters = await client.getAppFilterOptions();
console.log("Available statuses:", filters.statuses);
console.log("Available regions:", filters.regions);