template.delete

Description

object template.delete(array templateIds)

This method allows to delete templates.

Deleting a template also removes all of its entities (items, triggers, graphs, etc.) from any hosts or templates it is linked to. To keep these entities, first unlink the template from the relevant hosts or templates using the host.update, host.massremove, template.update, or template.massremove methods.

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 templates to delete.

Return values

(object) Returns an object containing the IDs of the deleted templates under the templateids property.

Examples

Deleting multiple templates

Delete two templates.

Request:

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

Response:

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

Source

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

Documentation