Skip to content

Download or Preview File via SFTP

GET
/sftp

Downloads a file or folder from a remote server via SFTP. Supports file preview, thumbnail generation for images, and folder download as ZIP archive.

Parameters

Query Parameters

sessionToken*

Session authentication token

Type
string
Required
sessionId*

Active server session ID

Type
string
Required
path*

Remote file or folder path to download

Type
string
Required
preview

Set to "true" to display file inline instead of downloading

Type
string
thumbnail

Set to "true" to generate a thumbnail (images only, max 10MB)

Type
string
size

Thumbnail size in pixels (50-300, default: 100)

Type
number

Responses

File content, ZIP archive, or thumbnail image

application/json
JSON
"string"

Playground

Server
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

Distributed under the MIT License