template.exists

Description

boolean template.exists(object filter)

This method checks if at least one template that matches the given filter criteria exists.

Parameters

(object) Criteria to search by.

The following parameters are supported as search criteria.

Parameter	Type	Description
host	string/array	Technical names of the templates.
name	string/array	Visible names of the templates.
node	string	Name of the node the templates must belong to. This will override the `nodeids` parameter.
nodeids	string/array	IDs of the node the hosts must belong to.
templateid	string/array	Template IDs.

Return values

(boolean) Returns true if at least one template that matches the given filter criteria exists.

Examples

Check template on a node

Check if a template with the technical name "Linux template" exists on the node with ID 1.

Request:

{
           "jsonrpc": "2.0",
           "method": "template.exists",
           "params": {
               "host": "Linux template",
               "nodeids": [
                   "1"
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

Source

CTemplate::exists() in frontends/php/api/classes/CTemplate.php.

Documentation