---
title: "Create smb cluster"
method: POST
path: "/api/smb/cluster"
tags: ["SMB"]
---

# Create smb cluster

`POST /api/smb/cluster`

Create an smb cluster

        :param cluster_resource: Dict cluster data
        :return: Returns cluster resource.
        :rtype: Dict[str, Any]

## Request body

- object
  - `cluster_resource` string, required — cluster_resource

## Response `201`

Resource created.

- object
  - `results` object[], required — List of operation results
    - `resource` object, required — Resource
      - `auth_mode` string, required — Either 'active-directory' or 'user'
      - `cluster_id` string, required — Unique identifier for the cluster
      - `custom_dns` string[], required — List of custom DNS server addresses
      - `domain_settings` object, required — 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, required — Desired state of the resource, e.g., 'present' or 'removed'
      - `placement` object, required — Placement configuration for the resource
        - `count` integer, required — Number of instances to place
      - `public_addrs` object[], required — 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, required — ceph.smb.cluster
      - `user_group_settings` object[], required — User group settings for user auth mode
        - `ref` string, required — Reference identifier for the user group resource
        - `source_type` string, required — resource
    - `state` string, required — The current state of the resource, e.g., 'created', 'updated', 'deleted'
    - `success` boolean, required — Indicates if the operation was successful
  - `success` boolean, required — Indicates if the overall operation was successful

## Other responses

- `202` — Operation is still executing. Please check the task queue.
- `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/revisions/b03ae23c3806/schema)