Remote API GET Check (Payload Validate) (Service Check)

Service Check Category: Network Application Checks

Passive: No

Description: This check makes a REST API GET request to a specified API endpoint. If the response from the API does not match the response value configured in the check, the check will enter a CRITICAL state. Uses a key/value pair to check the API response. For example, if the response key is set to "success" and the value is set to "true". The following response from the API would allow the check to remain in the OK state.

{
"success": "true"
}

If the returned value was anything other than "true", then the check would enter the CRITICAL state.

Fields:

• API URL
  (Required) The API endpoint being called. Enter the full URL.
• HEADER
  (Optional) Additional header information for the call (leave blank if not used). Use JSON format {key}:{value}
• RESPONSE KEY
  (Required) The label of the key to check.
• VALUE THAT IS OK
  (Required) The desired value of the key specified above. Regex is supported.
• 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.

See Service Check for generic configuration parameters.