---
title: "Liveness probe."
method: GET
path: "/api/health"
tags: ["Platform"]
---

# Liveness probe.

`GET /api/health`

## Request

- Base URL: `https://deepsearch.app`
- URL: `https://deepsearch.app/api/health`
- Auth: none required

Returns `status: "ok"` when the API is serving. Reports only this service - it deliberately does not ping downstream dependencies, because every monitor and scanner in the world hits this path.

## Response `200`

The service is up.

- object
  - `object` 'health', required
  - `status` 'ok', required
  - `api_version` 'v1', required
  - `developer_api` 'enabled' | 'disabled'
  - `time` string, date-time, required
  - `index_url` string, uri
  - `openapi_url` string, uri
  - `docs_url` string, uri
  - `status_url` string, uri

---

[API](https://skmtc.dev/deepsearch/apis/deepsearch-api.md) · [All operations](https://skmtc.dev/deepsearch/apis/deepsearch-api/llms.txt) · [OpenAPI document](https://skmtc.dev/deepsearch/apis/deepsearch-api/revisions/85fc8e2576a3?raw)