Skip to main content

​
Overview

Vertra Cloud’s public API allows you to manage applications, databases, workspaces and other resources programmatically. All operations available in the dashboard can be performed via API. Base URL: https://api.vertracloud.app

​
Authentication

All API requests require authentication via Bearer token. To get your API key:
  1. Visit https://vertracloud.app/dashboard/settings
  2. Click “Request API Key”
  3. Copy the generated token
Include the token in the Authorization header of all requests: 
curl -H "Authorization: Bearer YOUR_TOKEN" \
     https://api.vertracloud.app/v1/users/@me

​
Response Format

Most API responses follow this format: Success: 
{
  "response": { ... }
}
Error: 
{
  "code": "ERROR_CODE",
  "message": "Optional descriptive message"
}

​
Common Error Codes

CodeDescription
UNAUTHORIZEDToken missing or invalid
FORBIDDENNo permission to access the resource
APP_NOT_FOUNDApplication not found
DATABASE_NOT_FOUNDDatabase not found
PLAN_RESTRICTED_FEATUREFeature not available on your plan
INVALID_PARAMETERInvalid parameter in request

​
Rate Limiting

Request limits vary according to your subscription plan. Check your plan details for more information.
When the limit is reached, the API returns HTTP status 429 Too Many Requests. We recommend implementing retry logic with exponential backoff.

​
Available Resources

Users

Query information about the authenticated user.

Applications

Manage complete application lifecycle: creation, deployment, start/stop, files, environment variables, snapshots and domains.

Databases

Manage databases: creation, start/stop, reset, metrics and credentials.

Workspaces

Manage workspaces: creation, members, permissions and resource association.