> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Image

> Renames a custom Docker image and/or changes its description, without building anything.

Changes the image's `name` and/or `description`. Nothing is built or restarted: the image keeps its ID and versions, and the applications created from it keep running. Send only the fields you want to change; at least one is required. Platform images (`owner: "system"`) cannot be changed.

Needs the `images:write` scope when called with an API key. In a workspace, you need permission to manage the workspace's apps.

**image\_id** `string` *required*

The image ID.

**workspace\_id** `string`

If the image belongs to a workspace, the workspace's ID.

**name** `string`

The new name: 1 to 50 characters, unique among the owner's images. Sending the current name is not an error. A name already used by another of your images fails with `VALIDATION_ERROR`, with `path` set to `name`.

**description** `string | null`

The new description, up to 128 characters (free text). `null` or an empty string removes it.

### Response

**response** `object`

The updated image.

**Toggle object**

**id** `string`

The image ID.

**name** `string`

The image name.

**description** `string | null`

The image description (free text, up to 128 characters), or `null` when it has none.

**owner** `string`

`account` for your own images, `system` for images provided by the platform (these cannot be changed or deleted).

**status** `string`

State of the latest build: `building`, `success` or `failed`. A failed rebuild does not change the current version: apps keep running the last good one.

**error** `string | null`

Readable reason of the latest failed build, or `null`.

**digest** `string | null`

Digest (`sha256:...`) of the current version, or `null` while no build has succeeded.

**uncompressed\_bytes** `integer | null`

Size of the current version, uncompressed, in bytes.

**layer\_count** `integer | null`

Number of layers of the current version.

**apps** `object[]`

The applications created from this image. Each has `id`, `name`, `version_id` (the image version it runs, or `null`) and `outdated` (`true` when the image has a newer version; the app moves to it on the next restart or deploy you ask for).

**github** `object | null`

The linked GitHub repository and branch (`repository` as `owner/name`, `branch`), or `null` when the image is not linked.

**current\_version\_id** `string | null`

The current version of the image, or `null` while no build has succeeded.

**created\_at** `string`

When the image was created.

**updated\_at** `string`

When the image was last updated.

```json Response theme={null}
{
  "response": {
    "id": "img-abc123def456",
    "name": "my-api-base",
    "description": "Node 22 with our base packages",
    "owner": "account",
    "status": "success",
    "error": null,
    "digest": "sha256:3f1c0a9d5b7e2c4a8d6f1b0e9c3a7d5f2b4e6a8c0d1f3b5a7c9e2d4f6a8b0c1e",
    "uncompressed_bytes": 187432960,
    "layer_count": 9,
    "apps": [
      {
        "id": "app-abc123def456",
        "name": "my-api-prod",
        "version_id": "imgv-111aaa222bbb",
        "outdated": false
      }
    ],
    "github": null,
    "current_version_id": "imgv-111aaa222bbb",
    "created_at": "2026-10-23T14:02:00Z",
    "updated_at": "2026-10-23T14:09:00Z"
  }
}
```

### Error Responses

**code** `string`

The error code indicating the reason for the failure. Possible values:

* `API_KEY_SCOPE_DENIED`: The API key does not have the required scope (`403`).
* `VALIDATION_ERROR`: The body is empty, the name is not 1 to 50 characters, the name is already used by another of your images (`path` is `name`), the description is longer than 128 characters, or the name or description has control characters (`400`).
* `ACCESS_DENIED`: The image is a platform image, which cannot be changed (`403`).
* `IMAGE_NOT_FOUND`: The image does not exist or you cannot access it (`404`).
* `INTERNAL_SERVER_ERROR`: Unexpected failure (`500`).

```json Error Response theme={null}
{
  "code": "VALIDATION_ERROR",
  "message": "An image with this name already exists",
  "path": "name"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.