snapshots

Update a snapshot's name or commit message.

patch/snapshots/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/snapshots/{id}
  • Auth: none declared. Required headers: x-organization-id

Path parameters

idstring required

Headers

x-organization-idstring required

Active organization id (or slug). Required for org-scoped operations; the generated client enforces it at compile time.

Request body

namestring
commitMessagestring

Response

Response

idstring required
namestring required
createTimeMsnumber required
sourceDevboxIdstring required
sourceAgentIdstring
sourceAgentNamestring
commitMessagestring
sizeBytesnumber
metadataobject

Changes

No recorded changes to this operation across all 50 revisions of this API.