Phala Cloud Documentation — Confidential AI on TEE

This command is marked as unstable and may change in future releases.

phala api [options] <endpoint>

Make an authenticated HTTP request to Phala Cloud API.

Argument	Description
`<endpoint>`	API endpoint path

Option	Description
`-X, --method <value>`	HTTP method (default: GET)
`-f, --query <value>`	Query parameter: key=value (use key=@file to read from file)
`-F, --field <value>`	Body field: key=value (string) or key:=value (typed JSON). Supports @file
`-H, --header <value>`	HTTP header: key:value
`-d, --data <value>`	Request body data (cURL-style)
`--input <value>`	Read body from file (use ”-” for stdin)
`-i, --include`	Print response headers
`-q, --jq <value>`	Filter output with jq expression
`--silent`	Don’t print response body

Option	Description
`-h, --help`	Show help information for the current command
`-v, --version`	Show CLI version
`--api-token TOKEN, --api-key TOKEN`	API token for authenticating with Phala Cloud
`-j, --json, --no-json`	Output in JSON format
`--interactive`	Enable interactive mode for commands that support it
`--cvm-id <value>`	CVM identifier (UUID, app_id, instance_id, or name)
`--api-version <value>`	API version to use (e.g. 2025-10-28, 2026-01-21)

phala api /cvms

phala api /cvms/app_xxx

phala api /cvms -q '.items[].name'

phala api /endpoint -f status=active -f page=2

phala api /endpoint -X POST -F name=foo -F count:=10

phala api /endpoint -X POST -d '{"foo":"bar"}'

phala api /endpoint -X POST --input data.json

phala api /endpoint -X POST -f page=1 -F name=foo

phala api /endpoint -X POST -F config:=@settings.json

phala api /cvms -i