Table of Contents
httptest.get
Description
integer/array httptest.get(object parameters)
The method allows to retrieve web scenarios according to the given parameters.
This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| groupids | ID/array | Return only web scenarios that belong to the given host groups. |
| hostids | ID/array | Return only web scenarios that belong to the given hosts. |
| httptestids | ID/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 | ID/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. |
| evaltype | integer | Rules for tag searching. Possible values: 0 - (default) And/Or; 2 - Or. |
| tags | array | Return only web scenarios with given tags. Exact match by tag and case-sensitive or case-insensitive search by tag value depending on operator value. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].An empty array returns all web scenarios. Possible operator types: 0 - (default) Like; 1 - Equal; 2 - Not like; 3 - Not equal 4 - Exists; 5 - Not exists. |
| selectHosts | query | Return the hosts that the web scenario belongs to as an array in the hosts property. |
| selectSteps | query | Return web scenario steps in the steps property.Supports count. |
| selectTags | query | Return web scenario tags in the tags property. |
| sortfield | string/array | Sort the result by the given properties. Possible values: httptestid, name. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Examples
Retrieving a web scenario
Retrieve all data about web scenario "4".
{
"jsonrpc": "2.0",
"method": "httptest.get",
"params": {
"output": "extend",
"selectSteps": "extend",
"httptestids": "9"
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"httptestid": "9",
"name": "Homepage check",
"delay": "1m",
"status": "0",
"variables": [],
"agent": "Zabbix",
"authentication": "0",
"http_user": "",
"http_password": "",
"hostid": "10084",
"templateid": "0",
"http_proxy": "",
"retries": "1",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"headers": [],
"steps": [
{
"httpstepid": "36",
"httptestid": "9",
"name": "Homepage",
"no": "1",
"url": "http://example.com",
"timeout": "15s",
"posts": "",
"required": "",
"status_codes": "200",
"variables": [
{
"name":"{var}",
"value":"12"
}
],
"follow_redirects": "1",
"retrieve_mode": "0",
"headers": [],
"query_fields": []
},
{
"httpstepid": "37",
"httptestid": "9",
"name": "Homepage / About",
"no": "2",
"url": "http://example.com/about",
"timeout": "15s",
"posts": "",
"required": "",
"status_codes": "200",
"variables": [],
"follow_redirects": "1",
"retrieve_mode": "0",
"headers": [],
"query_fields": []
}
]
}
],
"id": 1
}See also
Source
CHttpTest::get() in ui/include/classes/api/services/CHttpTest.php.