---
title: "Update deployment"
method: PATCH
path: "/v1/container-deployments/{deployment_name}"
tags: ["Serverless Containers"]
---

# Update deployment

`PATCH /v1/container-deployments/{deployment_name}`

## Path parameters

- `deployment_name` string, required

## Request body

- PatchDeploymentPublicApiDto
  - `container_registry_settings` ContainerRegistrySettingsPublicApiDto
    - `is_private` boolean, required — Privacy mode of the container registry - is it public or private
    - `credentials` ContainerRegistryCredentials, required
      - `name` string, required — Credential name of the secret containing the credentials
  - `containers` PatchContainerPublicApiDto[] — Containers properties to be updated
    - `name` string, required — Name of the container to update
    - `image` string — Image to be deployed in the container
    - `should_use_cached_image` boolean — Whether to use cached container image when available
    - `exposed_port` number — Port to be exposed by the container
    - `healthcheck` HealthcheckSettings
      - `enabled` boolean, required — Is healthcheck enabled for the container. It it used to check if the container is ready to accept traffic
      - `port` number, required — Port to be used for healthcheck
      - `path` string, required — Path to be used for healthcheck
    - `entrypoint_overrides` EntrypointOverridesSettings
      - `enabled` boolean, required — Is the default docker start command and arguments overridden
      - `entrypoint` string[] — Entrypoint command to start the container
      - `cmd` string[] — Arguments to the entrypoint command
    - `env` EnvVarPublicApi[] — Environment variables for the container
      - `name` string, required — Name of the environment variable
      - `value_or_reference_to_secret` string, required — Value of the environment variable, or a reference to the secret
      - `type` 'plain' | 'secret', required — Type of the environment variable
    - `autoupdate` AutoupdateSettings
      - `enabled` boolean, required — Is autoupdate enabled for the container
      - `mode` 'latest' | 'semantic', required — Autoupdate mode for the container
      - `tag_filter` string — Tag filter for the autoupdate. Supports regex
    - `volume_mounts` union[] — Volume mounts for the container
      - union
        - ScratchVolumeMountDto
          - `type` 'scratch', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted
        - SecretVolumeMountDto
          - `type` 'secret', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted.
          - `secret_name` string, required — Name of the fileset secret to be mounted
        - SharedVolumeMountDto
          - `type` 'shared', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted.
          - `volume_id` string, required — ID of the shared volume to be mounted
        - MemoryVolumeMountDto
          - `type` 'memory', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted. This setting is fixed for now and cannot be changed
          - `size_in_mb` 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768, required — Size of memory volume in MiB
  - `compute` ComputeResource
    - `name` string, required — Name of the compute resource
    - `size` number, required — Number of compute units (e.g. 4 GPUs). Default is 1
  - `is_spot` boolean — Spot instance settings for the deployment

## Response `200`

Returns the updated deployment

- DeploymentPublicApiResponseDto
  - `name` string, required — Deployment name
  - `containers` ContainerPublicApiResponseDto[], required — Containers in the deployment
    - `should_use_cached_image` boolean — Whether to use cached container image when available
    - `exposed_port` number, required — Port to be exposed by the container
    - `healthcheck` HealthcheckSettings
      - `enabled` boolean, required — Is healthcheck enabled for the container. It it used to check if the container is ready to accept traffic
      - `port` number, required — Port to be used for healthcheck
      - `path` string, required — Path to be used for healthcheck
    - `entrypoint_overrides` EntrypointOverridesSettings
      - `enabled` boolean, required — Is the default docker start command and arguments overridden
      - `entrypoint` string[] — Entrypoint command to start the container
      - `cmd` string[] — Arguments to the entrypoint command
    - `env` EnvVarPublicApi[] — Environment variables for the container
      - `name` string, required — Name of the environment variable
      - `value_or_reference_to_secret` string, required — Value of the environment variable, or a reference to the secret
      - `type` 'plain' | 'secret', required — Type of the environment variable
    - `volume_mounts` union[] — Volume mounts for the container
      - union
        - ScratchVolumeMountDto
          - `type` 'scratch', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted
        - SecretVolumeMountDto
          - `type` 'secret', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted.
          - `secret_name` string, required — Name of the fileset secret to be mounted
        - SharedVolumeMountDto
          - `type` 'shared', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted.
          - `volume_id` string, required — ID of the shared volume to be mounted
        - MemoryVolumeMountDto
          - `type` 'memory', required — Type of the volume
          - `mount_path` string, required — Path in the container where the volume will be mounted. This setting is fixed for now and cannot be changed
          - `size_in_mb` 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768, required — Size of memory volume in MiB
    - `image` object, required — Image details
    - `name` string, required — Container name
  - `endpoint_base_url` string, required — The base URL of the endpoint
  - `created_at` string, required
  - `compute` ComputeResource, required
    - `name` string, required — Name of the compute resource
    - `size` number, required — Number of compute units (e.g. 4 GPUs). Default is 1
  - `container_registry_settings` ContainerRegistrySettingsPublicApiDto, required
    - `is_private` boolean, required — Privacy mode of the container registry - is it public or private
    - `credentials` ContainerRegistryCredentials, required
      - `name` string, required — Credential name of the secret containing the credentials
  - `is_spot` boolean, required

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/datacrunch/apis/verda-cloud-public-api.md) · [All operations](https://skmtc.net/datacrunch/apis/verda-cloud-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/datacrunch/verda-cloud-public-api/revisions/0d66c7340876/schema)