開放 API

Zeabur 的開放 API 是使用 GraphQL 建置的。它是驅動我們的 Dashboard 和 CLI 的相同 API。

連結端點

你可以透過以下端點造訪 Zeabur API：

https://gateway.zeabur.com/graphql

認證

為了開始使用 Zeabur API，你需要建立一個帳戶並生成一個 API 金鑰。你可以透過造訪 Developer Panel 來建立一個。

你也可以查看這篇文件來獲取更多關於如何生成 API 金鑰的資訊。

curl --request POST \
  --url https://gateway.zeabur.com/graphql \
  --header 'Authorization: Bearer {YOUR_API_TOKEN}' \
  --header 'Content-Type: application/json' \
  --data '{"query":"query { me { username } }"}'

支援

如果你遇到任何問題或者對 API 有任何建議，我們鼓勵你加入我們的 Discord 伺服器。在那裡，你可以直接與正在開發 API 的工程師交流。

在這裡加入我們的 Discord 伺服器。

Schema

把程式碼部署到 Zeabur

你可以使用部署 API 在不連接 GitHub 儲存庫的情況下部署你的程式碼。你可以使用這個 API 從你的本地機器或者任何其他來源部署你的程式碼。

為了在 Zeabur 上部署程式碼，你需要一個專案 ID，服務 ID 和環境 ID。你可以從 Dashboard 或者 CLI 獲取這些 ID，或者透過 API 建立一個新的專案和服務。

然後你需要把你的程式碼壓縮成 zip 文件並傳送給 API。

curl --request POST \
  --url https://gateway.zeabur.com/projects/{PROJECT_ID}/services/{SERVICE_ID}/deploy \
  --header 'Authorization: Bearer {YOUR_API_TOKEN}' \
  --data '{"code": {YOUR_CODE_AS_ZIP_FILE}, "environment": {ENVIRONMENT_ID}}'

查詢專案

curl --request POST \
  --url https://gateway.zeabur.com/graphql \
  --header 'Authorization: Bearer {YOUR_API_TOKEN}' \
  --header 'Content-Type: application/json' \
  --data '{"query":"query { projects { _id name } }"}'

💡

開放 API 的 Schema 和文檔仍在開發中。我們會盡快更新這個頁面。

如果你想現在就能夠開始使用開放 API，你可以加入我們的 Discord 伺服器尋求幫助。

使用 API Key 專用伺服器