---
title: "Perform basic catalog health check"
method: GET
path: "/api/v1/catalog/status/healthcheck"
tags: ["status"]
---

# Perform basic catalog health check

`GET /api/v1/catalog/status/healthcheck`

## Request

- The document declares no server URL.
- Auth: none declared

Run some basic health checks on the catalog service.

Returns:
- **HealthCheck**: A dictionary of various health check values.

## Response `200`

Health check results

- HealthCheck
  - `check_parameters` Params
    - `show_term` string
    - `search_term` string
    - `search_system` 'aarch64-darwin' | 'aarch64-linux' | 'x86_64-darwin' | 'x86_64-linux' | 'invalid'
    - `resolve_package` string
    - `resolve_systems` PackageSystem[]
  - `search_ok` boolean, required
  - `search_elapsed_ms` integer, required
  - `resolve_ok` boolean, required
  - `resolve_elapsed_ms` integer, required
  - `show_ok` boolean, required
  - `show_elapsed_ms` integer, required

## Other responses

- `500`: Internal Server Error

## Changes

- **2025-04-10** `05708530d20e`: 1 breaking, 6 info
  - the `check_parameters` response's property type changed from no type to `object` for status `200`
  - added the optional property `check_parameters/resolve_package` to the response with the `200` status
  - added the optional property `check_parameters/resolve_systems` to the response with the `200` status
  - added the optional property `check_parameters/search_system` to the response with the `200` status
  - …3 more
- **2025-02-13** `b1a16c027df3`: 1 info
  - endpoint added
- **2024-04-11** `7ba31661b446`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/flox/apis/floxhub-catalog-server/changes/api/v1/catalog/status/healthcheck/get.md)

---

[API](https://skmtc.dev/flox/apis/floxhub-catalog-server.md) - [All operations](https://skmtc.dev/flox/apis/floxhub-catalog-server/llms.txt) - [OpenAPI document](https://skmtc.dev/flox/apis/floxhub-catalog-server/revisions/6731453cd7cd?raw)