sandboxes

[Beta] Update a volume

Changed on

Beta: This API is in active development and may change without notice. Requires sandbox volumes to be enabled for your workspace. Update a volume's description or labels. Each field sent replaces the stored value; omitted fields are unchanged. Null, an empty description, or an empty labels object clears it. Only the volume's creator, or a role with sandboxes:exec, may update it.

patch/api/v2/sandboxes/volumes/{volume}

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v2/sandboxes/volumes/{volume}
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer

Path parameters

volumestring required

Volume ID or name

Request body

descriptionstring nullable

Description replaces the description; null or an empty string clears it.

labelsobject nullable

Labels replaces every label; null or an empty object clears them.

Response

OK

created_atstring date-time
created_bystring
descriptionstring
idstring
labelsSandboxesLabels
namestring
size_bytesinteger
source_volume_idstring
statusstring
status_messagestring
updated_atstring date-time
updated_bystring

Changes