Download a file

GET

/system/file-explorer/download

const url = 'https://sylve.lan:8181/api/system/file-explorer/download?id=example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://sylve.lan:8181/api/system/file-explorer/download?id=example' \
  --header 'Authorization: <Authorization>'

Stream a regular file from an absolute system path with HTTP range support

Authorizations

BearerAuth

Parameters

Query Parameters

required

string

Absolute path to the regular file

hash

string

SHA-256 token hash alternative to Bearer authentication

auth

string

Hex-encoded selected-node routing payload used by browser downloads

Responses

200

File content

application/octet-stream

file

206

Partial file content

application/octet-stream

file

400

Invalid path or non-regular file

application/octet-stream

object

data

error

string

message

string

status

string

401

Unauthorized

application/octet-stream

object

data

error

string

message

string

status

string

403

Administrator access or filesystem permission required

application/octet-stream

object

data

error

string

message

string

status

string

404

File not found

application/octet-stream

object

data

error

string

message

string

status

string

416

Range Not Satisfiable

application/octet-stream

string

500

Unexpected filesystem failure

application/octet-stream

object

data

error

string

message

string

status

string