Skip to main content
POST
/
servers
/
{id}
/
files
/
pull
Start remote download
curl --request POST \
  --url https://your-domain.com/api/client/v1/servers/{id}/files/pull \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "directory": "/",
  "filename": "<string>",
  "use_header": false,
  "foreground": false
}
'
{
  "ok": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Server UUID.

Body

application/json
url
string<uri>
required
directory
string
default:/
required
filename
string
use_header
boolean
default:false
foreground
boolean
default:false

Response

Download started

ok
boolean