Skip to main content
PATCH
Volume Settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

owner
string
required
name
string
required

Body

application/json
visibility
enum<string> | null
Available options:
private,
public,
team
team
string | null
description
string | null
allow_download
boolean | null
allow_use
boolean | null
usable_by
string[] | null
allow_preview
boolean | null
watermark
boolean | null
watermark_text
string | null

Response

Successful Response

A volume's own record: who may see it, and how its content may be read back.

id
string
required
owner
string
required
name
string
required
visibility
enum<string>
required
Available options:
private,
public,
team
description
string
required
created_at
integer
required
allow_download
boolean
required
allow_use
boolean
required
usable_by
string[]
required
allow_preview
boolean
required
watermark
boolean
required
watermark_text
string
required
classification
string
required
backing
string
required
connection
string
required
source_path
string
required
external
boolean
required