Create a sensor check
Authentication required for this operation.<br>Preconditions:<ul> <li>Authenticated user has to be editor or owner of the organization, or be an admin in the platform.</li> <li>Check owner is same as authenticated user, or the authenticated user is an owner within the organization or an admin.</li> <li>The check owner has to be part of the organization</li> <li>The check id will be generated and the whole new saved sensor check is returned.</li></ul>
Request
- Base URL: https://api.30mhz.com/api
- URL: https://api.30mhz.com/api/sensor/{sensorId}
- Auth: API key in header Authorization
Path parameters
Request body
Whether to follow redirects when a page returns HTTP code 302. Default is false.
The id of the calculation called by the webcheck
If the recollection of the JSON object has to be effectuated or not
A javascript expression that is applied to the json result and has to evaluate to true for the data source to be UP.
Verify that the page returned contains this text, otherwise the data source will be reported as DOWN.
Verify that the page returned does NOT contain this text, if it does, the data source will be reported as DOWN.
Send these cookies in each request when pinging the data source. You can use this, for example, for adding authentication data.
Only run this data source in the given schedule. This is written in Unix-like notation. For example, to run it only weekdays 8 to 17, write '* * 8-17 ? * MON-FRI'
Payload to send, usually for POST or PUT methods
The number of decimals used for each field of the data source.
Brief description that elaborates on the name
Whether the data source is enabled.
The frequency with which the data source is pinged, in seconds.
Identifier of the gateway the data source belongs to.
Send these HTTP headers in each request when pinging the data source. You can use this, for example, for adding authentication data.
How many consecutive successful responses indicate that the data source is up.
How many locations indicate the data source is up/down.
From which locations to ping the data source from.
Max decimals for fields of the data source.
The maximum number of times you want to be notified if DOWN.
HTTP method (get/post/put/delete) to user for pinging the data source
Displayable name.
Identifier of the organization this data source belongs to.
Send these HTTP parameters in each request when pinging the data source.
Every how many seconds to send another notification if data source is still DOWN. (See also Number of reminders).
The sensor type.
Identifier of the site it belongs to, together with the organizationId this is unique.
The status of the data source, e.g. ACTIVE, DEACTIVATED or PAUSED.
What HTTP status code are expected when pinging the data source. If the received HTTP status is not in this list, the data source will be reported as DOWN.
Whether the stream is enabled for the response validation
The tags associated with the data source.
How long we wait for the data source to respond before we consider it down.
An area which observes a uniform standard time.
How many consecutive failed responses indicate that the data source is down.
The units associated with the sensor data source.
The URL of the data source.
Whether SSL verification is enabled.
Identifier of the zone within a site where the data source belongs.
Min/max ranges for each json key of the data source.
Offset of the timezone in minutes.
Email address.
Response
New sensor check created, including its generated check id
Whether to follow redirects when a page returns HTTP code 302. Default is false.
The id of the calculation called by the webcheck
If the recollection of the JSON object has to be effectuated or not
A javascript expression that is applied to the json result and has to evaluate to true for the data source to be UP.
Verify that the page returned contains this text, otherwise the data source will be reported as DOWN.
Verify that the page returned does NOT contain this text, if it does, the data source will be reported as DOWN.
Send these cookies in each request when pinging the data source. You can use this, for example, for adding authentication data.
Only run this data source in the given schedule. This is written in Unix-like notation. For example, to run it only weekdays 8 to 17, write '* * 8-17 ? * MON-FRI'
Payload to send, usually for POST or PUT methods
The number of decimals used for each field of the data source.
Brief description that elaborates on the name
Email address.
Whether the data source is enabled.
The frequency with which the data source is pinged, in seconds.
Identifier of the gateway the data source belongs to.
Send these HTTP headers in each request when pinging the data source. You can use this, for example, for adding authentication data.
How many consecutive successful responses indicate that the data source is up.
How many locations indicate the data source is up/down.
From which locations to ping the data source from.
Max decimals for fields of the data source.
The maximum number of times you want to be notified if DOWN.
HTTP method (get/post/put/delete) to user for pinging the data source
Displayable name.
Identifier of the organization this data source belongs to.
Send these HTTP parameters in each request when pinging the data source.
Every how many seconds to send another notification if data source is still DOWN. (See also Number of reminders).
The sensor type.
Identifier of the site it belongs to, together with the organizationId this is unique.
The status of the data source, e.g. ACTIVE, DEACTIVATED or PAUSED.
What HTTP status code are expected when pinging the data source. If the received HTTP status is not in this list, the data source will be reported as DOWN.
Whether the stream is enabled for the response validation
The tags associated with the data source.
How long we wait for the data source to respond before we consider it down.
An area which observes a uniform standard time.
How many consecutive failed responses indicate that the data source is down.
The units associated with the sensor data source.
The URL of the data source.
Whether SSL verification is enabled.
Identifier of the zone within a site where the data source belongs.
Min/max ranges for each json key of the data source.
Offset of the timezone in minutes.
The battery status warnings or errors associated with this data source. Expected values are OK, WARNING and CRITICAL.
Identifier of the data source
Timestamp of when it was created.
Does the data source have any notifications associated with it
Ids of the notifications for this check
Last moment when the data source was DOWN, as a Unix Timestamp
The current state of the data source: UP or DOWN.
Email address.
Changes
No recorded changes to this operation across all 1 revision of this API.