---
title: "Update metadata of Disk Snapshot."
method: POST
path: "/v1/devboxes/disk_snapshots/{id}"
tags: ["Devbox", "Devbox-PersistenceTools"]
---

# Update metadata of Disk Snapshot.

`POST /v1/devboxes/disk_snapshots/{id}`

Updates disk snapshot metadata via update vs patch. The entire metadata will be replaced.

## Path parameters

- `id` string, required

## Request body

- DevboxSnapshotRequest
  - `name` string, nullable — (Optional) A user specified name to give the snapshot
  - `metadata` object, nullable — (Optional) Metadata used to describe the snapshot
  - `commit_message` string, nullable — (Optional) Commit message associated with the snapshot (max 1000 characters)

## Response `200`

Snapshot created successfully.

- DevboxDiskSnapshotView
  - `id` string, required — The unique identifier of the snapshot.
  - `name` string, nullable — (Optional) The custom name of the snapshot.
  - `create_time_ms` integer, required — Creation time of the Snapshot (Unix timestamp milliseconds).
  - `metadata` object, required — User defined metadata associated with the snapshot.
  - `source_devbox_id` string, required — The source Devbox ID this snapshot was created from.
  - `source_blueprint_id` string, nullable — (Optional) The source Blueprint ID this snapshot was created from.
  - `commit_message` string, nullable — (Optional) The commit message of the snapshot (max 1000 characters).
  - `size_bytes` integer, nullable — (Optional) The size of the snapshot in bytes, relative to the base blueprint.

## Other responses

- `404` — Devbox not found.

## Changes

- **2026-05-27** `d3ddb452754c` — 3 breaking
  - the request property `commit_message` became not nullable
  - the request property `metadata` became not nullable
  - the request property `name` became not nullable
- **2026-02-12** `c8d61a0c8b88` — 1 info
  - added the optional property `size_bytes` to the response with the `200` status
- **2025-11-19** `5f33221208c1` — 1 info
  - added the optional property `source_blueprint_id` to the response with the `200` status
- **2025-10-15** `436b4f5c7426` — 2 info
  - added the new optional request property `commit_message`
  - added the optional property `commit_message` to the response with the `200` status

[Change history](https://skmtc.dev/runloopai/apis/runloop-api/changes/v1/devboxes/disk_snapshots/:id/post.md)

---

[API](https://skmtc.dev/runloopai/apis/runloop-api.md) · [All operations](https://skmtc.dev/runloopai/apis/runloop-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runloopai/runloop-api/revisions/e9dc776053e4/schema)