API overview

Everything in the Flokk dashboard is available via REST API. Use it to provision databases, manage extensions, rotate credentials, and read metrics programmatically.

Base URL

https://api.flokk.dev/api/v1

Authentication

Two methods, both via the Authorization header:

API keys (all tiers)

Generate keys in the dashboard under API keys. Keys start with sk_live_.

curl -H "Authorization: Bearer sk_live_Ab3xYz..." \
  https://api.flokk.dev/api/v1/databases

K8s service account tokens (Pro + Dedicated)

Register your cluster's OIDC issuer in the dashboard, then use projected SA tokens. See the Kubernetes guide.

Request format

All request bodies are JSON. Set Content-Type: application/json.

Response format

All responses are JSON. Successful responses return 2xx. Errors return a JSON object with an error field:

{
  "error": "database not found"
}

Rate limits

API requests are rate-limited per API key. Current limits:

EndpointLimit
Read (GET)60 requests/minute
Write (POST/PUT/DELETE)20 requests/minute
Credential exchange10 requests/minute

Pagination

List endpoints return all results (no pagination). This may change as the API matures.

No results found.