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
  • Object storage (Files), including per-bucket storage usage over time
  • Billing and organizations

Authentication​

Requests authenticate with either an API token (recommended for integrations) or HTTP Basic Auth:

# API token (Bearer)
curl -H "Authorization: Bearer $FOUNDRYDB_TOKEN" https://api.foundrydb.com/managed-services

# HTTP Basic Auth
curl -u admin:your_password https://api.foundrydb.com/managed-services

API tokens can be restricted to specific resource families and access levels, so an integration only gets the access it needs. See API Token Scopes for the scope reference and token recipes.

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"
    }
  ]
}