---
title: "Updates a SandboxEngineImage."
method: PATCH
path: "/v1/{sandboxEngineImage.name}"
tags: ["SandboxEngineImageService"]
---

# Updates a SandboxEngineImage.

`PATCH /v1/{sandboxEngineImage.name}`

## Request

- Base URL: `https://docs.h2o.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.h2o.ai/v1/{sandboxEngineImage.name}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/docs/v1/:sandboxEngineImage.name/patch.ts> (a function with typed inputs; its response is checked against the schema)

Authorization may require the following permission on the image's parent workspace:
* actions/enginemanager/sandboxEngineImages/UPDATE

## Path parameters

- `sandboxEngineImage.name` string, required

## Query parameters

- `updateMask` string, required

## Request body

- object
  - `displayName` string: Optional. Human-readable name.
  - `image` string, required
  - `enabled` boolean: Optional. Whether the SandboxEngineImage is enabled. Disabled SandboxEngineImage cannot be used for creating new SandboxEngine.
  - `imagePullPolicy` 'IMAGE_PULL_POLICY_UNSPECIFIED' | 'IMAGE_PULL_POLICY_ALWAYS' | 'IMAGE_PULL_POLICY_NEVER' | 'IMAGE_PULL_POLICY_IF_NOT_PRESENT': Policy for downloading an image in K8s. - IMAGE_PULL_POLICY_UNSPECIFIED: Unspecified image pull policy. - IMAGE_PULL_POLICY_ALWAYS: Every time the container is launched, the container image registry is queried to resolve the name to an image digest. - IMAGE_PULL_POLICY_NEVER: Do not try to fetch the image. If the image is already present locally, the container will start. If the image is not present, container startup will fail. - IMAGE_PULL_POLICY_IF_NOT_PRESENT: The image is pulled only if it is not already present locally.
  - `imagePullSecrets` string[]: Optional. A list of Kubernetes secret references used for authenticating to private container registries or repositories. These secrets provide the necessary credentials to pull Docker images from private repositories. Each entry in this list should be the name of a Kubernetes secret configured in the cluster.
  - `createTime` string, date-time: Output only. Time when the SandboxEngineImage was created.
  - `updateTime` string, date-time, nullable: Output only. Time when the SandboxEngineImage was last updated.
  - `creator` string: Output only. Name of entity that created the SandboxEngineImage.
  - `updater` string: Output only. Name of entity that last updated the SandboxEngineImage.
  - `creatorDisplayName` string: Output only. Human-readable name of entity that created the SandboxEngineImage.
  - `updaterDisplayName` string: Output only. Human-readable name of entity that last updated the SandboxEngineImage.

## Response `200`

A successful response.

- V1UpdateSandboxEngineImageResponse: Response message for UpdateSandboxEngineImage.
  - `sandboxEngineImage` V1SandboxEngineImage: SandboxEngineImage represents a Docker image that is used to run a Sandbox engine. An existing SandboxEngineImage must be specified when creating a new SandboxEngine.
    - `name` string: Identifier. Resource name. Format is `workspaces/*/sandboxEngineImages/*`.
    - `displayName` string: Optional. Human-readable name.
    - `image` string, required
    - `enabled` boolean: Optional. Whether the SandboxEngineImage is enabled. Disabled SandboxEngineImage cannot be used for creating new SandboxEngine.
    - `imagePullPolicy` 'IMAGE_PULL_POLICY_UNSPECIFIED' | 'IMAGE_PULL_POLICY_ALWAYS' | 'IMAGE_PULL_POLICY_NEVER' | 'IMAGE_PULL_POLICY_IF_NOT_PRESENT': Policy for downloading an image in K8s. - IMAGE_PULL_POLICY_UNSPECIFIED: Unspecified image pull policy. - IMAGE_PULL_POLICY_ALWAYS: Every time the container is launched, the container image registry is queried to resolve the name to an image digest. - IMAGE_PULL_POLICY_NEVER: Do not try to fetch the image. If the image is already present locally, the container will start. If the image is not present, container startup will fail. - IMAGE_PULL_POLICY_IF_NOT_PRESENT: The image is pulled only if it is not already present locally.
    - `imagePullSecrets` string[]: Optional. A list of Kubernetes secret references used for authenticating to private container registries or repositories. These secrets provide the necessary credentials to pull Docker images from private repositories. Each entry in this list should be the name of a Kubernetes secret configured in the cluster.
    - `createTime` string, date-time: Output only. Time when the SandboxEngineImage was created.
    - `updateTime` string, date-time, nullable: Output only. Time when the SandboxEngineImage was last updated.
    - `creator` string: Output only. Name of entity that created the SandboxEngineImage.
    - `updater` string: Output only. Name of entity that last updated the SandboxEngineImage.
    - `creatorDisplayName` string: Output only. Human-readable name of entity that created the SandboxEngineImage.
    - `updaterDisplayName` string: Output only. Human-readable name of entity that last updated the SandboxEngineImage.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto.md) - [All operations](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/ai-h2o-engine-sandbox-v1-filesystem-proto/revisions/297cfadc1d39?raw)