Zabbix Documentation 2.2

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

manual:api:reference:graphprototype:getobjects

graphprototype.getobjects

Description

array graphprototype.getobjects(object filter)

This method allows to retrieve graph prototypes that match the given filter criteria.

Parameters

(object) Criteria to search by.

Additionally to the standard standard graph prototype properties the following parameters are supported as search criteria.

Parameter Type Description
node string Name of the node the graph prototypes must belong to.

This will override the nodeids parameter.
nodeids string/array IDs of the nodes the graph prototypes must belong to.

Return values

(array) Returns an array of objects with all properties.

Examples

Retrieving graph prototypes from a host

Retrieve all graph prototypes from host “Zabbix server”.

Request:

{
    "jsonrpc": "2.0",
    "method": "graphprototype.getobjects",
    "params": {
        "host": "Zabbix server"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0"
        }
    ],
    "id": 1
}

See also

Source

CGraphPrototype::getObject() in frontends/php/api/classes/CGraphPrototype.php.