跳到內容
Piora

API 總覽

Piora 提供完整的 REST API，讓你可以透過程式化方式管理伺服器、應用、資料庫與其他資源。API 適合用於自動化工作流程、整合第三方服務、或建立自訂管理工具。

API 基礎

Section titled “API 基礎”

Base URL

Section titled “Base URL”
https://app.piora.dev/api/v1

請求格式

Section titled “請求格式”

所有 API 請求使用 JSON 格式：

Terminal window
curl -X GET https://app.piora.dev/api/v1/servers \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

回應格式

Section titled “回應格式”

API 回應使用 JSON 格式，包含以下結構：

{
  "success": true,
  "data": {
    // 回應資料
  },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 45
  }
}

錯誤回應：

{
  "success": false,
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "找不到指定的伺服器"
  }
}

API 端點

Section titled “API 端點”

伺服器

Section titled “伺服器”
方法端點說明
GET/servers列出所有伺服器
GET/servers/:id取得伺服器詳情
POST/servers新增伺服器
DELETE/servers/:id移除伺服器
GET/servers/:id/stats取得伺服器狀態

應用

Section titled “應用”
方法端點說明
GET/applications列出所有應用
GET/applications/:id取得應用詳情
POST/applications建立應用
PATCH/applications/:id更新應用設定
DELETE/applications/:id刪除應用
POST/applications/:id/deploy觸發部署
POST/applications/:id/rollback回滾部署

資料庫

Section titled “資料庫”
方法端點說明
GET/databases列出所有資料庫
POST/databases建立資料庫
DELETE/databases/:id刪除資料庫

域名

Section titled “域名”
方法端點說明
GET/applications/:id/domains列出應用域名
POST/applications/:id/domains新增域名
DELETE/applications/:id/domains/:domainId移除域名

分頁

Section titled “分頁”

列表端點支援分頁查詢：

Terminal window
GET /api/v1/applications?page=1&per_page=20
參數說明預設值
page頁碼1
per_page每頁數量20

速率限制

Section titled “速率限制”

API 有以下速率限制：

層級限制
每分鐘60 次請求
每小時1000 次請求

超過限制時，API 會回傳 429 Too Many Requests 狀態碼。

相關資源

Section titled “相關資源”