helix api

​

Usage

helix api get <path>
helix api post <path> [--body '<json>']
helix api patch <path> [--body '<json>']
helix api delete <path>

​

Subcommands

​

Arguments

​

Options

​

Behavior

• Only absolute /v1/... paths are accepted. Absolute URLs and direct gateway paths (the database endpoint used with application keys) are rejected.
• The response is printed on stdout as syntax-highlighted, pretty-printed JSON, or as compact JSON with --json.
• The command uses the same rotating WorkOS session as all other Cloud commands.
• If the API rejects an expired token before handling the request, the CLI refreshes the session and retries once. No other failure is retried.

​

Examples

helix api get /v1/workspaces
helix api post /v1/example --body '{"value":"example"}'
helix api patch /v1/example --body '{"value":"updated"}'
helix api delete /v1/example

​

Related

• helix auth — log in before calling the API.
• helix workspace — list workspaces without a raw API call.
• Helix Cloud workflow — end-to-end Cloud usage.