---
title: "Create Cluster Group Deployment"
method: POST
path: "/api/v1/orgs/{orgid}/clustergroups/{clusterGroupId}/deployments"
tags: ["clustergroup deployments"]
---

# Create Cluster Group Deployment

`POST /api/v1/orgs/{orgid}/clustergroups/{clusterGroupId}/deployments`

creates a new cluster group deployment, installs or upgrades deployment on each member cluster accordingly

## Path parameters

- `orgId` integer, required
- `clusterGroupId` integer, required

## Request body

- DeploymentClusterGroupDeployment
  - `atomic` boolean
  - `dryrun` boolean
  - `name` string, required
  - `namespace` string
  - `package` integer[]
  - `releaseName` string
  - `reuseValues` boolean
  - `rollingMode` boolean
  - `valueOverrides` object
  - `values` object
  - `version` string

## Response `201`

Multi-cluster deployment has been created successfully. All install / upgrade operations on all targeted clusters returned with no errors.

- DeploymentCreateUpdateDeploymentResponse
  - `releaseName` string
  - `targetClusters` DeploymentTargetClusterStatus[]
    - `cloud` string
    - `clusterId` integer
    - `clusterName` string
    - `distribution` string
    - `error` string
    - `stale` boolean
    - `status` string
    - `version` string

## Other responses

- `207` — Partial failure
- `default` — Internal server error

---

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