---
title: "Update a deployment"
method: PUT
path: "/api/v1/deployments/{deploymentId}"
tags: ["Deployments"]
---

# Update a deployment

`PUT /api/v1/deployments/{deploymentId}`

## Path parameters

- `deploymentId` integer, required

## Request body

- UpdateDeploymentInput
  - `cloudProvider` 'cubecloud' | 'aws' | 'gcp'
  - `creationMethod` 'upload' | 'cubecloud' | 'github' | 'ssh'
  - `cspsConfig` CspsConfigInput
    - `awsRoleArn` string, nullable
    - `azureClientId` string, nullable
    - `azureContainer` string, nullable
    - `azureStorageAccount` string, nullable
    - `azureTenantId` string, nullable
    - `enabled` boolean, required
    - `gcpServiceAccountEmail` string, nullable
    - `gcpWorkloadIdentityProvider` string, nullable
    - `gcsBucket` string, nullable
    - `s3Bucket` string, nullable
    - `s3Region` string, nullable
    - `s3Sse` string, nullable
    - `storageProvider` string, required
  - `customDomain` string, nullable
  - `defaultLaunchpadViewGroup` string, nullable
  - `deployBranchMergeAllowed` boolean, nullable
  - `deployBranchName` string, nullable
  - `deployBranchReadOnly` boolean, nullable
  - `deployMode` 'git' | 'cli'
  - `deployProjectRoot` string, nullable
  - `launchpadTabs` string[], nullable
  - `name` string, nullable
  - `region` string, nullable
  - `releaseChannel` 'latest' | 'release'
  - `releaseChannelVersion` string, nullable
  - `releaseChannelVersionHold` boolean, nullable
  - `template` 'single' | 'simpleCluster' | 'multiCluster'
  - `templateVariables` object, nullable

## Response `200`

- DeploymentSettings
  - `autoDomain` string, nullable
  - `cloudProvider` 'cubecloud' | 'aws' | 'gcp', required
  - `creationMethod` 'upload' | 'cubecloud' | 'github' | 'ssh'
  - `creationStep` 'project' | 'upload' | 'schema' | 'github' | 'ssh' | 'databases' | 'ready' | 'demo', required
  - `cspsConfig` CspsConfig
    - `awsRoleArn` string, nullable
    - `azureClientId` string, nullable
    - `azureContainer` string, nullable
    - `azureStorageAccount` string, nullable
    - `azureTenantId` string, nullable
    - `enabled` boolean, required
    - `gcpServiceAccountEmail` string, nullable
    - `gcpWorkloadIdentityProvider` string, nullable
    - `gcsBucket` string, nullable
    - `s3Bucket` string, nullable
    - `s3Region` string, nullable
    - `s3Sse` string, nullable
    - `storageProvider` string, required
  - `cubeImageCloud` string, nullable
  - `cubeImageVersion` string, nullable
  - `customDomain` string, nullable
  - `defaultLaunchpadViewGroup` string, nullable
  - `deployBranchMergeAllowed` boolean, required
  - `deployBranchName` string, required
  - `deployBranchReadOnly` boolean, required
  - `deployMode` 'git' | 'cli'
  - `deployProjectRoot` string, required
  - `deploymentUrl` string, required
  - `id` integer, required
  - `isCold` boolean, nullable
  - `isCubeSqlEnabled` boolean, required
  - `isManaged` boolean, nullable
  - `isSupportPreAggregations` boolean, required
  - `launchpadTabs` string[], nullable
  - `name` string, required
  - `region` string, nullable
  - `releaseChannel` 'latest' | 'release', required
  - `releaseChannelVersion` string, nullable
  - `releaseChannelVersionHold` boolean, nullable
  - `repoType` 'git' | 'deployRepo'
  - `targetPlatform` string, nullable
  - `template` 'single' | 'simpleCluster' | 'multiCluster', required
  - `templateVariables` object, nullable

## Changes

- **2026-08-27** `97e151460143` — 1 breaking, 8 warning, 4 info
  - the `creationStep` response's property type/format changed from ``/`` to `string`/`` for status `200`
  - added the new `databases` enum value to the `creationStep` response property for the response status `200`
  - added the new `demo` enum value to the `creationStep` response property for the response status `200`
  - added the new `github` enum value to the `creationStep` response property for the response status `200`
  - …9 more
- **2026-08-17** `29d481391a25` — 5 breaking, 43 info
  - the response property `creationStep` became optional for the status `200`
  - the response property `deploymentUrl` became optional for the status `200`
  - response property `deploymentUrl` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - added `#/components/schemas/CreationStep, subschema #2` to the `creationStep` response property `oneOf` list for the response status `200`
  - …44 more
- **2026-07-31** `a0c6b1d2ac96` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cube-js/apis/cube-cloud-rest-api/changes/api/v1/deployments/:deploymentId/put.md)

---

[API](https://skmtc.dev/cube-js/apis/cube-cloud-rest-api.md) · [All operations](https://skmtc.dev/cube-js/apis/cube-cloud-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cube-js/cube-cloud-rest-api/revisions/97e151460143/schema)