---
title: "POST /api/v1/clusters/{cluster_name}"
method: POST
path: "/api/v1/clusters/{cluster_name}"
tags: ["Cluster"]
---

# POST /api/v1/clusters/{cluster_name}

`POST /api/v1/clusters/{cluster_name}`

## Request

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

## Path parameters

- `cluster_name` string, required

## Query parameters

- `insecure_skip_check` boolean

## Request body

- ApiClusterV1SaveRequestBody: Body represents the body of the save request.
  - `api_server` string: api_server specifies the API server address of the cluster.
  - `cluster_kind` string: cluster_kind specifies the kind of the cluster.
  - `cluster_type` string: cluster_type specifies the type of the cluster. It can be "physical" or "virtual".
  - `usage` string: usage specifies the usage of the cluster. It can be "host" or "worker".
  - `host_cluster` string: host_cluster specifies the host cluster name if the cluster is a virtual cluster.
  - `vcluster` ApiClusterV1Vcluster: Vcluster represents the configuration for the virtual cluster.
    - `https_node_port` string: httpsNodePort specifies the NodePort for the HTTPS port of the virtual cluster.
  - `kubeconfig` string: kubeconfig specifies the Kubeconfig file of the cluster.
  - `worker_type` string: worker_type maybe pipeline or deployment, when the cluster usage is 'worker', the WorkType is required.
  - `primary_domain` string: primary_domain is used to build the domain of components within the cluster.
  - `reserved_namespaces_allowed_products` object: reserved_namespaces_allowed_products key is namespace name, value is the product name list witch can use namespace.
  - `product_allowed_cluster_resources` object: product_allowed_cluster_resources key is product name, value is the list of cluster resources.
  - `components_list` ApiClusterV1ComponentsList
    - `multi_tenant` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `secret_sync` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `gateway` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `deployment` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `progressive_delivery` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `pipeline` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `event_listener` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object

## Response `200`

OK

- ApiClusterV1SaveReply: SaveReply represents a response to a save request.
  - `message` string: msg specifies the message of the save response.

## Changes

- **2023-12-21** `58206cc16454`: 4 breaking, 8 warning
  - added `#/components/schemas/api.cluster.v1.ComponentsList` to the `components_list` request property `allOf` list
  - added `#/components/schemas/api.cluster.v1.Vcluster` to the `vcluster` request property `allOf` list
  - the `components_list` request property type changed from `object` to no type
  - the `vcluster` request property type changed from `object` to no type
  - …8 more
- **2023-09-27** `55de8d9ba194`: 1 warning
  - removed the request property `components_list/cert_management`
- **2023-09-27** `2bd9e337f836`: 6 warning, 8 info
  - removed the request property `argocd_host`
  - removed the request property `components_list/cert_mgt`
  - removed the request property `components_list/ingress_controller`
  - removed the request property `components_list/secret_mgt`
  - …10 more
- **2023-08-08** `9c89db0ede4e`: 2 breaking, 2 warning, 13 info
  - the `components_list` request property type changed from no type to `object`
  - the `vcluster` request property type changed from no type to `object`
  - removed `#/components/schemas/api.cluster.v1.ComponentsList` from the `components_list` request property `allOf` list
  - removed `#/components/schemas/api.cluster.v1.Vcluster` from the `vcluster` request property `allOf` list
  - …13 more

[Operation history](https://skmtc.dev/nautes-labs/apis/nautes-api/changes/api/v1/clusters/:cluster_name/post.md)

---

[API](https://skmtc.dev/nautes-labs/apis/nautes-api.md) - [All operations](https://skmtc.dev/nautes-labs/apis/nautes-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nautes-labs/apis/nautes-api/revisions/ce38dc32cd8a?raw)