---
title: "Retrieve peer clusters for a user"
method: GET
path: "/api/clusters/peers"
tags: ["Cloud18"]
---

# Retrieve peer clusters for a user

`GET /api/clusters/peers`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `Authorization`

This endpoint retrieves the peer clusters that a user has access to.

## Headers

- `Authorization` string, required

## Response `200`

List of peer clusters

- PeerPeerCluster[]
  - `activePassiveStatus` string
  - `api-credentials-acl-allow` string
  - `api-credentials-acl-allow-external` string
  - `api-public-url` string
  - `cloud18-cost-currency` string
  - `cloud18-database-read-srv-record` string
  - `cloud18-database-read-write-split-srv-record` string
  - `cloud18-database-read-write-srv-record` string
  - `cloud18-domain` string
  - `cloud18-external-dbops` string
  - `cloud18-external-sysops` string
  - `cloud18-infra-certifications` string
  - `cloud18-infra-cpu-freq` string
  - `cloud18-infra-cpu-model` string
  - `cloud18-infra-data-centers` string
  - `cloud18-infra-geo-localizations` string
  - `cloud18-infra-public-bandwidth` string
  - `cloud18-monthly-dbops-cost` string
  - `cloud18-monthly-infra-cost` string
  - `cloud18-monthly-license-cost` string
  - `cloud18-monthly-sysops-cost` string
  - `cloud18-open-dbops` string
  - `cloud18-open-sysops` string
  - `cloud18-peer` string
  - `cloud18-platform-description` string
  - `cloud18-promotion-pct` string
  - `cloud18-shared` string
  - `cloud18-sla-provision-time` string
  - `cloud18-sla-repair-time` string
  - `cloud18-sla-response-time` string
  - `cloud18-sub-domain` string
  - `cloud18-sub-domain-zone` string
  - `cloud18-subscribed-dbops` string
  - `cluster-name` string
  - `dbServers` integer
  - `directUpdate` string: last successful direct /api/clusters enrichment
  - `isDown` boolean
  - `isFailable` boolean
  - `isMasterDown` boolean
  - `isProvisioned` boolean
  - `lastUpdate` string
  - `monitoringPause` boolean
  - `prov-db-cpu-cores` string
  - `prov-db-disk-iops` string
  - `prov-db-disk-size` string
  - `prov-db-memory` string
  - `prov-orchestrator` string
  - `prov-service-plan` string
  - `proxyServers` integer
  - `repmgrVersion` string
  - `topology` string: Live monitoring fields — populated by the direct /api/clusters fetch from the peer (auto-connect to fleet), NOT present in the BO peer.json catalog. They stay empty until a successful direct connection enriches the row, and are preserved across peer.json BatchUpdateClusters (which would otherwise reset them).
  - `uptime` string

## Other responses

- `401`: Unauthenticated resource
- `500`: Failed to get token claims or Error Marshal

## Changes

- **2026-07-17** `7465ea0ee21a`: 1 info
  - endpoint added
- **2023-03-31** `b57fc7b9446e`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/changes/api/clusters/peers/get.md)

---

[API](https://skmtc.dev/signal18/apis/signal-18-dashboard-api.md) - [All operations](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/revisions/8ee8a1e31294?raw)