Skip to Content
DocumentationAPI ReferenceDatabases

Databases

Managed database instances deployed as containers on your servers. Supports PostgreSQL, MySQL, MariaDB, Redis, and MongoDB.

Endpoints

MethodPathDescription
GET/api/v1/databasesList databases (?projectId=)
POST/api/v1/databasesCreate database
GET/api/v1/databases/:idGet database
PUT/api/v1/databases/:idUpdate database
DELETE/api/v1/databases/:idDelete database

Lifecycle

MethodPathDescription
POST/api/v1/databases/:id/startStart
POST/api/v1/databases/:id/stopStop
POST/api/v1/databases/:id/restartRestart

Info

MethodPathDescription
GET/api/v1/databases/:id/credentialsGet connection credentials
GET/api/v1/databases/:id/storageGet storage usage
GET/api/v1/databases/:id/metricsGet performance metrics
GET/api/v1/databases/:id/logsGet runtime logs
GET/api/v1/databases/:id/dependenciesGet dependencies

POST /api/v1/databases

{
  "project_id": "uuid",
  "environment_id": "uuid",
  "server_id": "uuid",
  "name": "my-postgres",
  "type": "postgres",
  "database_name": "app_db",
  "database_user": "app_user",
  "password": "securepassword",
  "backup_mode": "pitr",
  "pitr_enabled": true,
  "backup_destination_id": "uuid",
  "backup_schedule": "0 2 * * *",
  "connection_pooling": true,
  "memory_limit": "512m",
  "cpu_limit": "1.0"
}

Supported types: postgres, mysql, mariadb, redis, mongodb

Backup modes: none, scheduled, pitr (point-in-time recovery, PostgreSQL only)

PUT /api/v1/databases/:id

{
  "display_name": "Production DB",
  "memory_limit": "1g",
  "cpu_limit": "2.0"
}

Database Object

{
  "id": "uuid",
  "project_id": "uuid",
  "environment_id": "uuid",
  "server_id": "uuid",
  "name": "my-postgres",
  "type": "postgres",
  "database_name": "app_db",
  "database_user": "app_user",
  "status": "running",
  "memory_limit": "512m",
  "cpu_limit": "1.0",
  "backup_mode": "pitr",
  "pitr_enabled": true,
  "connection_pooling": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Status Values

running, stopped, provisioning, error, deleting

Last updated on
ApplicationsBuckets