Health check

Liveness. With deep=1 also checks the accounts DB, the sites DB and the isx archive (5 s timeout).

GEThttps://apis.newssearchapi.com/healthPublic · no key

Parameters

deepstringquery
Run dependency checks (case-insensitive).
One of
10truefalse

Healthy. `checks` is present only with `deep=1`.

Every error uses the same envelope with a stable code. See error handling for which ones to retry.

400Invalid parameter (`parameterInvalid`) — unknown/repeated parameter, bad format or out-of-range value.
405Only GET, HEAD and OPTIONS are supported (`methodNotAllowed`).
503A dependency check failed (deep only).

curl "https://apis.newssearchapi.com/health?deep=1"

const response = await fetch("https://apis.newssearchapi.com/health?deep=1");
const data = await response.json();

import os
import requests

response = requests.get(
    "https://apis.newssearchapi.com/health?deep=1",
)
data = response.json()

req, _ := http.NewRequest(
    "GET",
    "https://apis.newssearchapi.com/health?deep=1",
    nil,
)
resp, err := http.DefaultClient.Do(req)

$response = file_get_contents(
    "https://apis.newssearchapi.com/health?deep=1"
);
$data = json_decode($response, true);

No key needed

GET/health

Example response · 200

{
  "status": "ok"
}

Stuck or found a mistake?Email developer support