Files

Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/files

HTTPcURLJavaScriptPython

GET /api/v2/files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

file_idstringRequired

Numeric ID or path of file.

Responses

200

A specific file.

application/json

Responseall of

get

/files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific file.

{
  "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"
}

Lists files under a specific folder.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

file_parent_idstringRequired

Numeric ID or path of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By container) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

container_idstringRequired

Numeric ID or name of container.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/containers/{container_id}/files

HTTPcURLJavaScriptPython

GET /api/v2/containers/{container_id}/files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By container) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

container_idstringRequired

Numeric ID or name of container.

file_idstringRequired

Numeric ID or path of file.

Responses

200

A specific file.

application/json

Responseall of

get

/containers/{container_id}/files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/containers/{container_id}/files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific file.

{
  "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"
}

(By container) Lists files under a specific folder.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

container_idstringRequired

Numeric ID or name of container.

file_parent_idstringRequired

Numeric ID or path of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/containers/{container_id}/files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/containers/{container_id}/files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By pool) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/pools/{pool_id}/files

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By pool) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

Numeric ID or path of file.

Responses

200

A specific file.

application/json

Responseall of

get

/pools/{pool_id}/files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific file.

{
  "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"
}

(By pool) Displays tapes containing specific file, related to the specific pool.

get

API Key Scope: files / tapes

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of tapes.

application/json

get

/pools/{pool_id}/files/{file_id}/tapes

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of tapes.

{
  "count": 1,
  "tapes": [
    {
      "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-11-05T15:57:33.149Z",
      "date_move": "2025-11-05T15:57:33.149Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:57:33.149Z",
      "last_maintenance": "2025-11-05T15:57:33.149Z",
      "last_repack": "2025-11-05T15:57:33.149Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

(By pool) Displays cloud buckets containing specific file, related to the specific pool.

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of cloud buckets.

application/json

get

/pools/{pool_id}/files/{file_id}/cloud_buckets

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_id}/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of cloud buckets.

{
  "count": 1,
  "cloud_buckets": [
    {
      "id": 1,
      "cloud_connector_id": 1,
      "pool_id": 1,
      "name": "text",
      "file_count": 1,
      "file_size_sum": 1,
      "location": "text",
      "price": "text",
      "options": "text"
    }
  ]
}

(By pool) Displays NAS Shares containing specific file, related to the specific pool.

get

API Key Scope: files / nas_shares

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of NAS shares.

application/json

get

/pools/{pool_id}/files/{file_id}/nas_shares

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_id}/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

(By pool) Calculate total size of files contains in a folder.

get

API Key Scope: files / file_size

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

Numeric ID or path of file.

Responses

200

Sum of the file sizes.

application/json

get

/pools/{pool_id}/files/{file_id}/file_size

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_id}/file_size HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

Sum of the file sizes.

{
  "file_size": 1
}

(By pool) Lists files under a specific folder.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_parent_idstringRequired

Numeric ID or path of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/pools/{pool_id}/files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By pool) Lists files on root of tape of pools, specific for Data Exchange.

get

API Key Scope: import_files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

Responses

200

List of imported files.

application/json

get

/pools/{pool_id}/import_files

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/import_files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of imported files.

{
  "count": 1,
  "import_files": [
    {
      "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
    }
  ]
}

(By pool) Displays a specific file on tape of pools, specific for Data Exchange.

get

API Key Scope: import_files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idintegerRequired

Numeric ID of file.

Responses

200

A specific imported file.

application/json

Responseall of

get

/pools/{pool_id}/import_files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/import_files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific imported file.

{
  "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,
  "file_path": "/my-container/my-file.txt"
}

(By pool) Lists files under a specific folder on tape of pools, specific for Data Exchange.

get

API Key Scope: import_files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_parent_idintegerRequired

Numeric ID of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

Responses

200

List of imported files.

application/json

get

/pools/{pool_id}/import_files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/import_files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of imported files.

{
  "count": 1,
  "import_files": [
    {
      "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
    }
  ]
}

(By pool) Lists files on root of tape of pools, specific for Active and Offline.

get

API Key Scope: on_tapes_files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

namestringOptional

Filter on name

typestringOptional

Filter on type

sizestringOptional

Filter on size

Responses

200

List of files on tapes.

application/json

get

/pools/{pool_id}/on_tapes_files

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/on_tapes_files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files on tapes.

{
  "count": 1,
  "on_tapes_files": [
    {
      "id": 105,
      "name": "my-file.txt",
      "type": "file",
      "size": 1063457,
      "barcodes": [
        "NOD407L5",
        "NOD415L5"
      ]
    }
  ]
}

(By pool) Displays a specific file on tape of pools, specific for Active and Offline.

get

API Key Scope: on_tapes_files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idintegerRequired

Numeric ID of file.

Responses

200

A specific file on tapes.

application/json

get

/pools/{pool_id}/on_tapes_files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/on_tapes_files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific file on tapes.

{
  "id": 105,
  "name": "my-file.txt",
  "type": "file",
  "size": 1063457,
  "barcodes": [
    "NOD407L5",
    "NOD415L5"
  ]
}

(By pool) Lists files under a specific folder on tape of pools, specific for Active and Offline.

get

API Key Scope: on_tapes_files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_parent_idintegerRequired

Numeric ID of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

namestringOptional

Filter on name

typestringOptional

Filter on type

sizestringOptional

Filter on size

Responses

200

List of files on tapes.

application/json

get

/pools/{pool_id}/on_tapes_files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/pools/{pool_id}/on_tapes_files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files on tapes.

{
  "count": 1,
  "on_tapes_files": [
    {
      "id": 105,
      "name": "my-file.txt",
      "type": "file",
      "size": 1063457,
      "barcodes": [
        "NOD407L5",
        "NOD415L5"
      ]
    }
  ]
}

(By task) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

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.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/tasks/{task_id}/files

HTTPcURLJavaScriptPython

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

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By task) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_idstringRequired

Numeric ID or path of file.

Responses

200

A specific file.

application/json

Responseall of

get

/tasks/{task_id}/files/{file_id}

HTTPcURLJavaScriptPython

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

200

A specific file.

{
  "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"
}

(By task) Displays tapes containing specific file, related to the specific task.

get

API Key Scope: files / tapes

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of tapes.

application/json

get

/tasks/{task_id}/files/{file_id}/tapes

HTTPcURLJavaScriptPython

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

200

List of tapes.

{
  "count": 1,
  "tapes": [
    {
      "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-11-05T15:57:33.149Z",
      "date_move": "2025-11-05T15:57:33.149Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:57:33.149Z",
      "last_maintenance": "2025-11-05T15:57:33.149Z",
      "last_repack": "2025-11-05T15:57:33.149Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

(By task) Displays cloud buckets containing specific file, related to the specific task.

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of cloud buckets.

application/json

get

/tasks/{task_id}/files/{file_id}/cloud_buckets

HTTPcURLJavaScriptPython

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

200

List of cloud buckets.

{
  "count": 1,
  "cloud_buckets": [
    {
      "id": 1,
      "cloud_connector_id": 1,
      "pool_id": 1,
      "name": "text",
      "file_count": 1,
      "file_size_sum": 1,
      "location": "text",
      "price": "text",
      "options": "text"
    }
  ]
}

(By task) Displays NAS Shares containing specific file, related to the specific task.

get

API Key Scope: files / nas_shares

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of NAS shares.

application/json

get

/tasks/{task_id}/files/{file_id}/nas_shares

HTTPcURLJavaScriptPython

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

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

(By task) Calculate total size of files contains in a folder.

get

API Key Scope: files / file_size

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_idstringRequired

Numeric ID or path of file.

Responses

200

Sum of the file sizes.

application/json

get

/tasks/{task_id}/files/{file_id}/file_size

HTTPcURLJavaScriptPython

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

200

Sum of the file sizes.

{
  "file_size": 1
}

(By task) Lists files under a specific folder.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_idstringRequired

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

file_parent_idstringRequired

Numeric ID or path of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/tasks/{task_id}/files/{file_parent_id}/children

HTTPcURLJavaScriptPython

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

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By task execution) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/task_executions/{task_execution_id}/files

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}

(By task execution) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_idstringRequired

Numeric ID or path of file.

Responses

200

A specific file.

application/json

Responseall of

get

/task_executions/{task_execution_id}/files/{file_id}

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_id} HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

A specific file.

{
  "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"
}

(By task execution) Displays tapes containing specific file, related to the specific task.

get

API Key Scope: files / tapes

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of tapes.

application/json

get

/task_executions/{task_execution_id}/files/{file_id}/tapes

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_id}/tapes HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of tapes.

{
  "count": 1,
  "tapes": [
    {
      "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-11-05T15:57:33.149Z",
      "date_move": "2025-11-05T15:57:33.149Z",
      "free": 1,
      "max": 1,
      "last_size_update": "2025-11-05T15:57:33.149Z",
      "last_maintenance": "2025-11-05T15:57:33.149Z",
      "last_repack": "2025-11-05T15:57:33.149Z",
      "repack_status": 1,
      "force_import_type": 1,
      "need_to_check": 1
    }
  ]
}

(By task execution) Displays cloud buckets containing specific file, related to the specific task.

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of cloud buckets.

application/json

get

/task_executions/{task_execution_id}/files/{file_id}/cloud_buckets

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_id}/cloud_buckets HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of cloud buckets.

{
  "count": 1,
  "cloud_buckets": [
    {
      "id": 1,
      "cloud_connector_id": 1,
      "pool_id": 1,
      "name": "text",
      "file_count": 1,
      "file_size_sum": 1,
      "location": "text",
      "price": "text",
      "options": "text"
    }
  ]
}

(By task execution) Displays NAS Shares containing specific file, related to the specific task.

get

API Key Scope: files / nas_shares

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_idstringRequired

Numeric ID or path of file.

Responses

200

List of NAS shares.

application/json

get

/task_executions/{task_execution_id}/files/{file_id}/nas_shares

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_id}/nas_shares HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of NAS shares.

{
  "count": 1,
  "nas_shares": [
    {
      "id": 10,
      "nas_id": 2,
      "pool_id": 6,
      "name": "archives_general",
      "path": "archives/general",
      "options": "rsize=1048576,wsize=1048576",
      "username": "admin",
      "password": "[censored]",
      "file_count": 1,
      "file_size_sum": 1
    }
  ]
}

(By task execution) Calculate total size of files contains in a folder.

get

API Key Scope: files / file_size

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_idstringRequired

Numeric ID or path of file.

Responses

200

Sum of the file sizes.

application/json

get

/task_executions/{task_execution_id}/files/{file_id}/file_size

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_id}/file_size HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

Sum of the file sizes.

{
  "file_size": 1
}

(By task execution) Lists files under a specific folder.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

Path parameters

task_execution_idstringRequired

Numeric ID of task execution.

file_parent_idstringRequired

Numeric ID or path of parent folder.

Query parameters

limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

file_idstringOptional

Filter on file id

namestringOptional

Filter on name

typestringOptional

Filter on type

permissionstringOptional

Filter on permission

sizestringOptional

Filter on size

change_datestringOptional

Filter on change date

modification_datestringOptional

Filter on modification date

access_datestringOptional

Filter on access date

gidstringOptional

Filter on gid

uidstringOptional

Filter on uid

offlinestringOptional

Filter on file offline status

in_cachestringOptional

Filter on file in cache status

Responses

200

List of files.

application/json

get

/task_executions/{task_execution_id}/files/{file_parent_id}/children

HTTPcURLJavaScriptPython

GET /api/v2/task_executions/{task_execution_id}/files/{file_parent_id}/children HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

200

List of files.

{
  "count": 1,
  "files": [
    {
      "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"
      ]
    }
  ]
}