---
title: "List registered Hugging Bay mirror nodes and their health."
method: GET
path: "/api/mirrors"
tags: ["Mirrors", "Agent Docs"]
---

# List registered Hugging Bay mirror nodes and their health.

`GET /api/mirrors`

## Request

- Base URL: `https://huggingbay.xyz`
- URL: `https://huggingbay.xyz/api/mirrors`
- Auth: none declared

Public mirror inventory for agents, operators, and crawlers. Admin-only POST registers reviewed mirrors.

**Inputs.** Path, query and header fields are listed below. No request body is required.

**Outputs.** See each status below for its media type, schema and headers. A missing record or unavailable capability is not a successful empty result.

**Errors.** API JSON failures use the documented response schema. Read code, message and next; retry only when the response allows it. Auth, invalid input and missing records need a caller change.

**Rate limits.** Public read budgets apply by client IP and route group. This operation can have a smaller route-specific budget. Read Retry-After on 429 or retryable 503 responses.

## Query parameters

- `compat` 'containment'

## Response `200`

Mirror node rows

- MirrorNode[]
  - `id` string, required
  - `name` string, required
  - `region` string, required
  - `endpoint` string, uri, required
  - `health` 'healthy' | 'stale' | 'degraded' | 'quarantined', required
  - `publicOnly` boolean, required
  - `freshnessMinutes` number, required
  - `artifactCount` number, required
  - `bandwidthTb` number, required

---

[API](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api.md) · [All operations](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/huggingbay/apis/hugging-bay-public-api/revisions/63c474bf0fe4?raw)