Skip to main content
POST
UpdateVolume

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
name
string
newName
string | null

Omission preserves the current name.

description
string | null

Omission preserves the current value; an empty description clears it.

Response

Success

azure
azure · object
name
string

Mutable name, unique in its workspace: volumes/{volume}.

uid
string

Immutable UUID identity.

description
string
created_by
string | null
updated_by
string | null
created_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

updated_at
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

size_bytes
string<int64> | null
workspace
string

The workspace that owns the Volume, its creating credential's; the name is unique in it.

cf. Zitadel resource_owner; Modal volumes belong to a workspace.