This is a translation of the original English documentation page. Help us make it better.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

task.create

Description

object task.create(object task)

This method allows to create new task.

Parameters

(object) A task to create.

The method accepts the following parameters.

Parameter Type Description
type
(required)
integer Task type.

Possible values:
6 - Check now.
itemids
(required)
string/array IDs of items and low-level discovery rules.

Item or discovery rule must of the following type:
0 - Zabbix agent;
1 - SNMPv1 agent;
3 - simple check;
4 - SNMPv2 agent;
5 - Zabbix internal;
6 - SNMPv3 agent;
8 - Zabbix aggregate;
10 - external check;
11 - database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
15 - calculated;
16 - JMX agent.

Return values

(object) Returns an object containing the IDs of the created tasks under the taskids property. One task is created for each item and low-level discovery rule. The order of the returned IDs matches the order of the passed itemids.

Examples

Creating a task

Create a task check now for two items. One is an item, the other is a low-level discovery rule.

Request:

{
           "jsonrpc": "2.0",
           "method": "task.create",
           "params": {
               "type": "6",
               "itemids": ["10092", "10093"],
           },
           "auth": "700ca65537074ec963db7efabda78259",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "taskids": [
                   "1",
                   "2"
               ]
           },
           "id": 1
       }

Source

CTask::create() in frontends/php/include/classes/api/services/CTask.php.

Source

CTask::create() in ui/include/classes/api/services/CTask.php.