---
title: "Configure server health check probes"
---
<PlanAvailability slug="entry-ent" />

This page describes how to configure health check probes for a Mattermost server.

Before you begin, you should have a running Mattermost server. If you don't, you can [install Mattermost on various distributions](/deployment-guide/deployment-guide-index).

<Note>

[Highly available Mattermost cluster support](/deployment-guide/server/high-availability-cluster-based-deployment) requires Mattermost Enterprise.

</Note>

You can perform a health check with the following 2 methods:

- [ping the APIv4 endpoint](#ping-the-apiv4-endpoint)
- [ping the Mattermost server](#ping-the-mattermost-server)

## Ping the APIv4 endpoint

You can use the [GET /system/ping APIv4 endpoint](https://api.mattermost.com/#tag/system%2Fpaths%2F~1system~1ping%2Fget) to check for system health.

A sample request is included below. The endpoint checks if the server is up and healthy based on the configuration setting `GoRoutineHealthThreshold`.

- If `GoRoutineHealthThreshold` and the number of goroutines on the server exceeds that threshold, the server is considered unhealthy.
- If `GoRoutineHealthThreshold` is not set or the number of goroutines is below the threshold the server is considered healthy.

This endpoint can also be provided to schedulers like [Kubernetes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/).

``` go
import "github.com/mattermost/mattermost/server/public/model"

Client := model.NewAPIv4Client("https://your-mattermost-url.com")
Client.Login("email@domain.com", "Password1")

// GetPing
status, err := Client.GetPing()
```

## Ping the Mattermost server

The [Mattermost Probe](https://github.com/csduarte/mattermost-probe) constantly pings a Mattermost server using a variety of probes.

These probes can be configured to verify core features, including sending and receiving messages, joining channels, pinging a login page, and searching of users and channels.

The project is contributed by the Mattermost open source community. Suggestions and contributions for the project are welcome.