Files

Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

file_idstringRequired

ID or path of file.

Responses

200

A specific file.

application/json

idone ofRead-onlyOptionalExample: 63

stringOptional

or

integer · int64Optional

namestringRead-onlyOptionalExample: my-file.txt

parentone ofRead-onlyOptionalExample: 62

stringOptional

or

integer · int64Optional

primary_idone ofRead-onlyOptionalExample: 52

stringOptional

or

integer · int64Optional

typestring · enumRead-onlyOptionalExample: filePossible values:

permissionintegerRead-onlyOptionalExample: 100666

sizeinteger · int64Read-onlyOptionalExample: 1063457

change_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 08:33:47+00:00

modification_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:29:23+00:00

access_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:27:51+00:00

uidinteger · int64Read-onlyOptionalExample: 1000

gidinteger · int64Read-onlyOptionalExample: 1000

in_cachestring · enumRead-onlyOptionalExample: in_cachePossible values:

offlinestring · enumRead-onlyOptionalExample: onlinePossible values:

externintegerRead-onlyOptionalExample: 1

checksumsstring[]Read-onlyOptional

Checksums on the specific location. Does not apply to all API calls

cloud_bucketsstring[]Read-onlyOptional

Cloud bucket names on the specific location. Does not apply on folders. Only available on related API calls

nas_sharesstring[]Read-onlyOptional

NAS Share names on the specific location. Does not apply on folders. Only available on related API calls

file_pathstringRead-onlyOptionalExample: /my-container/my-file.txt

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

get

/files/{file_id}

HTTPcURLJavaScriptPython

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

{
  "id": 63,
  "name": "my-file.txt",
  "parent": 62,
  "primary_id": 52,
  "type": "file",
  "permission": 100666,
  "size": 1063457,
  "change_date": "2018-12-10 08:33:47+00:00",
  "modification_date": "2018-12-10 15:29:23+00:00",
  "access_date": "2018-12-10 15:27:51+00:00",
  "uid": 1000,
  "gid": 1000,
  "in_cache": "in_cache",
  "offline": "online",
  "extern": 1,
  "checksums": [
    "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

AuthorizationstringRequired

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

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

(By pool) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

(By pool) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

ID or path of file.

Responses

200

A specific file.

application/json

idone ofRead-onlyOptionalExample: 63

stringOptional

or

integer · int64Optional

namestringRead-onlyOptionalExample: my-file.txt

parentone ofRead-onlyOptionalExample: 62

stringOptional

or

integer · int64Optional

primary_idone ofRead-onlyOptionalExample: 52

stringOptional

or

integer · int64Optional

typestring · enumRead-onlyOptionalExample: filePossible values:

permissionintegerRead-onlyOptionalExample: 100666

sizeinteger · int64Read-onlyOptionalExample: 1063457

change_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 08:33:47+00:00

modification_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:29:23+00:00

access_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:27:51+00:00

uidinteger · int64Read-onlyOptionalExample: 1000

gidinteger · int64Read-onlyOptionalExample: 1000

in_cachestring · enumRead-onlyOptionalExample: in_cachePossible values:

offlinestring · enumRead-onlyOptionalExample: onlinePossible values:

externintegerRead-onlyOptionalExample: 1

checksumsstring[]Read-onlyOptional

Checksums on the specific location. Does not apply to all API calls

cloud_bucketsstring[]Read-onlyOptional

Cloud bucket names on the specific location. Does not apply on folders. Only available on related API calls

nas_sharesstring[]Read-onlyOptional

NAS Share names on the specific location. Does not apply on folders. Only available on related API calls

file_pathstringRead-onlyOptionalExample: /my-container/my-file.txt

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

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: */*

{
  "id": 63,
  "name": "my-file.txt",
  "parent": 62,
  "primary_id": 52,
  "type": "file",
  "permission": 100666,
  "size": 1063457,
  "change_date": "2018-12-10 08:33:47+00:00",
  "modification_date": "2018-12-10 15:29:23+00:00",
  "access_date": "2018-12-10 15:27:51+00:00",
  "uid": 1000,
  "gid": 1000,
  "in_cache": "in_cache",
  "offline": "online",
  "extern": 1,
  "checksums": [
    "text"
  ],
  "cloud_buckets": [
    "text"
  ],
  "nas_shares": [
    "text"
  ],
  "file_path": "/my-container/my-file.txt"
}

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

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

ID or path of file.

Responses

200

List of cloud buckets.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

ID or path of file.

Responses

200

List of NAS shares.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

ID or path of file.

Responses

200

Sum of the file sizes.

application/json

file_sizeintegerRead-onlyOptional

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

AuthorizationstringRequired

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

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

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

get

API Key Scope: import_files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

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

countintegerRead-onlyOptionalExample: 1

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-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000
    }
  ]
}

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

get

API Key Scope: import_files / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_idstringRequired

ID of file.

Responses

200

A specific imported file.

application/json

idinteger · int64Read-onlyOptionalExample: 105

namestringRead-onlyOptionalExample: my-file.txt

parentinteger · int64Read-onlyOptionalExample: 100

primary_idinteger · int64Read-onlyOptionalExample: 100

typestring · enumRead-onlyOptionalExample: filePossible values:

permissionintegerRead-onlyOptionalExample: 100666

sizeinteger · int64Read-onlyOptionalExample: 1063457

change_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 08:33:47+00:00

modification_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:29:23+00:00

access_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:27:51+00:00

uidinteger · int64Read-onlyOptionalExample: 1000

gidinteger · int64Read-onlyOptionalExample: 1000

file_pathstringRead-onlyOptionalExample: /my-container/my-file.txt

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

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: */*

{
  "id": 105,
  "name": "my-file.txt",
  "parent": 100,
  "primary_id": 100,
  "type": "file",
  "permission": 100666,
  "size": 1063457,
  "change_date": "2018-12-10 08:33:47+00:00",
  "modification_date": "2018-12-10 15:29:23+00:00",
  "access_date": "2018-12-10 15:27:51+00:00",
  "uid": 1000,
  "gid": 1000,
  "file_path": "/my-container/my-file.txt"
}

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

get

API Key Scope: import_files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

pool_idstringRequired

Numeric ID, or name of pool.

file_parent_idstringRequired

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

countintegerRead-onlyOptionalExample: 1

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-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000
    }
  ]
}

(By task) Lists files on root.

get

API Key Scope: files / 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

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

(By task) Displays a specific file.

get

API Key Scope: files / 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

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

file_idstringRequired

ID or path of file.

Responses

200

A specific file.

application/json

idone ofRead-onlyOptionalExample: 63

stringOptional

or

integer · int64Optional

namestringRead-onlyOptionalExample: my-file.txt

parentone ofRead-onlyOptionalExample: 62

stringOptional

or

integer · int64Optional

primary_idone ofRead-onlyOptionalExample: 52

stringOptional

or

integer · int64Optional

typestring · enumRead-onlyOptionalExample: filePossible values:

permissionintegerRead-onlyOptionalExample: 100666

sizeinteger · int64Read-onlyOptionalExample: 1063457

change_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 08:33:47+00:00

modification_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:29:23+00:00

access_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:27:51+00:00

uidinteger · int64Read-onlyOptionalExample: 1000

gidinteger · int64Read-onlyOptionalExample: 1000

in_cachestring · enumRead-onlyOptionalExample: in_cachePossible values:

offlinestring · enumRead-onlyOptionalExample: onlinePossible values:

externintegerRead-onlyOptionalExample: 1

checksumsstring[]Read-onlyOptional

Checksums on the specific location. Does not apply to all API calls

cloud_bucketsstring[]Read-onlyOptional

Cloud bucket names on the specific location. Does not apply on folders. Only available on related API calls

nas_sharesstring[]Read-onlyOptional

NAS Share names on the specific location. Does not apply on folders. Only available on related API calls

file_pathstringRead-onlyOptionalExample: /my-container/my-file.txt

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

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: */*

{
  "id": 63,
  "name": "my-file.txt",
  "parent": 62,
  "primary_id": 52,
  "type": "file",
  "permission": 100666,
  "size": 1063457,
  "change_date": "2018-12-10 08:33:47+00:00",
  "modification_date": "2018-12-10 15:29:23+00:00",
  "access_date": "2018-12-10 15:27:51+00:00",
  "uid": 1000,
  "gid": 1000,
  "in_cache": "in_cache",
  "offline": "online",
  "extern": 1,
  "checksums": [
    "text"
  ],
  "cloud_buckets": [
    "text"
  ],
  "nas_shares": [
    "text"
  ],
  "file_path": "/my-container/my-file.txt"
}

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

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

file_idstringRequired

ID or path of file.

Responses

200

List of cloud buckets.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

file_idstringRequired

ID or path of file.

Responses

200

List of NAS shares.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

file_idstringRequired

ID or path of file.

Responses

200

Sum of the file sizes.

application/json

file_sizeintegerRead-onlyOptional

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

AuthorizationstringRequired

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

Path parameters

task_idstringRequired

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

(By task execution) Lists files on root.

get

API Key Scope: files / index

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}

(By task execution) Displays a specific file.

get

API Key Scope: files / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

ID of task execution.

file_idstringRequired

ID or path of file.

Responses

200

A specific file.

application/json

idone ofRead-onlyOptionalExample: 63

stringOptional

or

integer · int64Optional

namestringRead-onlyOptionalExample: my-file.txt

parentone ofRead-onlyOptionalExample: 62

stringOptional

or

integer · int64Optional

primary_idone ofRead-onlyOptionalExample: 52

stringOptional

or

integer · int64Optional

typestring · enumRead-onlyOptionalExample: filePossible values:

permissionintegerRead-onlyOptionalExample: 100666

sizeinteger · int64Read-onlyOptionalExample: 1063457

change_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 08:33:47+00:00

modification_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:29:23+00:00

access_datestring · date-timeRead-onlyOptionalExample: 2018-12-10 15:27:51+00:00

uidinteger · int64Read-onlyOptionalExample: 1000

gidinteger · int64Read-onlyOptionalExample: 1000

in_cachestring · enumRead-onlyOptionalExample: in_cachePossible values:

offlinestring · enumRead-onlyOptionalExample: onlinePossible values:

externintegerRead-onlyOptionalExample: 1

checksumsstring[]Read-onlyOptional

Checksums on the specific location. Does not apply to all API calls

cloud_bucketsstring[]Read-onlyOptional

Cloud bucket names on the specific location. Does not apply on folders. Only available on related API calls

nas_sharesstring[]Read-onlyOptional

NAS Share names on the specific location. Does not apply on folders. Only available on related API calls

file_pathstringRead-onlyOptionalExample: /my-container/my-file.txt

404

The requested resource was not found. The detailed error will be of type not_found.

application/json

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: */*

{
  "id": 63,
  "name": "my-file.txt",
  "parent": 62,
  "primary_id": 52,
  "type": "file",
  "permission": 100666,
  "size": 1063457,
  "change_date": "2018-12-10 08:33:47+00:00",
  "modification_date": "2018-12-10 15:29:23+00:00",
  "access_date": "2018-12-10 15:27:51+00:00",
  "uid": 1000,
  "gid": 1000,
  "in_cache": "in_cache",
  "offline": "online",
  "extern": 1,
  "checksums": [
    "text"
  ],
  "cloud_buckets": [
    "text"
  ],
  "nas_shares": [
    "text"
  ],
  "file_path": "/my-container/my-file.txt"
}

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

get

API Key Scope: files / cloud_buckets

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

ID of task execution.

file_idstringRequired

ID or path of file.

Responses

200

List of cloud buckets.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

ID of task execution.

file_idstringRequired

ID or path of file.

Responses

200

List of NAS shares.

application/json

countintegerRead-onlyOptionalExample: 1

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

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

ID of task execution.

file_idstringRequired

ID or path of file.

Responses

200

Sum of the file sizes.

application/json

file_sizeintegerRead-onlyOptional

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

AuthorizationstringRequired

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

Path parameters

task_execution_idstringRequired

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

countintegerRead-onlyOptionalExample: 1

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": 63,
      "name": "my-file.txt",
      "parent": 62,
      "primary_id": 52,
      "type": "file",
      "permission": 100666,
      "size": 1063457,
      "change_date": "2018-12-10 08:33:47+00:00",
      "modification_date": "2018-12-10 15:29:23+00:00",
      "access_date": "2018-12-10 15:27:51+00:00",
      "uid": 1000,
      "gid": 1000,
      "in_cache": "in_cache",
      "offline": "online",
      "extern": 1,
      "checksums": [
        "text"
      ],
      "cloud_buckets": [
        "text"
      ],
      "nas_shares": [
        "text"
      ]
    }
  ]
}