サーバーエンドポイント
Updated 2 years ago
by
Admin
サーバーAPIを使用すると、サーバーインスタンスをプログラムで作成、アクセス、および終了できます。
サーバーを探す
サーバーを名前で検索します。
GET /api/servers/:name
リクエストパラメータ：
パラメータ | タイプ | 説明 |
|
| サーバーの名前 |
応答本文：
{
"id": "string",
"provider": "string",
"state": "string",
"name": "string",
"image": "string",
"region": "string",
"size": "string",
"address": "string",
"capacity": "number",
"secret": "string",
"error": "string",
"ca_key": "string",
"ca_cert": "string",
"ca_cert": "string",
"tls_key": "string",
"tls_cert": "string",
"created": "number",
"updated": "number",
"started": "number",
"stopped": "number"
}すべてのサーバーを一覧表示
すべてのサーバーをリストします。
GET /api/servers
応答本文：
[
{
"id": "string",
"provider": "string",
"state": "string",
"name": "string",
"image": "string",
"region": "string",
"size": "string",
"address": "string",
"capacity": "number",
"secret": "string",
"error": "string",
"ca_key": "string",
"ca_cert": "string",
"ca_cert": "string",
"tls_key": "string",
"tls_cert": "string",
"created": "number",
"updated": "number",
"started": "number",
"stopped": "number"
}
]
サーバーの提供
提供により、新しいサーバーインスタンスが割り当てられます。
POST /api/servers
応答本文：
{
"id": "string",
"provider": "string",
"state": "string",
"name": "string",
"image": "string",
"region": "string",
"size": "string",
"address": "string",
"capacity": "number",
"secret": "string",
"error": "string",
"ca_key": "string",
"ca_cert": "string",
"ca_cert": "string",
"tls_key": "string",
"tls_cert": "string",
"created": "number",
"updated": "number",
"started": "number",
"stopped": "number"
}サーバーを終了する
Terminateは、名前付きサーバーインスタンスを停止して終了します。
DELETE /api/servers/:name
リクエストパラメータ：
パラメータ | タイプ | 説明 |
|
| サーバーの名前 |
|
| インスタンスを強制的に削除します |
