Skip to main content

Get Started

This document provides an overview of the Quave Cloud API and how to use it.

Base URL​

The base URL for all requests is https://api.quave.cloud/v1.

Authentication​

To authenticate requests, set the Authorization header with either the user or env token. However, some endpoints accept only the user token.

You can get your user token from your profile page and the env token from your app's env settings page.

Environment-Specific Endpoints​

For endpoints that require environment context (most app environment management endpoints), you must provide an environment identifier along with your token. You can use either:

  • envName - The CLI environment name (e.g., account-myapp-production)
  • appEnvId - The ID of the app environment

Both parameters can be provided in the query string (for GET requests) or request body (for POST/PUT/PATCH/DELETE requests). If both are provided, appEnvId takes precedence.

Example with envName:

curl -X GET \
    -H 'Authorization: YOUR_TOKEN' \
    'https://api.quave.cloud/api/public/v1/app-env/status?envName=myapp-production'

Example with appEnvId:

curl -X GET \
    -H 'Authorization: YOUR_TOKEN' \
    'https://api.quave.cloud/api/public/v1/app-env/status?appEnvId=5f7b1b7b7b7b7b7b7b7b7b7b'

Request Processing​

Some requests are processed asynchronously.
In such cases, the response will be { "status": "Ok" }, but the operation will continue in the background.
Even if the response is successful, the operation may still be in progress.

For example, if you try to remove a host that doesn't exist, the response will still be { "status": "Ok" }, but the host will not be removed.