host.delete

説明

object host.delete(array hosts)

このメソッドを使用すると、ホストを削除できます。

このメソッドは、Admin および Super admin のユーザータイプでのみ利用できます。メソッドの呼び出し権限は、ユーザー権限設定で取り消すことができます。詳細は User roles を参照してください。

パラメーター

(array) 削除するホストのID。

戻り値

(object) hostidsプロパティの下にある削除されたホストのIDを含むオブジェクトを返します。

例

複数のホストの削除

2つのホストを削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "host.delete",
    "params": [
        "13",
        "32"
    ],
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "hostids": [
            "13",
            "32"
        ]
    },
    "id": 1
}

ソース

CHost::delete() in ui/include/classes/api/services/CHost.php.