This command is marked as unstable and may change in future releases.
Command: phala api
Syntax
phala api [options] <endpoint>
Description
Make an authenticated HTTP request to Phala Cloud API.
Arguments
| Argument | Description |
|---|
<endpoint> | API endpoint path |
Options
| 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 |
Global Options
| Option | Description |
|---|
-h, --help | Show help information for the current command |
-v, --version | Show CLI version |
--api-token TOKEN, --api-key TOKEN | API token used for authentication |
-j, --json, --no-json | Output in JSON format |
--api-version <value> | API version to use (e.g. 2025-10-28, 2026-01-21) |
Examples
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
- Query params + body combined
phala api /endpoint -X POST -f page=1 -F name=foo
phala api /endpoint -X POST -F config:=@settings.json
