Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Make authenticated HTTP requests to the Qovery API directly from the CLI. This command acts as a lightweight, curl-like client that automatically handles authentication and supports context variable interpolation. Context variables {organizationId}, {projectId}, and {environmentId} are automatically replaced with values from the current CLI context (set via qovery context).

​
Usage

qovery api <endpoint> [flags]
The <endpoint> is the API path relative to the Qovery API base URL (e.g., organization, organization/<id>/project).

​
Options

FlagDescription
-f, --fieldAdd a key=value pair to the JSON body (repeatable, smart type coercion)
-H, --headerAdditional request headers in Key: Value format (repeatable)
-i, --includePrint HTTP response status and headers before body
--inputBody: - for stdin (pipe JSON to command)
-X, --methodHTTP method (GET, POST, PUT, PATCH, DELETE)
--helpShow help

​
Examples

​
List Resources

# List organizations
qovery api organization

# Get a specific organization
qovery api organization/<id>

​
Use Context Variables

When you have an active CLI context, placeholder variables are automatically resolved: 
# List projects in current organization
qovery api organization/{organizationId}/project

# List services in current environment
qovery api organization/{organizationId}/project/{projectId}/environment/{environmentId}/service

​
Create Resources with —field

Build a JSON body from key=value pairs: 
qovery api organization --field name=my-org --field plan=FREE

​
Send a JSON Body from Stdin

# Pipe JSON directly
echo '{"name":"my-org","plan":"FREE"}' | qovery api organization --input -

# Send a JSON file as body
qovery api organization/<id>/project --input - < body.json

​
Delete a Resource

qovery api organization/<id> --method DELETE

​
Show Response Headers

qovery api organization --include

​
Add Custom Headers

qovery api organization -H "X-Request-Id: abc123"

​
Use a Custom API URL

QOVERY_API_URL=https://staging.api.qovery.com qovery api organization