Sidebar

manual:api:reference:host:delete

host.delete

Description

object host.delete(array hosts)

This method allows to delete hosts.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(array) IDs of hosts to delete.

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 ui/include/classes/api/services/CHost.php.