# Task\_executions

## (By task) Lists all task executions.

> \*\*API Key Scope\*\*: task\_executions / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_executions_index":{"description":"List of task executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_execution_collection"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"task_execution_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_executions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_execution"}}}},"task_execution":{"type":"object","properties":{"id":{"type":"string"},"progress":{"type":"integer"},"finished_at":{"type":"string","format":"date-time"},"size_todo":{"type":"integer","format":"int64"},"size_done":{"type":"integer","format":"int64"},"nodes_todo":{"type":"integer","format":"int64"},"nodes_done":{"type":"integer","format":"int64"},"bandwidth":{"type":"number"},"dispatcher":{"type":"string"},"movers":{"type":"array","items":{"type":"string"}},"task":{"$ref":"#/components/schemas/task"}}},"task":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"options":{"$ref":"#/components/schemas/task_options"},"updated_at":{"type":"string","readOnly":true,"format":"date-time"},"user":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"updated_by":{"type":"string","readOnly":true},"metadata":{"$ref":"#/components/schemas/task_metadata"},"last_execution":{"$ref":"#/components/schemas/task_execution"}}},"task_options":{"properties":{"priority":{"type":"number"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"file_checksum":{"type":"string","enum":["crc32","md5","xxhash64"]},"reset_file_date":{"type":"boolean"},"reset_folder_date":{"type":"boolean"},"execution_task_id":{"type":"string"},"selected_drive":{"type":"string"},"selected_drive_2":{"type":"string"},"task_id":{"type":"string"},"full_report":{"type":"boolean"},"backup_report":{"type":"number"},"processing_order":{"type":"string","enum":["asc","dsc"]},"rehydration_usage_threshold":{"type":"number"},"rehydration_deleted_files_threshold":{"type":"number"},"learning_type":{"type":"string"},"learning_threshold":{"type":"number"},"barcodes":{"type":"array","items":{"type":"string"}},"overwrite":{"type":"boolean"},"soft_erase":{"type":"boolean"},"speedtest_iterations":{"type":"number"},"speedtest_size":{"type":"number"},"ignore_common_path":{"type":"boolean"},"recursive":{"type":"boolean"},"remove_root_folder":{"type":"boolean"},"task_template":{"type":"number"},"context_uid":{"type":"string"},"context_gid":{"type":"string"},"working_dir":{"type":"string"},"ignore_hidden":{"type":"boolean"},"parallel":{"type":"number"},"storage_class":{"type":"string"},"restoration_expiry_days":{"type":"number"},"retrieval_options_glacier":{"type":"string","enum":["Standard","Bulk","Expedited"]},"object_lock_mode":{"type":"string","enum":["NONE","GOVERNANCE","COMPLIANCE"]},"object_lock_retention_period":{"type":"number"},"object_lock_legal_hold_status":{"type":"boolean","default":false},"inherit_object_lock_from_source":{"type":"boolean","default":false},"keep_file_ownership":{"type":"boolean","default":false}}},"task_metadata":{"type":"object","properties":{"task":{"type":"object","additionalProperties":{}},"files":{"type":"object","additionalProperties":{"type":"string"}}}},"model_error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"sort_by":{"name":"sort_by","in":"query","description":"Sort results by attribute.\n\nCan sort on multiple attributes, separated by `|`.\nOrder direction can be suffixing the attribute by either `:asc` (default) or `:desc`.","style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},"filter_progress":{"name":"progress","in":"query","description":"Filter on task progress","schema":{"type":"string"}}}},"paths":{"/tasks/{task_id}/task_executions":{"get":{"summary":"(By task) Lists all task executions.","operationId":"index_task_executions_by_task","description":"**API Key Scope**: task_executions / index","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/task_executions_index"},"404":{"$ref":"#/components/responses/not_found"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/filter_progress"}]}}}}
```

## Lists all task executions.

> \*\*API Key Scope\*\*: task\_executions / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_executions_index":{"description":"List of task executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_execution_collection"}}}}},"schemas":{"task_execution_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_executions":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_execution"}}}},"task_execution":{"type":"object","properties":{"id":{"type":"string"},"progress":{"type":"integer"},"finished_at":{"type":"string","format":"date-time"},"size_todo":{"type":"integer","format":"int64"},"size_done":{"type":"integer","format":"int64"},"nodes_todo":{"type":"integer","format":"int64"},"nodes_done":{"type":"integer","format":"int64"},"bandwidth":{"type":"number"},"dispatcher":{"type":"string"},"movers":{"type":"array","items":{"type":"string"}},"task":{"$ref":"#/components/schemas/task"}}},"task":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"options":{"$ref":"#/components/schemas/task_options"},"updated_at":{"type":"string","readOnly":true,"format":"date-time"},"user":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"updated_by":{"type":"string","readOnly":true},"metadata":{"$ref":"#/components/schemas/task_metadata"},"last_execution":{"$ref":"#/components/schemas/task_execution"}}},"task_options":{"properties":{"priority":{"type":"number"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"file_checksum":{"type":"string","enum":["crc32","md5","xxhash64"]},"reset_file_date":{"type":"boolean"},"reset_folder_date":{"type":"boolean"},"execution_task_id":{"type":"string"},"selected_drive":{"type":"string"},"selected_drive_2":{"type":"string"},"task_id":{"type":"string"},"full_report":{"type":"boolean"},"backup_report":{"type":"number"},"processing_order":{"type":"string","enum":["asc","dsc"]},"rehydration_usage_threshold":{"type":"number"},"rehydration_deleted_files_threshold":{"type":"number"},"learning_type":{"type":"string"},"learning_threshold":{"type":"number"},"barcodes":{"type":"array","items":{"type":"string"}},"overwrite":{"type":"boolean"},"soft_erase":{"type":"boolean"},"speedtest_iterations":{"type":"number"},"speedtest_size":{"type":"number"},"ignore_common_path":{"type":"boolean"},"recursive":{"type":"boolean"},"remove_root_folder":{"type":"boolean"},"task_template":{"type":"number"},"context_uid":{"type":"string"},"context_gid":{"type":"string"},"working_dir":{"type":"string"},"ignore_hidden":{"type":"boolean"},"parallel":{"type":"number"},"storage_class":{"type":"string"},"restoration_expiry_days":{"type":"number"},"retrieval_options_glacier":{"type":"string","enum":["Standard","Bulk","Expedited"]},"object_lock_mode":{"type":"string","enum":["NONE","GOVERNANCE","COMPLIANCE"]},"object_lock_retention_period":{"type":"number"},"object_lock_legal_hold_status":{"type":"boolean","default":false},"inherit_object_lock_from_source":{"type":"boolean","default":false},"keep_file_ownership":{"type":"boolean","default":false}}},"task_metadata":{"type":"object","properties":{"task":{"type":"object","additionalProperties":{}},"files":{"type":"object","additionalProperties":{"type":"string"}}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"sort_by":{"name":"sort_by","in":"query","description":"Sort results by attribute.\n\nCan sort on multiple attributes, separated by `|`.\nOrder direction can be suffixing the attribute by either `:asc` (default) or `:desc`.","style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},"filter_progress":{"name":"progress","in":"query","description":"Filter on task progress","schema":{"type":"string"}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_task_name":{"name":"task.name","in":"query","description":"Filter on name of an execution","schema":{"type":"string"}},"filter_task_workflow_type":{"name":"task.workflow_type","in":"query","description":"Filter on task workflow type for an execution","schema":{"type":"string"}},"filter_task_workflow_action":{"name":"task.workflow_action","in":"query","description":"Filter on task workflow action of an execution","schema":{"type":"string"}},"filter_task_sources_type":{"name":"task.sources.type","in":"query","description":"Filter on task sources type of an executions","schema":{"type":"string"}},"filter_task_destinations_type":{"name":"task.destinations.type","in":"query","description":"Filter on task destinations type of an executions","schema":{"type":"string"}},"filter_created_at":{"name":"created_at","in":"query","description":"Filter on creation date","schema":{"type":"string"}},"filter_finished_at":{"name":"finished_at","in":"query","description":"Filter on execution date","schema":{"type":"string"}}}},"paths":{"/task_executions":{"get":{"summary":"Lists all task executions.","tags":["task_executions"],"operationId":"index_task_executions","description":"**API Key Scope**: task_executions / index","responses":{"200":{"$ref":"#/components/responses/task_executions_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/filter_progress"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_task_name"},{"$ref":"#/components/parameters/filter_task_workflow_type"},{"$ref":"#/components/parameters/filter_task_workflow_action"},{"$ref":"#/components/parameters/filter_task_sources_type"},{"$ref":"#/components/parameters/filter_task_destinations_type"},{"$ref":"#/components/parameters/filter_created_at"},{"$ref":"#/components/parameters/filter_finished_at"}]}}}}
```

## Displays a specific task execution.

> \*\*API Key Scope\*\*: task\_executions / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[],"paths":{"/task_executions/{task_execution_id}":{"get":{"summary":"Displays a specific task execution.","operationId":"show_task_execution","description":"**API Key Scope**: task_executions / show","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/task_executions_show"},"404":{"$ref":"#/components/responses/not_found"}}}}},"components":{"responses":{"task_executions_show":{"description":"A specific task execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_execution"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"task_execution":{"type":"object","properties":{"id":{"type":"string"},"progress":{"type":"integer"},"finished_at":{"type":"string","format":"date-time"},"size_todo":{"type":"integer","format":"int64"},"size_done":{"type":"integer","format":"int64"},"nodes_todo":{"type":"integer","format":"int64"},"nodes_done":{"type":"integer","format":"int64"},"bandwidth":{"type":"number"},"dispatcher":{"type":"string"},"movers":{"type":"array","items":{"type":"string"}},"task":{"$ref":"#/components/schemas/task"}}},"task":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"options":{"$ref":"#/components/schemas/task_options"},"updated_at":{"type":"string","readOnly":true,"format":"date-time"},"user":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"updated_by":{"type":"string","readOnly":true},"metadata":{"$ref":"#/components/schemas/task_metadata"},"last_execution":{"$ref":"#/components/schemas/task_execution"}}},"task_options":{"properties":{"priority":{"type":"number"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"file_checksum":{"type":"string","enum":["crc32","md5","xxhash64"]},"reset_file_date":{"type":"boolean"},"reset_folder_date":{"type":"boolean"},"execution_task_id":{"type":"string"},"selected_drive":{"type":"string"},"selected_drive_2":{"type":"string"},"task_id":{"type":"string"},"full_report":{"type":"boolean"},"backup_report":{"type":"number"},"processing_order":{"type":"string","enum":["asc","dsc"]},"rehydration_usage_threshold":{"type":"number"},"rehydration_deleted_files_threshold":{"type":"number"},"learning_type":{"type":"string"},"learning_threshold":{"type":"number"},"barcodes":{"type":"array","items":{"type":"string"}},"overwrite":{"type":"boolean"},"soft_erase":{"type":"boolean"},"speedtest_iterations":{"type":"number"},"speedtest_size":{"type":"number"},"ignore_common_path":{"type":"boolean"},"recursive":{"type":"boolean"},"remove_root_folder":{"type":"boolean"},"task_template":{"type":"number"},"context_uid":{"type":"string"},"context_gid":{"type":"string"},"working_dir":{"type":"string"},"ignore_hidden":{"type":"boolean"},"parallel":{"type":"number"},"storage_class":{"type":"string"},"restoration_expiry_days":{"type":"number"},"retrieval_options_glacier":{"type":"string","enum":["Standard","Bulk","Expedited"]},"object_lock_mode":{"type":"string","enum":["NONE","GOVERNANCE","COMPLIANCE"]},"object_lock_retention_period":{"type":"number"},"object_lock_legal_hold_status":{"type":"boolean","default":false},"inherit_object_lock_from_source":{"type":"boolean","default":false},"keep_file_ownership":{"type":"boolean","default":false}}},"task_metadata":{"type":"object","properties":{"task":{"type":"object","additionalProperties":{}},"files":{"type":"object","additionalProperties":{"type":"string"}}}},"model_error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}}}}
```

## Lists nodes processed

> \*\*API Key Scope\*\*: task\_execution / processed\_nodes

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[],"paths":{"/task_executions/{task_execution_id}/processed_nodes":{"get":{"summary":"Lists nodes processed","operationId":"index_processed_nodes_by_task_execution","description":"**API Key Scope**: task_execution / processed_nodes","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/task_nodes_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/filter_status"},{"$ref":"#/components/parameters/filter_path"}]}}},"components":{"responses":{"task_nodes_index":{"description":"List of processed nodes by task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_nodes_collection"}}}}},"schemas":{"task_nodes_collection":{"properties":{"count":{"type":"integer","readOnly":true},"task_nodes":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_node"}}}},"task_node":{"properties":{"id":{"type":"string"},"source_path":{"type":"string"},"destination_path":{"type":"string"},"status":{"type":"string","enum":["pending","filtered","progress","finalizing","copied","moved","removed","unknown","not-exist","not-dir","permission","exist","not-empty","timeout"]},"error":{"type":"string"},"warning":{"type":"string","description":"Warning message for operations that completed with issues (e.g., permission setting failures)"},"size_done":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"speed":{"type":"number"},"time":{"type":"string","format":"date-time"},"mover_id":{"type":"string"},"dispatcher_id":{"type":"string"},"checksum":{"type":"string","description":"Checksum of the file (MD5, CRC32, or XXHash64)"}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"filter_status":{"name":"status","in":"query","description":"Filter on status","schema":{"type":"string"}},"filter_path":{"name":"path","in":"query","description":"Filter on path","schema":{"type":"string"}}}}}
```

## Lists task logs

> \*\*API Key Scope\*\*: task\_execution / logs

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_logs_index":{"description":"List of logs by task execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_logs_collection"}}}}},"schemas":{"task_logs_collection":{"properties":{"count":{"type":"integer","readOnly":true},"task_logs":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_log"}}}},"task_log":{"allOf":[{"$ref":"#/components/schemas/log"},{"type":"object","properties":{"workflow_id":{"type":"string"},"service_id":{"type":"string"}}}]},"log":{"type":"object","properties":{"id":{"type":"string"},"level":{"type":"string","enum":["trace","debug","info","warn","error","fatal"]},"msg":{"type":"string"},"time":{"type":"string","format":"date-time"},"hostname":{"type":"string"},"tag":{"type":"string","enum":["nodeum.dispatcher","nodeum.mover","nodeum.front","nodeum.monitoring","nodeum.scheduler"]},"error":{"type":"string"},"stacktrace":{"type":"string"}}}},"parameters":{"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"filter_level":{"name":"level","in":"query","description":"Filter on task log level","schema":{"type":"string"}},"filter_workflow_id":{"name":"workflow_id","in":"query","description":"Filter on workflow_id","schema":{"type":"string"}},"filter_time":{"name":"time","in":"query","description":"Filter on time","schema":{"type":"string"}},"filter_msg":{"name":"msg","in":"query","description":"Filter on message","schema":{"type":"string"}},"filter_hostname":{"name":"hostname","in":"query","description":"Filter on task log hostname","schema":{"type":"string"}},"filter_tag":{"name":"tag","in":"query","description":"Filter on task log tag","schema":{"type":"string"}}}},"paths":{"/task_executions/{task_execution_id}/logs":{"get":{"summary":"Lists task logs","operationId":"index_logs_by_task_execution","description":"**API Key Scope**: task_execution / logs","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/task_logs_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/filter_level"},{"$ref":"#/components/parameters/filter_workflow_id"},{"$ref":"#/components/parameters/filter_time"},{"$ref":"#/components/parameters/filter_msg"},{"$ref":"#/components/parameters/filter_hostname"},{"$ref":"#/components/parameters/filter_tag"}]}}}}
```

## Pause a task execution.

> \*\*API Key Scope\*\*: task\_execution / action

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"tasks_action":{"description":"Confirmation of task action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_action_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_action_confirm":{"properties":{"msg":{"type":"string","readOnly":true}}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"paths":{"/task_executions/{task_execution_id}/action/pause":{"put":{"summary":"Pause a task execution.","operationId":"pause_task_execution","description":"**API Key Scope**: task_execution / action","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Stop a task execution.

> \*\*API Key Scope\*\*: task\_execution / action

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"tasks_action":{"description":"Confirmation of task action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_action_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_action_confirm":{"properties":{"msg":{"type":"string","readOnly":true}}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"paths":{"/task_executions/{task_execution_id}/action/stop":{"put":{"summary":"Stop a task execution.","operationId":"stop_task_execution","description":"**API Key Scope**: task_execution / action","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Force stop a task execution.

> \*\*API Key Scope\*\*: task\_execution / action

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"tasks_action":{"description":"Confirmation of task action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_action_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_action_confirm":{"properties":{"msg":{"type":"string","readOnly":true}}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"paths":{"/task_executions/{task_execution_id}/action/force_stop":{"put":{"summary":"Force stop a task execution.","operationId":"force_stop_task_execution","description":"**API Key Scope**: task_execution / action","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Resume a task execution.

> \*\*API Key Scope\*\*: task\_execution / action

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"tasks_action":{"description":"Confirmation of task action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_action_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_action_confirm":{"properties":{"msg":{"type":"string","readOnly":true}}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"paths":{"/task_executions/{task_execution_id}/action/resume":{"put":{"summary":"Resume a task execution.","operationId":"resume_task_execution","description":"**API Key Scope**: task_execution / action","tags":["task_executions"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-mover/api-developers/api-reference-nodeum-data-mover/task_executions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.