Tasks
API Key Scope: tasks / index
The number of items to display for pagination.
The number of items to skip for pagination.
Sort results by attribute.
Can sort on multiple attributes, separated by |.
Order direction can be suffixing the attribute by either :asc (default) or :desc.
For admin only, display also resources by other users.
Filter on id
Filter on name
Filter on comment
Filter on task workflow type
Filter on task workflow action
Filter on task source type
Filter on task destination type
Filter on priority
Filter on conflict resolution
Filter on action
Filter on activate
Filter on creation date
Filter on creation username
Filter on modification date
Filter on modification username
Filter on job started
Filter on job finished
Filter on status
Filter on processed size
Filter on to process size
Filter on task source pool id
Filter on task source pool name
Filter on task source tape id
Filter on task source tape barcode
Filter on task destination pool id
Filter on task destination pool name
Filter on task destination tape id
Filter on task destination tape barcode
List of tasks.
GET /api/v2/tasks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
List of tasks.
{
"count": 1,
"tasks": [
{
"id": 1,
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"action": "noop",
"activate": 1,
"creation_date": "2025-11-05T15:41:44.753Z",
"modification_date": "2025-11-05T15:41:44.753Z",
"creation_username": "text",
"modification_username": "text",
"status": "not_activated",
"progress": 1,
"job_started": "2025-11-05T15:41:44.753Z",
"job_finished": "2025-11-05T15:41:44.753Z",
"processed_size": 1,
"to_process_size": 1
}
]
}API Key Scope: tasks / create
A specific task.
The received resource was not correctly formatted.
POST /api/v2/tasks HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"activate": 1,
"progress": 1
}{
"id": 1,
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"action": "noop",
"activate": 1,
"creation_date": "2025-11-05T15:41:44.753Z",
"modification_date": "2025-11-05T15:41:44.753Z",
"creation_username": "text",
"modification_username": "text",
"status": "not_activated",
"progress": 1,
"job_started": "2025-11-05T15:41:44.753Z",
"job_finished": "2025-11-05T15:41:44.753Z",
"processed_size": 1,
"to_process_size": 1
}API Key Scope: tasks / show
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
A specific task.
GET /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
A specific task.
{
"id": 1,
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"action": "noop",
"activate": 1,
"creation_date": "2025-11-05T15:41:44.753Z",
"modification_date": "2025-11-05T15:41:44.753Z",
"creation_username": "text",
"modification_username": "text",
"status": "not_activated",
"progress": 1,
"job_started": "2025-11-05T15:41:44.753Z",
"job_finished": "2025-11-05T15:41:44.753Z",
"processed_size": 1,
"to_process_size": 1
}API Key Scope: tasks / update
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
A specific task.
The received resource was not correctly formatted.
PUT /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 217
{
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"activate": 1,
"progress": 1
}{
"id": 1,
"name": "text",
"comment": "text",
"workflow_type": "active_archive",
"workflow_action": "copy",
"source_type": "container",
"destination_type": "container",
"priority": 1,
"conflict_resolution": "rename",
"action": "noop",
"activate": 1,
"creation_date": "2025-11-05T15:41:44.753Z",
"modification_date": "2025-11-05T15:41:44.753Z",
"creation_username": "text",
"modification_username": "text",
"status": "not_activated",
"progress": 1,
"job_started": "2025-11-05T15:41:44.753Z",
"job_finished": "2025-11-05T15:41:44.753Z",
"processed_size": 1,
"to_process_size": 1
}API Key Scope: tasks / destroy
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
Task destroyed.
No content
DELETE /api/v2/tasks/{task_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
Task destroyed.
No content
API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/tasks/{task_id}/action/run?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
An active job that may be queued, working, completed or failed.
PUT /api/v2/tasks/{task_id}/action/run HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/tasks/{task_id}/action/pause?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
An active job that may be queued, working, completed or failed.
PUT /api/v2/tasks/{task_id}/action/pause HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/tasks/{task_id}/action/stop?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
An active job that may be queued, working, completed or failed.
PUT /api/v2/tasks/{task_id}/action/stop HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
ID of active job
An active job that may be queued, working, completed or failed.
An active job that may be queued, working, completed or failed.
GET /api/v2/tasks/{task_id}/action/resume?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}API Key Scope: tasks / action
Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
An active job that may be queued, working, completed or failed.
PUT /api/v2/tasks/{task_id}/action/resume HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
An active job that may be queued, working, completed or failed.
{
"job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
"status": "queued"
}Last updated
Was this helpful?