VPS.org APIドキュメント

はじめる

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

認証

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

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);

各トークンは servers:list や dns:* のような独自の権限を持っています。トークンが持たない権限を必要とする要求は、403と required_permission フィールドで拒否されます。 権限参照

レート制限

認証された要求はアカウントごとに 1 時間あたり 1,000 件まで制限されます。認証されていない要求は IP アドレスごとに 1 時間あたり 100 件まで制限されます。制限を超える要求は 429 と Retry-After ヘッダを受け取ります。成功した応答では、レート制限ヘッダは送られません。

ページング

リストエンドポイントはページごとに25アイテムのカウント、次、前、結果を返します。ページ間を移動するにはページをスクロールし、または null になるまで次の URL を追跡します。サーバリストは page_size を 100 まで許可します。

{
  "count": 84,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [ ... ]
}

エラー処理

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

エラーボディは JSON で、ほとんどの場合詳細フィールドまたはエラーフィールドがあり、メッセージが含まれることもあります。検証エラーはフィールド名で問題をリストします。

API カテゴリ

API ドキュメントをカテゴリ別に参照してください:

もっと多くのエンドポイント

APIにはアプリのデプロイ用エンドポイント(/api/v1/deploy-configs/および/api/v1/deployments/)もあります。これらはまだこのページでは説明されていませんが、インタラクティブなリファレンスにはライブAPIから生成されたすべてのエンドポイントが記載されています。

ヘルプが必要ですか?

API に関してご質問やサポートが必要な場合は、お気軽にお問い合わせください。

• サポートチケット: サポートチケットを開く
• メールアドレス: hello@vps.org
• 文書: 完全なドキュメント