Developer Tools

Developer Resources

Zeabur provides a comprehensive set of APIs and developer tools for programmatic service management, deployment automation, and integration with your own applications.

API Overview

Zeabur’s API is built on GraphQL, powering the Dashboard, CLI, and all first-party products. REST endpoints are also available for specific operations (file uploads, container operations, etc.).

APIPurposeEndpoint
GraphQL APIProject / Service / Environment management, deployments, logshttps://api.zeabur.com/graphql
Upload APIDeploy ZIP archives via Pre-signed URLhttps://api.zeabur.com/v2/upload
Email REST APIEmail sending & managementhttps://api.zeabur.com/api/v1/zsend
💡

Full non-GraphQL API specs (JSON Schema / OpenAPI) are available at the Schema Repository.

Authentication

All APIs use Bearer Token authentication. Generate a key at Dashboard > Settings > API Keys, then include it in the Authorization header:

curl -X POST https://api.zeabur.com/graphql \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":"query { me { username } }"}'

See API Keys for detailed instructions.

Real-Time Subscriptions

Need to stream logs or listen for project activity? Zeabur provides WebSocket real-time subscriptions via the graphql-ws protocol.

  • Global endpoint: wss://api.zeabur.com/graphql
  • China endpoint: wss://api.zeabur.cn/graphql

For connection details, authentication flow, and code examples, see WebSocket Subscriptions.

Tools

  • Zeabur CLI: Log in and deploy services from your terminal with npx zeabur.
  • Apollo Explorer: Browse and test all GraphQL APIs online. You can also download the full Schema for IDE integration.

Product-Specific APIs

Some Zeabur products have their own API documentation: