Tasks
API Key Scope: tasks / index
Authorizations
Query parameters
limitintegerOptional
The number of items to display for pagination.
offsetintegerOptional
The number of items to skip for pagination.
sort_bystring[]Optional
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
allbooleanOptional
For admin only, display also resources by other users.
idstringOptional
Filter on id
namestringOptional
Filter on name
workflow_typestringOptional
Filter on task workflow type
workflow_actionstringOptional
Filter on task workflow action
sources.typestringOptional
Filter on task sources type
destinations.typestringOptional
Filter on task destinations type
created_atstringOptional
Filter on creation date
updated_atstringOptional
Filter on modification date
Responses
200
List of tasks.
application/json
get
/tasksGET /api/v2/tasks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200
List of tasks.
{
"count": 1,
"tasks": [
{
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
]
}API Key Scope: tasks / create
Authorizations
Body
idstringRead-onlyOptional
namestringOptional
commentstringOptional
workflow_typestring · enumOptionalPossible values:
workflow_actionstring · enumOptionalPossible values:
updated_atstring · date-timeRead-onlyOptional
created_bystringRead-onlyOptional
updated_bystringRead-onlyOptional
Responses
201
A specific task.
application/json
422
The received resource was not correctly formatted.
application/json
post
/tasksPOST /api/v2/tasks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 4435
{
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
}
}{
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
}
}API Key Scope: tasks / show
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
200
A specific task.
application/json
404
The requested resource was not found. The detailed error will be of type not_found.
application/json
get
/tasks/{task_id}GET /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
}
}API Key Scope: tasks / update
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Body
idstringRead-onlyOptional
namestringOptional
commentstringOptional
workflow_typestring · enumOptionalPossible values:
workflow_actionstring · enumOptionalPossible values:
updated_atstring · date-timeRead-onlyOptional
created_bystringRead-onlyOptional
updated_bystringRead-onlyOptional
Responses
200
A specific task.
application/json
422
The received resource was not correctly formatted.
application/json
put
/tasks/{task_id}PUT /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 4435
{
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
}
}{
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": {
"id": "text",
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"options": {
"priority": 1,
"conflict_resolution": "rename",
"file_checksum": "crc32",
"reset_file_date": true,
"reset_folder_date": true,
"execution_task_id": "text",
"selected_drive": "text",
"selected_drive_2": "text",
"task_id": "text",
"full_report": true,
"backup_report": 1,
"processing_order": "asc",
"rehydration_usage_threshold": 1,
"rehydration_deleted_files_threshold": 1,
"learning_type": "text",
"learning_threshold": 1,
"tape_to_scratch": true,
"eject_tape_after": true,
"set_tape_readonly": true,
"set_task_notification": true,
"tape_duplication_action": 1,
"barcodes": [
"text"
],
"overwrite": true,
"soft_erase": true,
"speedtest_iterations": 1,
"speedtest_size": 1,
"ignore_common_path": true,
"recursive": true,
"remove_root_folder": true,
"task_template": 1,
"context_uid": "1000",
"context_gid": "1001",
"working_dir": "text",
"ignore_hidden": true,
"parallel": 1,
"storage_class": "text",
"restoration_expiry_days": 1,
"retrieval_options_glacier": "Standard",
"object_lock_mode": "NONE",
"object_lock_retention_period": 365,
"object_lock_legal_hold_status": false,
"inherit_object_lock_from_source": false
},
"updated_at": "2025-11-05T15:54:48.159Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": {
"id": "1542797273225418555",
"progress": 1,
"finished_at": "2018-11-21T10:48:08.000Z",
"size_todo": 16515610,
"size_done": 12115125,
"nodes_todo": 126,
"nodes_done": 113,
"bandwidth": 1,
"dispatcher": "text",
"movers": [
"text"
],
"task": "[Circular Reference]"
}
}
}
}
}
}API Key Scope: tasks / destroy
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
204
Task destroyed.
No content
delete
/tasks/{task_id}DELETE /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204
Task destroyed.
No content
API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Body
Other propertiesanyOptional
Responses
200
Confirmation of task run.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/runPUT /api/v2/tasks/{task_id}/action/run HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"execution_id": "text",
"msg": "text"
}API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Body
Other propertiesanyOptional
Responses
200
Confirmation of task defer run.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/defer_runPUT /api/v2/tasks/{task_id}/action/defer_run HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"defer_id": "text",
"msg": "text"
}API Key Scope: tasks / run_defer
Query parameters
defer_idstringOptional
Defer id to run a task.
Responses
200
Confirmation of task run.
application/json
default
Error returned from the data management.
application/json
put
/tasks/-/action/run_deferPUT /api/v2/tasks/-/action/run_defer HTTP/1.1
Host: localhost
Accept: */*
{
"execution_id": "text",
"msg": "text"
}API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/pausePUT /api/v2/tasks/{task_id}/action/pause HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/stopPUT /api/v2/tasks/{task_id}/action/stop HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/force_stopPUT /api/v2/tasks/{task_id}/action/force_stop HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: tasks / action
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/tasks/{task_id}/action/resumePUT /api/v2/tasks/{task_id}/action/resume HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}Last updated
Was this helpful?