1. General

This page is where you create your Health Checks which we will call HC for the rest of this document. Form has 2 view modes Basic/Advanced. 

You can change the view of the form by the toggle buttons location on the top right hand cornew of the form. 

Advanced contains all the fields basic as you expect. So we will write this document as you are viewing the advanced form but same field descriptions applies to basic as well.

2. Fields

Form has 4 sections called General, Request, Details and Alert. Each sections and fields are listed below.

• General
  • Name is what you will call this HC and does not have any role with the whole request process.
  • Url is the address of your http/https endpoint 
  • Certificate validation toggle allows you to set this HC to check if the end point is https certificate is not expired or signed for the right domain etc.
  • Certificate alerts toggle allows you to get alerts for certificate validation failures
• Request
  • Type is the method that will be used for requests to this endpoint
  • Headers is any http request headers you want to be added to each request. You can add as many as you like by separating each one by new line
  • Body is any data you want to transmit after the request headers are sent. Which is called the body of a request. It can contain any data you like. Only transmitted if type is applicable like POST for ex.
  • Confirm type is what kind of validation should be done on the response. Only Header / Status Code and Body / Raw Text is available during writing of this document.
    • Header / Status Code is the response header field called status. Returns numeric status code for the request
    • Body / Raw Text is allowing you check for any text is present in the response body
  • Timeout is after how many seconds request should be considered as a failure.
• Details
  • Locations is which data centers should send requests for this HC. It does not reflect any extra cost how many locations you select but keep in mind that if you select locations that you are not willing to get customers and if your servers are not optimized for these locations you might get a lot of false alerts due to those locations
  • Period is how often your HC will trigger a check for this endpoint. This also does not cost you any extra money if you check it in too low intervals but also keep in mind that it may create some load on your servers.
  • Poor service alert is toggle to allow you to get warnings about this HC for non failure but critical for your business to satisfy your customers
  • Poor service threshold is the response time that is you consider this endpoint is serving under your expectations
  • Status is toggle to enable / disable this HC. Keep in mind that it will take some time for HCs to start and stop around 1-5 mins on all servers around the world.
• Alert
  • Fields in this area are spread in sentences that already explains it self so we won't try to explain them more than that here.