Task_destinations

Lists all task destinations.

get

API Key Scope: task_destinations / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric 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.

idstringOptional

Filter on id

folder_idstringOptional

Filter on folder id

tape_idstringOptional

Filter on tape id

pool_idstringOptional

Filter on a pool id

Responses

200

List of task destinations.

application/json

get

/tasks/{task_id}/task_destinations

HTTPcURLJavaScriptPython

GET /api/v2/tasks/{task_id}/task_destinations HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of task destinations.

{
  "count": 1,
  "task_destinations": [
    {
      "folder_id": 1,
      "folder_path": "text",
      "tape_id": 1,
      "tape_barcode": "text",
      "pool_id": 1,
      "pool_name": "text",
      "id": 1,
      "folder": {
        "id": 105,
        "name": "my-file.txt",
        "parent": 100,
        "primary_id": 100,
        "type": "file",
        "permission": 100666,
        "size": 1063457,
        "change_date": "2018-12-10T08:33:47.000Z",
        "modification_date": "2018-12-10T15:29:23.000Z",
        "access_date": "2018-12-10T15:27:51.000Z",
        "uid": 1000,
        "gid": 1000,
        "in_cache": "in_cache",
        "offline": "online",
        "extern": 1,
        "checksums": [
          "text"
        ],
        "tapes": [
          "text"
        ],
        "cloud_buckets": [
          "text"
        ],
        "nas_shares": [
          "text"
        ],
        "file_path": "/my-container/my-file.txt"
      },
      "container": {
        "id": 100,
        "name": "my-container",
        "comment": "Read only container for random stuff",
        "push_pool_id": 1,
        "cleaning_pool_id": 1,
        "quota_total_size": 1,
        "quota_on_cache": 1,
        "stat_total_files": 99301,
        "only_on_cache_file_count": 19123,
        "stat_total_size": 6145076462,
        "stat_size_on_cache": 6899417088,
        "only_on_cache_file_size_sum": 3294517012,
        "guest_right": "read",
        "last_update": "2019-08-05T14:24:15.000Z"
      },
      "tape": {
        "id": 10,
        "tape_library_id": 2,
        "pool_id": 6,
        "barcode": "NOD407L5",
        "location": "Slot 2",
        "type": "data_lto5",
        "locked": 1,
        "scratch": 1,
        "cleaning": 1,
        "write_protect": [
          "logical_locked"
        ],
        "mounted": 1,
        "ejected": 1,
        "known": 1,
        "mount_count": 1,
        "date_in": "2025-12-21T13:55:14.661Z",
        "date_move": "2025-12-21T13:55:14.661Z",
        "free": 1,
        "max": 1,
        "last_size_update": "2025-12-21T13:55:14.661Z",
        "last_maintenance": "2025-12-21T13:55:14.661Z",
        "last_repack": "2025-12-21T13:55:14.661Z",
        "repack_status": 1,
        "force_import_type": 1,
        "need_to_check": 1
      },
      "pool": {
        "id": 6,
        "name": "offline-tapes",
        "comment": "",
        "type": "offline_archive",
        "content": "tape",
        "primary_id": 100,
        "storage_id": 2,
        "tape_write_protect_when_full": true,
        "storage_extra_data": {
          "id": 1,
          "storage_id": 123,
          "storage_type": 1,
          "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
        }
      }
    }
  ]
}

Creates a new task destination.

post

API Key Scope: task_destinations / create

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Body

application/json

folder_idinteger · int64Optional

folder_pathstringOptional

tape_idinteger · int64Optional

tape_barcodestringOptional

pool_idintegerOptional

pool_namestringOptional

Responses

201

A specific task destination.

application/json

422

The received resource was not correctly formatted.

application/json

post

/tasks/{task_id}/task_destinations

HTTPcURLJavaScriptPython

POST /api/v2/tasks/{task_id}/task_destinations HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "folder_id": 1,
  "folder_path": "text",
  "tape_id": 1,
  "tape_barcode": "text",
  "pool_id": 1,
  "pool_name": "text"
}

{
  "folder_id": 1,
  "folder_path": "text",
  "tape_id": 1,
  "tape_barcode": "text",
  "pool_id": 1,
  "pool_name": "text",
  "id": 1,
  "folder": {
    "id": 105,
    "name": "my-file.txt",
    "parent": 100,
    "primary_id": 100,
    "type": "file",
    "permission": 100666,
    "size": 1063457,
    "change_date": "2018-12-10T08:33:47.000Z",
    "modification_date": "2018-12-10T15:29:23.000Z",
    "access_date": "2018-12-10T15:27:51.000Z",
    "uid": 1000,
    "gid": 1000,
    "in_cache": "in_cache",
    "offline": "online",
    "extern": 1,
    "checksums": [
      "text"
    ],
    "tapes": [
      "text"
    ],
    "cloud_buckets": [
      "text"
    ],
    "nas_shares": [
      "text"
    ],
    "file_path": "/my-container/my-file.txt"
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  },
  "tape": {
    "id": 10,
    "tape_library_id": 2,
    "pool_id": 6,
    "barcode": "NOD407L5",
    "location": "Slot 2",
    "type": "data_lto5",
    "locked": 1,
    "scratch": 1,
    "cleaning": 1,
    "write_protect": [
      "logical_locked"
    ],
    "mounted": 1,
    "ejected": 1,
    "known": 1,
    "mount_count": 1,
    "date_in": "2025-12-21T13:55:14.661Z",
    "date_move": "2025-12-21T13:55:14.661Z",
    "free": 1,
    "max": 1,
    "last_size_update": "2025-12-21T13:55:14.661Z",
    "last_maintenance": "2025-12-21T13:55:14.661Z",
    "last_repack": "2025-12-21T13:55:14.661Z",
    "repack_status": 1,
    "force_import_type": 1,
    "need_to_check": 1
  },
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "primary_id": 100,
    "storage_id": 2,
    "tape_write_protect_when_full": true,
    "storage_extra_data": {
      "id": 1,
      "storage_id": 123,
      "storage_type": 1,
      "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
    }
  }
}

Displays a specific task destination.

get

API Key Scope: task_destinations / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_destination_idintegerRequired

Numeric ID of task destination.

Responses

200

A specific task destination.

application/json

get

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

GET /api/v2/tasks/{task_id}/task_destinations/{task_destination_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific task destination.

{
  "folder_id": 1,
  "folder_path": "text",
  "tape_id": 1,
  "tape_barcode": "text",
  "pool_id": 1,
  "pool_name": "text",
  "id": 1,
  "folder": {
    "id": 105,
    "name": "my-file.txt",
    "parent": 100,
    "primary_id": 100,
    "type": "file",
    "permission": 100666,
    "size": 1063457,
    "change_date": "2018-12-10T08:33:47.000Z",
    "modification_date": "2018-12-10T15:29:23.000Z",
    "access_date": "2018-12-10T15:27:51.000Z",
    "uid": 1000,
    "gid": 1000,
    "in_cache": "in_cache",
    "offline": "online",
    "extern": 1,
    "checksums": [
      "text"
    ],
    "tapes": [
      "text"
    ],
    "cloud_buckets": [
      "text"
    ],
    "nas_shares": [
      "text"
    ],
    "file_path": "/my-container/my-file.txt"
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  },
  "tape": {
    "id": 10,
    "tape_library_id": 2,
    "pool_id": 6,
    "barcode": "NOD407L5",
    "location": "Slot 2",
    "type": "data_lto5",
    "locked": 1,
    "scratch": 1,
    "cleaning": 1,
    "write_protect": [
      "logical_locked"
    ],
    "mounted": 1,
    "ejected": 1,
    "known": 1,
    "mount_count": 1,
    "date_in": "2025-12-21T13:55:14.661Z",
    "date_move": "2025-12-21T13:55:14.661Z",
    "free": 1,
    "max": 1,
    "last_size_update": "2025-12-21T13:55:14.661Z",
    "last_maintenance": "2025-12-21T13:55:14.661Z",
    "last_repack": "2025-12-21T13:55:14.661Z",
    "repack_status": 1,
    "force_import_type": 1,
    "need_to_check": 1
  },
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "primary_id": 100,
    "storage_id": 2,
    "tape_write_protect_when_full": true,
    "storage_extra_data": {
      "id": 1,
      "storage_id": 123,
      "storage_type": 1,
      "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
    }
  }
}

Updates a specific task destination.

put

API Key Scope: task_destinations / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_destination_idintegerRequired

Numeric ID of task destination.

Body

application/json

folder_idinteger · int64Optional

folder_pathstringOptional

tape_idinteger · int64Optional

tape_barcodestringOptional

pool_idintegerOptional

pool_namestringOptional

Responses

200

A specific task destination.

application/json

422

The received resource was not correctly formatted.

application/json

put

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

PUT /api/v2/tasks/{task_id}/task_destinations/{task_destination_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "folder_id": 1,
  "folder_path": "text",
  "tape_id": 1,
  "tape_barcode": "text",
  "pool_id": 1,
  "pool_name": "text"
}

{
  "folder_id": 1,
  "folder_path": "text",
  "tape_id": 1,
  "tape_barcode": "text",
  "pool_id": 1,
  "pool_name": "text",
  "id": 1,
  "folder": {
    "id": 105,
    "name": "my-file.txt",
    "parent": 100,
    "primary_id": 100,
    "type": "file",
    "permission": 100666,
    "size": 1063457,
    "change_date": "2018-12-10T08:33:47.000Z",
    "modification_date": "2018-12-10T15:29:23.000Z",
    "access_date": "2018-12-10T15:27:51.000Z",
    "uid": 1000,
    "gid": 1000,
    "in_cache": "in_cache",
    "offline": "online",
    "extern": 1,
    "checksums": [
      "text"
    ],
    "tapes": [
      "text"
    ],
    "cloud_buckets": [
      "text"
    ],
    "nas_shares": [
      "text"
    ],
    "file_path": "/my-container/my-file.txt"
  },
  "container": {
    "id": 100,
    "name": "my-container",
    "comment": "Read only container for random stuff",
    "push_pool_id": 1,
    "cleaning_pool_id": 1,
    "quota_total_size": 1,
    "quota_on_cache": 1,
    "stat_total_files": 99301,
    "only_on_cache_file_count": 19123,
    "stat_total_size": 6145076462,
    "stat_size_on_cache": 6899417088,
    "only_on_cache_file_size_sum": 3294517012,
    "guest_right": "read",
    "last_update": "2019-08-05T14:24:15.000Z"
  },
  "tape": {
    "id": 10,
    "tape_library_id": 2,
    "pool_id": 6,
    "barcode": "NOD407L5",
    "location": "Slot 2",
    "type": "data_lto5",
    "locked": 1,
    "scratch": 1,
    "cleaning": 1,
    "write_protect": [
      "logical_locked"
    ],
    "mounted": 1,
    "ejected": 1,
    "known": 1,
    "mount_count": 1,
    "date_in": "2025-12-21T13:55:14.661Z",
    "date_move": "2025-12-21T13:55:14.661Z",
    "free": 1,
    "max": 1,
    "last_size_update": "2025-12-21T13:55:14.661Z",
    "last_maintenance": "2025-12-21T13:55:14.661Z",
    "last_repack": "2025-12-21T13:55:14.661Z",
    "repack_status": 1,
    "force_import_type": 1,
    "need_to_check": 1
  },
  "pool": {
    "id": 6,
    "name": "offline-tapes",
    "comment": "",
    "type": "offline_archive",
    "content": "tape",
    "primary_id": 100,
    "storage_id": 2,
    "tape_write_protect_when_full": true,
    "storage_extra_data": {
      "id": 1,
      "storage_id": 123,
      "storage_type": 1,
      "data": "{\"alto_api\": {\"username\" : \"aaaa\", \"password\" : \"password\", \"shelf\" : \"shelf66\" }}"
    }
  }
}

Destroys a specific task destination.

delete

API Key Scope: task_destinations / destroy

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Path parameters

task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

task_destination_idintegerRequired

Numeric ID of task destination.

Responses

204

Task destination destroyed.

delete

/tasks/{task_id}/task_destinations/{task_destination_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/tasks/{task_id}/task_destinations/{task_destination_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

204

Task destination destroyed.

No content