Pterodactyl API v1
File Manager

Pull remote file

Downloads a file from an external URL to the server

POST/api/client/servers/{server}/files/pull

Authorization

ClientToken
AuthorizationBearer <token>

Client API key (generated at /account/api)

In: header

Path Parameters

server*string

Server identifier (short 8-character ID)

Request Body

application/json

url*string

Publicly reachable URL to download the file from.

directory?string

Destination directory on the server, relative to the server root. Defaults to the server root.

filename?string

Name to save the file as. Defaults to the name in the URL.

use_header?boolean

If true, take the filename from the remote response's Content-Disposition header instead of the URL or filename.

foreground?boolean

If true, wait for the download to finish before responding. If false or omitted, it runs in the background.

Response Body

curl -X POST "https://pterodactyl.file.properties/api/client/servers/1a7ce997/files/pull" \  -H "Authorization: Bearer ptlc_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{  "url": "https://example.com/server-plugin.jar",  "directory": "/plugins",  "filename": "plugin.jar"}'
Empty