Skip to content

Using the API

The console, the CLIs and the MCP server all use the same API. You can call it too.

Base URL https://gw.dockhive.sh
Authentication Authorization: Bearer <api key> (see API keys)
Format JSON
Terminal window
export DOCKHIVE_API_KEY=dh_pat_...
curl https://gw.dockhive.sh/api/v1/auth/me -H "Authorization: Bearer $DOCKHIVE_API_KEY"

List calls return resources from every region, each with a region field. To target one region (for example when creating something, or acting on a database or n8n workspace), add the X-Region header or a region query parameter:

Terminal window
curl "https://gw.dockhive.sh/api/v1/databases?region=eu" -H "Authorization: Bearer $DOCKHIVE_API_KEY"
Method and path What it returns
GET /api/v1/regions Regions and their health. No key needed.
GET /api/v1/auth/me The signed-in account.
GET /api/v1/auth/billing/plans The plan catalog.
GET /api/v1/auth/billing/subscription Your current plan and subscription.
GET /api/v1/apps/projects Your apps.
GET /api/v1/databases Your databases.
GET /api/v1/hivepods/ Your HivePods (note the trailing slash).
GET /api/v1/n8n/instances Your n8n workspaces.
GET /api/v1/tunnels Your active tunnels.

Product pages show more calls where they’re useful, for example creating a database and managing its firewall.

Errors come back as JSON with a message, and often a code:

Status Code Meaning
401 Missing, expired or revoked key.
402 plan_limit Your plan’s limit is reached. The message says which.
403 email_unverified Verify your email address first.
403 account_suspended The account is suspended.
403 A read-only key tried to change something, or a key tried an account action.
429 Too many requests. Slow down and retry.

Requests are rate-limited per account. If you get 429, wait a moment and retry with backoff.