Skip to main content

API Reference

The FoundryDB REST API gives you full programmatic control over your services.

OpenAPI Specification​

The interactive API reference is available at:

https://api.foundrydb.com/api-docs

The spec covers all endpoints for:

  • Service management (create, update, scale, delete)
  • Database users and credentials
  • Backups and point-in-time restore
  • Node management (replicas, failover)
  • Configuration tuning
  • Metrics and alerts
  • Billing and organizations

Authentication​

All requests use HTTP Basic Auth:

curl -u admin:your_password https://api.foundrydb.com/managed-services

Base URL​

https://api.foundrydb.com

Example: List services​

curl -u admin:password https://api.foundrydb.com/managed-services
{
  "services": [
    {
      "id": "abc123",
      "name": "my-pg",
      "database_type": "postgresql",
      "status": "running",
      "version": "17"
    }
  ]
}