Volumes

Update a volume

Changed on

Update an existing volume's configuration or contents

patch/v1/deployments/storage/volumes/{id}

Request

  • Base URL
    https://api.together.ai
  • URL
    https://api.together.ai/v1/deployments/storage/volumes/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Volume ID or name.

Request body

namestring

Name is the new unique identifier for the volume within the project

type'readOnly'

Example request

{
  "content": {
    "origin": {
      "s3": {
        "role_arn": "arn:aws:iam::123456789012:role/together-volumes",
        "uri": "s3://my-bucket/models/custom-weights"
      }
    },
    "source_prefix": "models/",
    "type": "files"
  }
}

Response

Volume updated successfully

created_atstring

CreatedAt is the ISO8601 timestamp when this volume was created

current_versioninteger

CurrentVersion is the current version number of this volume

idstring

ID is the unique identifier for this volume

mounted_bystring[]

MountedBy is the list of deployment IDs currently mounting current volume version

namestring

Name is the name of the volume

objectstring

Object is the type identifier for this response (always "volume")

status'ready' | 'pending' | 'syncing' | 'failed'

Status of a volume version. Only ready versions can be mounted.

status_messagestring

Message explaining why the current volume version failed, when applicable.

type'readOnly'
updated_atstring

UpdatedAt is the ISO8601 timestamp when this volume was last updated

version_historyobject

VersionHistory contains previous versions of this volume, keyed by version number

Example response

{
  "content": {
    "origin": {
      "s3": {
        "role_arn": "arn:aws:iam::123456789012:role/together-volumes",
        "uri": "s3://my-bucket/models/custom-weights"
      }
    },
    "source_prefix": "models/",
    "type": "files"
  }
}

Changes