Skip to main content

Introduction

Monitor the availability and performance of your services. Create, update and delete your health checks and manage their alerts.

Take care

The maximum number of health checks per customer account is 30.

The Health check API base URL for the production environment is :

https://api.nameshield.net/healthcheck/v1

The Health check API base URL for the OTE environment is :

https://ote-api.nameshield.net/healthcheck/v1

Supported health check types​

  • TCP: The probes try to establish a TCP connection.
  • HTTP: The probes submit an HTTP request and wait for an HTTP status code of 2xx.
  • HTTPS: The probes submit an HTTPS request and wait for an HTTP status code of 2xx. By default, the certificate validity is not verified.

Health check status​

  • INSTALLING: The probes are currently determining the initial status of the health check. During this process, the status is considered HEALTHY.
  • HEALTHY: The majority of probes are able to establish a connection with the endpoint.
  • UNHEALTHY: The majority of probes are unable to establish a connection with the endpoint.

Search parameters​

Case sensitivity​

Search parameters are case-insensitive (e.g., HealthCheck is equal to healthcheck).

Wildcard compatibility​

Properties marked as "Wildcard compatible" support the use of the * character to perform partial (fuzzy) searches.
This allows you to query values without knowing the exact string or match several elements with one request.

Usage​

  • Use * at the end of a term to match values that start with the given text.
  • Use * at the beginning of a term to match values that end with the given text.
  • Use * on both sides of a term to match values that contain the given text.
  • Use * inside a term to match values that contain additional characters in between.

The * wildcard may also match zero characters (e.g., my*healthcheck matches myhealthcheck).