POSTBearer トークン
自動更新の希望を設定
/api/v1/servers/:id/autorenew
サイト側の自動更新設定を保存します。
呼び出す前に
プロバイダー契約の更新・解約は行いません。現在、プロバイダーの更新連携は利用できません。
API のフィールド名、型、コードはすべての言語で共通です。
リクエスト例
cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/autorenew" -X POST \
-H "Authorization: Bearer $TOVAHUB_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"enabled": true,
"requestKey": "docs_example_001"
}'表示のみ。このページから API リクエストは送信されません。
レスポンス例
JSON
{
"ok": true,
"enabled": true,
"supplierRenewalReady": false
}パラメーター
idパス · 必須string
リソース ID。24 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。
enabledJSON ボディ · 必須boolean
変更後の有効・無効の状態。
requestKeyJSON ボディ · 必須string
8–100 文字。使用できるのは A–Z、a–z、0–9、アンダースコア、ハイフンです。同じ操作を再試行するときは、同じキーと完全に同じ入力を使用してください。
レスポンス
HTTP ステータス 200
プロバイダー契約を更新せず、サイト側の自動更新設定を保存します。
okboolean (true)設定が保存されたか、元のリクエストの結果が再返却されました。
enabledboolean元の保存済み設定値。
replayboolean (true, optional)同じリクエストの結果を再返却する場合にのみ含まれます。
supplierRenewalReadyboolean (false)現在、プロバイダーの更新連携は利用できません。