📄️ Get Started
This document provides an overview of the Quave ONE API and how to use it.
📄️ App Environment Backups API
The App Environment Backups API lets you inspect and configure logical database backups and volume snapshot recovery points for a Quave ONE app environment.
📄️ Disaster Readiness API
For the dashboard flow (enable protection, Validate now, Activate as live,
📄️ Account Access Review API
The Account Access Review API exposes Quave ONE platform access-review evidence for compliance workflows: account members, pending invitations, MFA coverage, environment-access summaries, and account audit events.
📄️ Accounts API
The Accounts API allows you to manage accounts in Quave ONE. You can create, retrieve, list, and delete accounts.
📄️ Agent Automations API
The Agent Automations API lets you manage the same scheduled agent automations that are available in the Quave ONE dashboard: list options, create or edit automations, pause/resume, delete, run once, and inspect run history.
📄️ Alerts API
The Alerts API allows you to manage alerts and contact points in Quave ONE. Alerts notify you when your applications experience issues like high CPU, memory problems, or other conditions.
📄️ App Environment Configuration API
The App Environment Configuration API allows you to manage configuration settings for app environments in Quave ONE, including git branch, health checks, security settings, and environment name.
📄️ App Environment Deployments API
The App Environment Deployments API allows you to manage deployments, builds, and lifecycle operations for app environments in Quave ONE.
📄️ App Environment History API
The App Environment History API allows you to retrieve the deployment history and activity timeline for an app environment in Quave ONE. This is useful for understanding when deployments occurred, tracking changes over time, and finding deployment times for log filtering.
📄️ App Environment Job Runs API
The Job Runs API lets customers run finite workloads in Quave ONE. A Job is a first-class workload type, separate from long-running Apps, Databases & Services, and Functions. Each run creates a visible JobRun with status, logs, timing, and exit-code metadata.
📄️ App Environment Management API
The App Environment Management API allows you to manage resources, scaling, and apply pending changes to app environments in Quave ONE.
📄️ App Environment Metrics API
The App Environment Metrics API allows you to retrieve real-time resource usage metrics (CPU, memory, containers) for an app environment in Quave ONE.
📄️ App Environment Metrics Time Series API
The App Environment Metrics Time Series API allows you to retrieve historical metrics data from Prometheus for an app environment in Quave ONE. Unlike the Metrics API, which returns a current snapshot, this endpoint returns time-series data that can be used for trend analysis, charting, and performance monitoring over time.
📄️ App Environment MongoDB Query Analysis API
The MongoDB Query Analysis API reads the profiler of a MongoDB database managed by Quave ONE and tells you which queries cost the most time, which ones scan too many documents, and which indexes are missing or unused.
📄️ App Environment Pods API
The App Environment Pods API allows you to retrieve pod-level details for an app environment in Quave ONE. This provides granular information about individual container instances, useful for debugging and understanding pod health.
📄️ App Environment Region API
The App Environment Region API allows you to change the region of app environments in Quave ONE. Changing regions is a complex operation that requires proper DNS (CNAME) configuration.
📄️ App Environment Status API
The App Environment Status API allows you to get the current runtime status and health of an app environment in Quave ONE.
📄️ App Environment Traces API
The App Environment Traces API lets you search and read the distributed traces (OpenTelemetry, stored in Tempo) of an app environment in Quave ONE. Use it to find which requests fail or are slow, and then open a trace to see every span with its timing, status and key attributes.
📄️ App Environment Variables API
The App Environment Variables API allows you to manage environment variables for app environments in Quave ONE.
📄️ App Environments API
The App Environments API allows you to manage app environments in Quave ONE. You can create, retrieve, and delete app environments.
📄️ Apps API
The Apps API allows you to manage apps in Quave ONE. You can create, retrieve, and delete apps.
📄️ Code API
The Code API provides endpoints to handle code uploads so you can trigger new builds and deployments via API to your app's environments.
📄️ Credentials API
The Credentials API allows you to manage account-level credentials in Quave ONE. Credentials store sensitive material your apps and environments need at runtime — Docker registry logins, HTTP basic-auth users, TLS certificates and ACME wildcard configurations.
📄️ Hosts API
The Hosts API allows you to manage hosts in your app env. You can create, update, and remove hosts.
📄️ LLM Provider Keys API
The LLM Provider Keys API manages the BYOK provider keys used by Quave ONE agent conversations and automations.
📄️ Logs API
The Logs API allows you to retrieve logs from your app environments in Quave ONE.
📄️ MCP Keys API
The MCP Keys API manages the same user-owned MCP keys shown on the dashboard MCP page. Keys support two server-enforced authorization modes:
📄️ Node Pools API
The Node Pools API lets a Connect account see how its node pools scale and
📄️ Agent Sandboxes API
The Agent Sandboxes API lets you provision isolated gVisor sandboxes for agent workloads in Quave ONE. Sandboxes are created from versioned sandbox templates whose immutable revisions pin the image, resources, persistence mode, and lifetime limits, and Quave ONE owns the whole sandbox lifecycle: allocation, idle termination, hard-lifetime expiry, pause and resume, and termination.
📄️ Shared Volumes API
The Shared Volumes API lets you manage Shared Storage programmatically: list the Storage Servers your account can create volumes on, connect your own S3-compatible bucket as an object storage Storage Server and update it later (hub token, hub URL, file owner), and create, list, remove, and restore shared volumes. A shared volume can be mounted by app environments (see useNfsVolume in the App Env API or the MCP tool update-app-env-volume) and by Agent Sandboxes (volumeName).
📄️ Tokens API
The Tokens API allows you to retrieve CLI tokens for your user profile and app environments. These are sensitive operations that require appropriate permissions.