httptest.get
Description
integer/array httptest.get(object parameters)
The method allows to retrieve web scenarios according to the given parameters.
Parameters
(object)
Parameters defining the desired output.
The method supports the following parameters.
Parameter | Type | Description |
---|---|---|
applicationids | string/array | Return only web scenarios that belong to the given applications. |
groupids | string/array | Return only web scenarios that belong to the given host groups. |
hostids | string/array | Return only web scenarios that belong to the given hosts. |
httptestids | string/array | Return only web scenarios with the given IDs. |
inherited | boolean | If set to true return only web scenarios inherited from a template. |
monitored | boolean | If set to true return only enabled web scenarios that belong to monitored hosts. |
templated | boolean | If set to true return only web scenarios that belong to templates. |
templateids | string/array | Return only web scenarios that belong to the given templates. |
expandName | flag | Expand macros in the name of the web scenario. |
expandStepName | flag | Expand macros in the names of scenario steps. |
selectHosts | query | Return the host that the web scenario belongs to as an array in the hosts property. |
selectSteps | query | Return web scenario steps in the steps property. |
sortfield | string/array | Sort the result by the given properties.
Possible values are: |
countOutput | flag | These parameters being common for all get methods are described in detail in the reference commentary. |
editable | boolean | |
excludeSearch | flag | |
filter | object | |
limit | integer | |
nodeids | string/array | |
output | query | |
preservekeys | flag | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | flag |
Return values
(integer/array)
Returns either:
-
an array of objects;
-
the count of retrieved objects, if the
countOutput
parameter has been used.
Examples
Retrieving a web scenario
Retrieve all data about web scenario “4”.
Request:
{ "jsonrpc": "2.0", "method": "httptest.get", "params": { "output": "extend", "selectSteps": "extend", "httptestids": "4" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Response:
{ "jsonrpc": "2.0", "result": [ { "httptestid": "4", "name": "Homepage check", "applicationid": "0", "nextcheck": "0", "delay": "60", "status": "0", "macros": "", "agent": "", "authentication": "0", "http_user": "", "http_password": "", "hostid": "10085", "templateid": "0", "http_proxy": "", "retries": "1", "steps": [ { "httpstepid": "4", "httptestid": "4", "name": "Homepage", "no": "1", "url": "http://mycompany.com", "timeout": "30", "posts": "", "required": "", "status_codes": "200", "webstepid": "4" }, { "httpstepid": "5", "httptestid": "4", "name": "Homepage / About", "no": "2", "url": "http://mycompany.com/about", "timeout": "30", "posts": "", "required": "", "status_codes": "200", "webstepid": "5" } ] } ], "id": 1 }
See also
Source
CHttpTest::get() in frontends/php/api/classes/CHttpTest.php.
Data source: Zabbix