httptest.create

Description

object httptest.create(object/array webScenarios)

This method allows to create new web scenarios.

Creating a web scenario will automatically create a set of web monitoring items.

This method is only available to Admin and Super admin user types. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object/array) Web scenarios to create.

Additionally to the standard web scenario properties, the method accepts the following parameters.

Parameter	Type	Description
steps	array	Web scenario steps. Parameter behavior: - required
tags	array	Web scenario tags.

Return values

(object) Returns an object containing the IDs of the created web scenarios under the httptestids property. The order of the returned IDs matches the order of the passed web scenarios.

Examples

Creating a web scenario

Create a web scenario to monitor the company home page. The scenario will have two steps, to check the home page and the "About" page and make sure they return the HTTP status code 200.

Request:

{
           "jsonrpc": "2.0",
           "method": "httptest.create",
           "params": {
               "name": "Homepage check",
               "hostid": "10085",
               "steps": [
                   {
                       "name": "Homepage",
                       "url": "http://example.com",
                       "status_codes": "200",
                       "no": 1
                   },
                   {
                       "name": "Homepage / About",
                       "url": "http://example.com/about",
                       "status_codes": "200",
                       "no": 2
                   }
               ]
           },
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "httptestids": [
                   "5"
               ]
           },
           "id": 1
       }

Source

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

Documentation