Remote POST API Check (Service Check)
- 11 Jan 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Remote POST API Check (Service Check)
- Updated on 11 Jan 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Service Check Category: Web Checks
Passive: No
Description:
This check sends a POST request to an API endpoint. If the return value is anything other than the value supplied in the EXPECTED RESPONSE CODE field (defaults to 200) the check will enter a CRITICAL state.
Do not confuse this check with the POST API Check which is for monitoring APIs hosted on devices monitored by Netreo.
Check-specific Configuration Options:
(See Service Checks for configuration options common to all service checks.)
- URL
(Required) The URL of the API endpoint to check. Supports fully formed URLs, meaning any reachable endpoint will work. - PAYLOAD
(Optional) The key pair values used to request the API. Must be formatted as JSON. - EXPECTED RESPONSE CODE
(Optional) The status code that must be returned for the check to remain in the OK state. - HEADER
(Optional) Use for any additional configurations. Must be formatted as JSON. Default value is{"content-type":"application/json"}
- DESCRIPTION
(Required) This field specifies a name for this check. The name entered must be unique among service check names on the host it is added to (the name may used again only on a different host). It is used to identify this specific check from among other service checks added to the same host.
Was this article helpful?