---
title: "List smb clusters"
method: GET
path: "/api/smb/cluster"
tags: ["SMB"]
---

# List smb clusters

`GET /api/smb/cluster`

List smb clusters

## Response `200`

OK

- object[]
  - `auth_mode` string — Either 'active-directory' or 'user'
  - `cluster_id` string — Unique identifier for the cluster
  - `custom_dns` string[] — List of custom DNS server addresses
  - `domain_settings` object — Domain-specific settings for active-directory auth mode
    - `join_sources` object[], required — List of join auth sources for domain settings
      - `ref` string, required — Reference identifier for the join auth resource
      - `source_type` string, required — resource
    - `realm` string, required — Domain realm, e.g., 'DOMAIN1.SINK.TEST'
  - `intent` string — Desired state of the resource, e.g., 'present' or 'removed'
  - `placement` object — Placement configuration for the resource
    - `count` integer, required — Number of instances to place
  - `public_addrs` object[] — Public Address
    - `address` string, required — This address will be assigned to one of the host's network devices
    - `destination` string, required — Defines where the system will assign the managed IPs.
  - `resource_type` string — ceph.smb.cluster
  - `user_group_settings` object[] — User group settings for user auth mode
    - `ref` string, required — Reference identifier for the user group resource
    - `source_type` string, required — resource

## Other responses

- `400` — Operation exception. Please check the response body for details.
- `401` — Unauthenticated access. Please login first.
- `403` — Unauthorized access. Please check your permissions.
- `500` — Unexpected error. Please check the response body for the stack trace.

---

[API](https://skmtc.net/ceph/apis/ceph-rest-api.md) · [All operations](https://skmtc.net/ceph/apis/ceph-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ceph/ceph-rest-api/versions/b03ae23c3806/schema)