VPS.org APIドキュメント

はじめる

VPS.org API を使用すると、サーバー、ドメイン、DNS レコード、バックアップ、スナップショットなど、VPS ホスティングインフラストラクチャのあらゆる側面をプログラムで管理できます。

認証

すべてのAPIリクエストには、ベアラートークンを使用した認証が必要です。APIトークンは、アカウント設定から生成できます。 admin.vps.org/account/developers/.

cURL

Python

JavaScript

curl -X GET https://admin.vps.org/api/v1/servers/ \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

import requests

url = "https://admin.vps.org/api/v1/servers/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch('https://admin.vps.org/api/v1/servers/', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

レート制限

APIリクエストは、APIトークンごとに5分あたり300リクエストに制限されています。レート制限情報はレスポンスヘッダーに含まれています。

X-RateLimit-Limit: 許可されるリクエストの最大数
X-RateLimit-Remaining: 残りのリクエスト数
X-RateLimit-Reset: レート制限がリセットされたときのタイムスタンプ

エラー処理

API は標準の HTTP ステータスコードを使用して成功または失敗を示します。

ステータスコード	説明
`200`	成功 - リクエストが正常に完了しました
`201`	作成済み - リソースが正常に作成されました
`400`	不正なリクエスト - 無効なパラメータまたは不正なリクエスト
`401`	認証されていません - 認証トークンが無効または見つかりません
`403`	禁止 - 権限が不十分です
`404`	見つかりません - リソースが存在しません
`429`	リクエストが多すぎます - レート制限を超えました
`500`	内部サーバーエラー - 当社側で問題が発生しました