Documentation›API Reference›Database Endpoints

Database Endpoints

Provision, scale, and manage your databases with automatic backups and monitoring

Database Management Overview

Fully managed database service with automatic scaling, backups, and monitoring. Support for PostgreSQL, MySQL, and MongoDB.

Engines

PostgreSQLMySQLMongoDB

Sizes

SmallMediumLargeXL

Features

Auto-backups, Scaling, Monitoring

Quick Actions

Create Database

Provision a new managed database with your preferred engine and size.

POST /databases

Monitor Performance

Track CPU, memory, and storage usage with real-time metrics.

GET /databases/:id

Manage Backups

Create manual backups and manage retention policies.

GET /databases/:id/backups

Database Sizes

Small$29/mo

CPU1 vCPU

Memory2 GB

Storage20 GB SSD

Medium$89/mo

CPU2 vCPU

Memory4 GB

Storage100 GB SSD

Large$199/mo

CPU4 vCPU

Memory8 GB

Storage500 GB SSD

XL$499/mo

CPU8 vCPU

Memory16 GB

Storage1 TB SSD

API Endpoints

GET/databases

List all managed databases for the authenticated user

Response

{
  "success": true,
  "databases": [
    {
      "id": "db_123",
      "name": "my-database",
      "engine": "postgresql",
      "version": "15.0",
      "status": "running",
      "region": "us-east-1",
      "size": "small",
      "storage": "20GB",
      "created_at": "2024-01-15T10:30:00Z",
      "connection_string": "postgresql://user:***@db-host:5432/dbname",
      "metrics": {
        "cpu_usage": 45,
        "memory_usage": 67,
        "storage_usage": 23
      }
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}

POST/databases

Create a new managed database

Request Body

{
  "name": "my-production-db",
  "engine": "postgresql",
  "version": "15.0",
  "size": "medium",
  "region": "us-east-1",
  "backup_enabled": true,
  "multi_az": false
}

GET/databases/:id

Get details of a specific database

Response

{
  "success": true,
  "database": {
    "id": "db_123",
    "name": "my-database",
    "engine": "postgresql",
    "version": "15.0",
    "status": "running",
    "region": "us-east-1",
    "size": "small",
    "storage": "20GB",
    "created_at": "2024-01-15T10:30:00Z",
    "last_backup": "2024-12-02T02:00:00Z",
    "connection_info": {
      "host": "db-host.vpnenterprise.com",
      "port": 5432,
      "database": "my_database",
      "ssl_required": true
    },
    "metrics": {
      "cpu_usage": 45,
      "memory_usage": 67,
      "storage_usage": 23,
      "connections": {
        "active": 12,
        "max": 100
      }
    }
  }
}

PUT/databases/:id

Update database configuration

Request Body

{
  "size": "large",
  "backup_enabled": true,
  "backup_retention": 30
}

DELETE/databases/:id

Delete a database (irreversible action)

Response

{
  "success": true,
  "message": "Database deletion initiated",
  "id": "db_123",
  "final_backup": "backup_final_db_123_20241202",
  "deletion_scheduled": "2024-12-02T16:00:00Z"
}

GET/databases/:id/backups

List backups for a specific database

Response

{
  "success": true,
  "backups": [
    {
      "id": "backup_123",
      "database_id": "db_123",
      "type": "automatic",
      "status": "completed",
      "size": "2.5GB",
      "created_at": "2024-12-02T02:00:00Z",
      "expires_at": "2024-12-32T02:00:00Z"
    }
  ],
  "total": 30
}

POST/databases/:id/backups

Create a manual backup of the database

Request Body

{
  "name": "pre-migration-backup",
  "description": "Backup before major schema changes"
}

Best Practices

Auto-Scaling

Enable auto-scaling to handle traffic spikes automatically. Monitor CPU and memory usage to determine optimal scaling policies.

Regular Backups

Implement automated daily backups with proper retention policies. Test backup restoration procedures regularly.

Security

Always use SSL connections and regularly rotate database credentials. Implement proper network security groups.

Next Steps

Continue exploring our API to build comprehensive cloud infrastructure solutions.