host_update
ホストを更新するためのエンドポイントです。
ホスト名を更新した場合のみ、VMサーバからライセンスサーバへの通信が発生するエンドポイントです。ライセンスサーバとの通信が発生するエンドポイントは、連続で実行せず、エンドポイントの応答完了後、数秒程度のウェイトを入れることを推奨します。
| エンドポイント | host_update |
| 機能 | ホスト更新 |
| 実装バージョン | 2.8.0 |
| 認証 | 有り |
| HTTPメソッド | GET/POST |
パラメータ
| 入力値 | 機能 | 入力値の型 | デフォルト値 |
|---|---|---|---|
| q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | なし |
| q[id] | 更新したいホストのIDを指定します。 | Number | なし |
| q[hostname] | ホスト名を入力します。 | String | なし |
| q[display_name] | ホストの表示名を入力します。 | String | なし |
| q[memo] | ホストに付けるメモを入力します。 | String | なし |
| q[refdate] | 基準日を入力します。 | String | なし |
| q[system_category] | システムカテゴリを入力します。 | String | なし |
| q[custom_categories][] | カスタムカテゴリを配列入力します。カテゴリ名で指定します。例：[ '#1', '#011' ] | Array<String> | なし |
| q[manual_products][] | プロダクト名を配列入力します。 | Array<String> | なし |
| q[manual_local_products][] | ローカルプロダクト名を配列入力します。 | Array<String> | なし |
| q[package_os] | ホストのOSを入力します。 | String | なし |
| q[packages][] | パッケージ名を配列入力します。こちらの"packages"と同じ方法で取得したパッケージ名称を入力してください。 | String | なし |
| q[delete_all_custom_categories] | 既存のカスタムカテゴリの削除フラグです。true, false で指定します。 | Boolean | なし |
| q[delete_all_manual_products] | 既存のプロダクトの削除フラグです。true, false で指定します。 | Boolean | なし |
| q[delete_all_manual_local_products] | 既存のローカルプロダクトの削除フラグです。true, false で指定します。 | Boolean | なし |
| q[delete_all_packages] | 既存のパッケージ名の削除フラグです。true, false で指定します。 | Boolean | なし |
| q[enable_apps][] | 有効にするアプリ名を配列入力します。 | Array<String> | なし |
| q[disable_apps][] | 無効にするアプリ名を配列入力します。 | Array<String> | なし |
レスポンス
レスポンス例
{
"success": true,
"response": {},
"id":50
}