Skip to main content
PATCH
Update Task

Authorizations

Authorization
string
header
required

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

Path Parameters

task_id
string<uuid>
required
team_id
string<uuid>
required

Body

application/json

Schema for updating an existing task.

All fields are optional to support partial updates.

name
string | null
Required string length: 1 - 255
description
string | null
Maximum string length: 2000
task_type
enum<string> | null

Task operation types.

Available options:
copy,
sync
source_location_id
string<uuid> | null
destination_location_id
string<uuid> | null
source_path
string | null
Maximum string length: 1000
destination_path
string | null
Maximum string length: 1000
rclone_config
RCloneConfigInput · object | null

RCloneConfig plus invariants enforced at write time only.

TaskCreate/TaskUpdate use this subclass; responses keep the lenient base model. The base must stay lenient because it also types TaskResponse.rclone_config, which Pydantic re-validates from the stored row on every read — a legacy row written before an invariant existed has to render in the task detail, not turn it into a 500.

is_scheduled
boolean | null
schedule_cron
string | null
Maximum string length: 100

Response

Successful Response

Full task response with rclone config (for CRUD and detail endpoints).

id
string<uuid>
required
team_id
string<uuid>
required
created_by
string<uuid>
required
name
string
required
task_type
enum<string>
required

Task operation types.

Available options:
copy,
sync
source_location_id
string<uuid>
required
source_location_name
string
required

Source location display name

source_location_bucket
string
required

Source location bucket name

source_location_type
string
required

Source location provider type

destination_location_id
string<uuid>
required
destination_location_name
string
required

Destination location display name

destination_location_bucket
string
required

Destination location bucket name

destination_location_type
string
required

Destination location provider type

is_scheduled
boolean
required
status
enum<string>
required

Task definition status.

Available options:
enabled,
disabled,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
Maximum string length: 2000
source_path
string | null

Path within source bucket

Maximum string length: 1000
Example:

"/prod/data"

destination_path
string | null

Path within destination bucket

Maximum string length: 1000
Example:

"/backup"

schedule_cron
string | null
Maximum string length: 100
last_scheduled_run_at
string<date-time> | null

Last scheduled execution time

rclone_config
RCloneConfig · object

RClone configuration options (includes provider-specific defaults)