Zabbix Documentation 2.2

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

manual:api:reference:host:delete

host.delete

Description

object host.delete(array hosts)

This method allows to delete hosts.

Parameters

(array) IDs of hosts to delete.

The method can also accept an array of host objects with the hostid property defined. This format is deprecated.

Return values

(object) Returns an object containing the IDs of the deleted hosts under the hostids property.

Examples

Deleting multiple hosts

Delete two hosts.

Request:

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

Response:

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

Source

CHost::delete() in frontends/php/api/classes/CHost.php.