hostprototype.delete

Description

object hostprototype.delete(array hostPrototypeIds)

This method allows to delete host prototypes.

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 the host prototypes to delete.

Return values

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

Examples

Deleting multiple host prototypes

Delete two host prototypes.

Request:

{
           "jsonrpc": "2.0",
           "method": "hostprototype.delete",
           "params": [
               "10103",
               "10105"
           ],
           "id": 1
       }
Copy
✔ Copied

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "hostids": [
                   "10103",
                   "10105"
               ]
           },
           "id": 1
       }
Copy
✔ Copied

Source

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

To toggle search highlight, press Ctrl+Alt+H
Have an improvement suggestion for this page? Select the text that could be improved and press Ctrl+Enter to send it to the editors.