Remote API GET Check (Status Code 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 status code in the response from the API does not match the status code value configured in the check (defaults to 200), the check will enter a 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}
• STATUS CODE EXPECTED
  (Required) The status code returned by the API to allow the check to remain in the OK state.
• 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.