03-6417-9339

平日 9:30 ~ 12:00 / 13:00 ~ 17:30

host_add


ホストを新規登録するためのエンドポイントです。
VM サーバからライセンスサーバへの通信が発生するエンドポイントです。ライセンスサーバとの通信が発生するエンドポイントは、連続で実行せず、エンドポイントの応答完了後、数秒程度のウェイトを入れることを推奨します。

エンドポイント host_add
機能 ホスト新規追加
実装バージョン 2.8.0
認証 有り
HTTPメソッド GET/POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。
String なし
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> なし

レスポンス

key value の内容 value の型
success 新規登録の成否 Boolean
response エラー等の補足情報 Hash
id 新規登録したホスト ID Number

レスポンス例

{
  "success": true,
  "response": {},
  "id":50
}

サンプルコード (作成中)