API Keys and Public Deployment API

Use this guide when you need to grant external automation access to deployment workflows.

API Keys Page

Route: /dashboard/organization/api-keys

Use this page to:

• Create scoped API keys for external automation
• Set optional expiration timestamps
• Revoke keys immediately
• Copy example curl commands for indexer and channel deployment workflows

Available scopes:

• deployments:read
• deployments:write

Public API Surface

Base routes:

• GET /api/public/v1/deployments/indexer
• POST /api/public/v1/deployments/indexer
• GET /api/public/v1/deployments/indexer/[id]
• GET /api/public/v1/deployments/channel
• POST /api/public/v1/deployments/channel
• GET /api/public/v1/deployments/channel/[id]

Authentication:

• Send Authorization: Bearer <API_KEY>
• Use read-only keys for inventory and status polling
• Use write-enabled keys only in trusted automation environments

Example Flows

List indexer deployments

curl -H "Authorization: Bearer <API_KEY>" \
  "https://your-app.example.com/api/public/v1/deployments/indexer?limit=20&offset=0"

Create a channel deployment

curl -X POST \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{"name":"channel-prod-01","template":"dubhe-channel-api","rpcUrl":"https://...","syncTimeSeconds":5}' \
  "https://your-app.example.com/api/public/v1/deployments/channel"

Rotation Guidance

• Name keys after the integration or environment using them
• Set expiration for temporary keys wherever possible
• Store the full token in a secret manager, not in source control
• Revoke and replace keys during incident response instead of reusing a suspected credential

Related Pages

• Public API Reference
• Permissions and Tenant Model
• Webhooks and Integrations
• Channel Lab: Managed Dubhe Channel Deployments