一組權杖，於客戶面板中建立
以 bearer token 形式傳送。您可以將其限定為唯讀，或限定給單一服務使用；權杖與您的密碼彼此獨立，撤銷其中一個，也絕不會讓您被登出。
20 個端點
所有內容，分為五組
基礎 URL https://api.vpsoffshore.com/v1。路徑中含有版本號；v2 推出後 v1 仍可繼續使用，其停用日期將提前一年公告。
伺服器
GET
/servers
帳戶下的每一項服務，包含狀態、方案與位址。
POST
/servers
建立一台。會立即回傳一個建置 ID；伺服器約於一分鐘後即可連線。
GET
/servers/{id}
單一服務，含過去一小時的即時資源使用狀況。
PATCH
/servers/{id}
變更方案。在磁碟空間允許的情況下，無需重新安裝即可調整規格。
DELETE
/servers/{id}
刪除它。磁碟會保留 14 天，之後才會清除並重新配發。
POST
/servers/{id}/actions
reboot · shutdown · start · rebuild · rescue · reset-password.
儲存
GET
/servers/{id}/snapshots
單一服務的快照，最新在前。
POST
/servers/{id}/snapshots
拍一份快照即可。輕量化設計，速度快，且不會讓磁碟用量翻倍。
POST
/snapshots/{id}/restore
原地還原，或還原至相同或更高方案的另一項服務。
DELETE
/snapshots/{id}
移除快照。
網路
GET
/servers/{id}/addresses
已路由至服務的位址，涵蓋 v4 與 v6。
POST
/servers/{id}/addresses
申請額外的位址，或一個 /29。
PUT
/addresses/{ip}/rdns
設定反向 DNS。一分鐘內即可生效，無需等待下一次區域重新整理。
GET
/servers/{id}/bandwidth
流量計數器，僅供參考——沒有配額上限可言。
型錄
GET
/plans
每個方案的規格與價格，皆取自本網站據以顯示內容的同一份資料來源。
GET
/images
可用的映像檔與 ISO，包括您自行上傳的版本。
POST
/images
透過 URL 上傳 ISO，開機時會自動連接主控台。
帳務
GET
/invoices
帳單，含已付款與未付款項目，以及幣種與鏈上交易。
POST
/invoices/{id}/pay
為 8 種可接受的幣種之一，產生付款位址。
GET
/credits
已套用的 SLA 補償，及其對應的事件。
客戶面板能做的事，這裡都能做到；這裡有的功能，客戶面板也一應俱全。若兩者出現落差，那就是一個錯誤——請透過客戶面板告訴我們，我們會加以修正，而不是把它記錄成預期行為。
運作方式
您將在一小時內注意到的四項決定
評斷一個 API 的好壞，看的是它的失敗路徑，而非成功路徑。以下四項之中，有三項談的正是出錯時會發生什麼事。
輸入 JSON，輸出 JSON，無需 SDK
純粹的 HTTPS，沒有自訂封裝、沒有 XML 備援，也沒有簽章儀式。只要 curl 做得到，您就有了一個用戶端。官方提供 Go、Python 與 TypeScript 的函式庫，但都不是必要的。
不會意外觸發的速率限制
每個權杖每分鐘 600 次請求，建立類呼叫則為 60 次。每個回應皆會在標頭中附上剩餘額度，超出限制時會回傳 429，並附上需等待的秒數，而非無聲捨棄。
會告訴您該怎麼做的錯誤訊息
4xx 回應會包含機器可讀的錯誤碼、一句人類可讀的說明，以及出錯的欄位。我們寧可回傳冗長的錯誤訊息，也不要讓您去猜測簡短訊息背後的意思。
只需寫一次的兩件事
身分驗證，以及錯誤訊息的呈現方式
兩者都值得在撰寫第一次呼叫之前閱讀，而不是等到第一次失敗之後才讀。
驗證
curl https://api.vpsoffshore.com/v1/servers \
-H "Authorization: Bearer $TOKEN"權杖可在面板中建立，並可限定為唯讀或單一服務範圍。權杖與您的密碼彼此獨立，撤銷其中一個並不會讓您在任何地方被登出。
查看速率限制
X-RateLimit-Remaining: 574
X-RateLimit-Reset: 41每一次回應都會附上，不只是失敗的那一次。超出限制時會回傳 429，並附上需等待的秒數，絕不會無聲丟棄請求，也絕不會回傳被截短的內容。
錯誤訊息會指出是哪個欄位
{"error":"plan_unknown",
"message":"No plan named 'reff'. Did you mean 'reef'?",
"field":"plan"}機器可讀的代碼、一句人類可讀的說明，以及出錯的欄位。詳細的錯誤訊息，比要靠猜的簡短訊息更省成本。
查詢建置進度
curl https://api.vpsoffshore.com/v1/servers/$ID \
-H "Authorization: Bearer $TOKEN" | jq .state狀態從 building 變為 running。您無需在建立任何項目前先註冊 webhook，且每秒輪詢一次仍在限制範圍內。
繼續閱讀
接下來：其他主機與方案