POST API Check (Service Check)

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.

The value supplied in the API ENDPOINT field is appended to the device IP address to make the call.

Do not confuse this check with the Remote POST API Check which is for monitoring APIs hosted on remote devices not monitored by Netreo.

Check-specific Configuration Options:

(See Service Checks for configuration options common to all service checks.)

• API ENDPOINT
  (Required) The URI after the domain address. This is appended to the device IP address to make the call.
• 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.