Getting Started
Introduction

Getting Started

Welcome to Cloudheed! This guide will help you get up and running with our managed PostgreSQL service.

What is Cloudheed?

Cloudheed is a managed PostgreSQL database platform that lets you:

  • Create databases instantly - Spin up PostgreSQL instances in seconds
  • Scale on demand - Upgrade resources with zero downtime
  • Monitor everything - Real-time metrics and query insights
  • Secure by default - SSL, IP allowlisting, and encryption at rest

API Overview

The Cloudheed API follows RESTful conventions:

  • Base URL: https://api.cloudheed.com
  • Authentication: Bearer token or API key
  • Content-Type: application/json
  • Rate Limiting: 1000 requests/minute

Response Format

All responses follow this structure:

{
  "data": { ... },
  "meta": {
    "request_id": "req-abc123"
  }
}

Error Handling

Errors include a code and message:

{
  "error": {
    "code": "validation_error",
    "message": "Invalid email format",
    "details": [
      {
        "field": "email",
        "message": "Must be a valid email address"
      }
    ]
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
422Validation Error
429Rate Limited
500Server Error