Skip to main content
App methods provide read access to your Phala Cloud applications. An “app” is a logical grouping that can contain one or more CVMs (e.g., the primary instance and its replicas).

GetAppList

GET /apps Returns all applications for the authenticated user.
Returns: *GetAppListResponse containing:

GetAppInfo

GET /apps/{appId} Returns detailed information about a specific application, including its current CVM and profile.
Parameters: Returns: *AppInfo with these key fields:

GetAppCVMs

GET /apps/{appId}/cvms Returns all CVMs associated with an application. This is useful for apps that have replicas or multiple deployments.
Parameters: Returns: []GenericObject — a slice of CVM data as generic maps.

GetAppRevisions

GET /apps/{appId}/revisions Returns the revision history for an application. Each revision represents a configuration change (deploy, update, restart, etc.).
Parameters: PaginationOptions fields: Returns: *AppRevisionsResponse containing:

GetAppRevisionDetail

GET /apps/{appId}/revisions/{revisionId} Returns detailed information about a specific revision, including the full compose file and encrypted environment variables at that point in time.
Parameters: Returns: *AppRevisionDetail

GetAppAttestation

GET /apps/{appId}/attestations Returns TEE attestation data for an application, including certificates and TCB info.
Parameters: Returns: *AppAttestationResponse (generic map)

GetAppDeviceAllowlist

GET /apps/{appId}/device-allowlist Returns the device allowlist for an on-chain KMS application. This shows which TEE devices are authorized to run the app.
Parameters: Returns: *DeviceAllowlistResponse containing:

GetAppFilterOptions

GET /apps/filter-options Returns available filter options for the app list endpoint. Useful for building UI filters.
Returns: *AppFilterOptions (generic map)