sync_volume_now
POST /v1/volumes/{volume_id}/sync
POST
/v1/volumes/{volume_id}/sync
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” volume_id
required
string
Volume ID
Responses
Section titled “ Responses ”Volume sync queued
object
archived_at
string | null format: date-time
created_at
required
string format: date-time
deleted_at
string | null format: date-time
description
string | null
id
required
string
Example
vol_01933b5a000070008000000000000001 is_readonly
required
boolean
last_sync_error
string | null
last_synced_at
string | null format: date-time
name
required
string
source
required
One of:
object
provider
required
string
object
branch
required
string
repository
required
string
root_folder
string | null
sync_interval_secs
Automatic resync interval in seconds. Omit or set 0 for manual-only; scheduled sync accepts 300 through 604800.
integer | null format: int32
provider
required
string
object
branch
required
string
root_folder
string | null
sync_interval_secs
Automatic resync interval in seconds. Omit or set 0 for manual-only; scheduled sync accepts 300 through 604800.
integer | null format: int32
url
required
string
provider
required
string
source_type
required
string
status
required
string
sync_status
required
string
updated_at
required
string format: date-time
Invalid sync request
Standard error response for API endpoints.
object
error
required
Error message describing what went wrong.
string
Volume not found
Standard error response for API endpoints.
object
error
required
Error message describing what went wrong.
string