Task_executions
API Key Scope: task_executions / index
Authorizations
Path parameters
task_idstringRequired
ID or name of task. Task names are not unique, it's recommended to use ID.
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.
progressstringOptional
Filter on task progress
Responses
200
List of task executions.
application/json
404
The requested resource was not found. The detailed error will be of type not_found.
application/json
get
/tasks/{task_id}/task_executionsGET /api/v2/tasks/{task_id}/task_executions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"count": 1,
"task_executions": [
{
"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:48:04.936Z",
"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:48:04.936Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": "[Circular Reference]"
}
}
}
}
]
}API Key Scope: task_executions / 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.
progressstringOptional
Filter on task progress
idstringOptional
Filter on id
task.namestringOptional
Filter on name of an execution
task.workflow_typestringOptional
Filter on task workflow type for an execution
task.workflow_actionstringOptional
Filter on task workflow action of an execution
task.sources.typestringOptional
Filter on task sources type of an executions
task.destinations.typestringOptional
Filter on task destinations type of an executions
created_atstringOptional
Filter on creation date
finished_atstringOptional
Filter on execution date
Responses
200
List of task executions.
application/json
get
/task_executionsGET /api/v2/task_executions HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200
List of task executions.
{
"count": 1,
"task_executions": [
{
"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:48:04.936Z",
"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:48:04.936Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": "[Circular Reference]"
}
}
}
}
]
}API Key Scope: task_executions / show
Path parameters
task_execution_idstringRequired
ID of task execution.
Responses
200
A specific task execution.
application/json
404
The requested resource was not found. The detailed error will be of type not_found.
application/json
get
/task_executions/{task_execution_id}GET /api/v2/task_executions/{task_execution_id} HTTP/1.1
Host: localhost
Accept: */*
{
"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:48:04.936Z",
"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:48:04.936Z",
"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:48:04.936Z",
"created_by": "text",
"updated_by": "text",
"metadata": {
"task": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"files": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"last_execution": "[Circular Reference]"
}
}
}
}
}
}API Key Scope: task_execution / processed_nodes
Path parameters
task_execution_idstringRequired
ID of task execution.
Query parameters
limitintegerOptional
The number of items to display for pagination.
offsetintegerOptional
The number of items to skip for pagination.
statusstringOptional
Filter on status
pathstringOptional
Filter on path
Responses
200
List of processed nodes by task.
application/json
get
/task_executions/{task_execution_id}/processed_nodesGET /api/v2/task_executions/{task_execution_id}/processed_nodes HTTP/1.1
Host: localhost
Accept: */*
200
List of processed nodes by task.
{
"count": 1,
"task_nodes": []
}API Key Scope: task_execution / logs
Authorizations
Path parameters
task_execution_idstringRequired
ID of task execution.
Query parameters
limitintegerOptional
The number of items to display for pagination.
offsetintegerOptional
The number of items to skip for pagination.
levelstringOptional
Filter on task log level
workflow_idstringOptional
Filter on workflow_id
timestringOptional
Filter on time
msgstringOptional
Filter on message
hostnamestringOptional
Filter on task log hostname
tagstringOptional
Filter on task log tag
Responses
200
List of logs by task execution.
application/json
get
/task_executions/{task_execution_id}/logsGET /api/v2/task_executions/{task_execution_id}/logs HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200
List of logs by task execution.
{
"count": 1,
"task_logs": [
{
"id": "text",
"level": "trace",
"msg": "text",
"time": "2025-11-05T15:48:04.936Z",
"hostname": "text",
"tag": "nodeum.dispatcher",
"error": "text",
"stacktrace": "text",
"workflow_id": "text",
"service_id": "text"
}
]
}API Key Scope: task_execution / action
Authorizations
Path parameters
task_execution_idstringRequired
ID of task execution.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/task_executions/{task_execution_id}/action/pausePUT /api/v2/task_executions/{task_execution_id}/action/pause HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: task_execution / action
Authorizations
Path parameters
task_execution_idstringRequired
ID of task execution.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/task_executions/{task_execution_id}/action/stopPUT /api/v2/task_executions/{task_execution_id}/action/stop HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: task_execution / action
Authorizations
Path parameters
task_execution_idstringRequired
ID of task execution.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/task_executions/{task_execution_id}/action/force_stopPUT /api/v2/task_executions/{task_execution_id}/action/force_stop HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}API Key Scope: task_execution / action
Authorizations
Path parameters
task_execution_idstringRequired
ID of task execution.
Responses
200
Confirmation of task action.
application/json
default
Error returned from the data management.
application/json
put
/task_executions/{task_execution_id}/action/resumePUT /api/v2/task_executions/{task_execution_id}/action/resume HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"msg": "text"
}Last updated
Was this helpful?