# Tasks

## Lists all tasks.

> \*\*API Key Scope\*\*: tasks / 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":{"tasks_index":{"description":"List of tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_collection"}}}}},"schemas":{"task_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"tasks":{"type":"array","readOnly":true,"items":{"$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"}}}},"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"}}}},"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"}}},"all":{"name":"all","in":"query","description":"For admin only, display also resources by other users.","schema":{"type":"boolean"}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_name":{"name":"name","in":"query","description":"Filter on name","schema":{"type":"string"}},"filter_workflow_type":{"name":"workflow_type","in":"query","description":"Filter on task workflow type","schema":{"type":"string"}},"filter_workflow_action":{"name":"workflow_action","in":"query","description":"Filter on task workflow action","schema":{"type":"string"}},"filter_sources_type":{"name":"sources.type","in":"query","description":"Filter on task sources type","schema":{"type":"string"}},"filter_destinations_type":{"name":"destinations.type","in":"query","description":"Filter on task destinations type","schema":{"type":"string"}},"filter_created_at":{"name":"created_at","in":"query","description":"Filter on creation date","schema":{"type":"string"}},"filter_updated_at":{"name":"updated_at","in":"query","description":"Filter on modification date","schema":{"type":"string"}}}},"paths":{"/tasks":{"get":{"summary":"Lists all tasks.","tags":["tasks"],"operationId":"index_tasks","description":"**API Key Scope**: tasks / index","responses":{"200":{"$ref":"#/components/responses/tasks_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_name"},{"$ref":"#/components/parameters/filter_workflow_type"},{"$ref":"#/components/parameters/filter_workflow_action"},{"$ref":"#/components/parameters/filter_sources_type"},{"$ref":"#/components/parameters/filter_destinations_type"},{"$ref":"#/components/parameters/filter_created_at"},{"$ref":"#/components/parameters/filter_updated_at"}]}}}}
```

## Creates a new task.

> \*\*API Key Scope\*\*: tasks / create<br>

```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_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"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"}}}},"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"}}},"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"}}},"requestBodies":{"task_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}},"required":true}}},"paths":{"/tasks":{"post":{"summary":"Creates a new task.","operationId":"create_task","description":"**API Key Scope**: tasks / create\n","tags":["tasks"],"responses":{"201":{"$ref":"#/components/responses/tasks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_body"}}}}}
```

## Displays a specific task.

> \*\*API Key Scope\*\*: tasks / 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":[{"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_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}},"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":{"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"}}}},"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"}}},"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"}}}},"paths":{"/tasks/{task_id}":{"get":{"summary":"Displays a specific task.","operationId":"show_task","description":"**API Key Scope**: tasks / show","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## Updates a specific task.

> \*\*API Key Scope\*\*: tasks / update

```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_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"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"}}}},"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"}}},"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"}}},"requestBodies":{"task_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}},"required":true}}},"paths":{"/tasks/{task_id}":{"put":{"summary":"Updates a specific task.","operationId":"update_task","description":"**API Key Scope**: tasks / update","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_body"}}}}}
```

## Destroys a specific task.

> \*\*API Key Scope\*\*: tasks / destroy

```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"}}},"paths":{"/tasks/{task_id}":{"delete":{"summary":"Destroys a specific task.","operationId":"destroy_task","description":"**API Key Scope**: tasks / destroy","tags":["tasks"],"responses":{"204":{"description":"Task destroyed."}}}}}}
```

## Run a task.

> \*\*API Key Scope\*\*: tasks / 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_run":{"description":"Confirmation of task run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_run_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_run_confirm":{"properties":{"execution_id":{"type":"string","readOnly":true},"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}}}},"requestBodies":{"task_trigger_metadata":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":false}}},"paths":{"/tasks/{task_id}/action/run":{"put":{"summary":"Run a task.","operationId":"run_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_run"},"default":{"$ref":"#/components/responses/data_management_error"}},"requestBody":{"$ref":"#/components/requestBodies/task_trigger_metadata"}}}}}
```

## Defer the running a task.

> \*\*API Key Scope\*\*: tasks / 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_defer_run":{"description":"Confirmation of task defer run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_defer_run_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_defer_run_confirm":{"properties":{"defer_id":{"type":"string","readOnly":true},"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}}}},"requestBodies":{"task_trigger_metadata":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}},"required":false}}},"paths":{"/tasks/{task_id}/action/defer_run":{"put":{"summary":"Defer the running a task.","operationId":"defer_run_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_defer_run"},"default":{"$ref":"#/components/responses/data_management_error"}},"requestBody":{"$ref":"#/components/requestBodies/task_trigger_metadata"}}}}}
```

## Run a defer task.

> \*\*API Key Scope\*\*: tasks / run\_defer

```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":{"/tasks/-/action/run_defer":{"put":{"summary":"Run a defer task.","operationId":"run_defer_task","description":"**API Key Scope**: tasks / run_defer","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_run"},"default":{"$ref":"#/components/responses/data_management_error"}},"parameters":[{"$ref":"#/components/parameters/task_defer_id"}]}}},"components":{"responses":{"tasks_run":{"description":"Confirmation of task run.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_run_confirm"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_run_confirm":{"properties":{"execution_id":{"type":"string","readOnly":true},"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}}}},"parameters":{"task_defer_id":{"name":"defer_id","in":"query","description":"Defer id to run a task.","schema":{"type":"string"}}}}}
```

## Pause a task.

> \*\*API Key Scope\*\*: tasks / 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":{"/tasks/{task_id}/action/pause":{"put":{"summary":"Pause a task.","operationId":"pause_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Stop a task.

> \*\*API Key Scope\*\*: tasks / 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":{"/tasks/{task_id}/action/stop":{"put":{"summary":"Stop a task.","operationId":"stop_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Force stop a task.

> \*\*API Key Scope\*\*: tasks / 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":{"/tasks/{task_id}/action/force_stop":{"put":{"summary":"Force stop a task.","operationId":"force_stop_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## Resume a task.

> \*\*API Key Scope\*\*: tasks / 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":{"/tasks/{task_id}/action/resume":{"put":{"summary":"Resume a task.","operationId":"resume_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_action"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```