Get health

The health check endpoint enables you to periodically test the health of your Meilisearch instance. Returns a simple status indicating that the server is available.

The engine will return available status with a 200 status code when the instance is healthy. It will return mustRestart status with a 500 status code if the instance requires a restart. This restart is required after a compaction of the task queue for example.

GET /health

cURL

cURL

curl \
  -X GET 'MEILISEARCH_URL/health'

import requests

url = "http://localhost:7700/health"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('http://localhost:7700/health', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "7700",
  CURLOPT_URL => "http://localhost:7700/health",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:7700/health"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:7700/health")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:7700/health")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "status": "available"
}

Response

200 - application/json

Instance is healthy.

status · enum<string> · required

The status of the instance.

Available options: available, mustRestart