GET Remote File

GET /api/remotes/(hostname)/file(path)

Uses an existing remote session to retrieve a remote file. The remote session must have been created using POST /api/remotes. Use POST /api/remotes/(hostname)/browse(path) to lookup remote file paths. The returned file may be optionally cached on the server and retrieved using GET /api/projects/(pid)/cache/(key).

Parameters:

  • hostname (string) – Unique hostname returned from POST /api/remotes.

  • path (string) – Remote filesystem path (must be absolute).

Query Parameters:

  • cache – Optional cache identifier. Set to project to store the retrieved file in a project cache.

  • project – Project identifier. Required when cache is set to project.

  • key – Cached object key. Must be specified when cache is set to project.

Status Codes:

  • 200 OK – The requested file is returned in the body of the response.

  • 404 Not Found – The session doesn’t exist or has timed-out.

  • 400 Bad Request – “Can’t read directory” The remote path is a directory instead of a file.

  • 400 Bad Request – “File not found” The remote path doesn’t exist.

  • 400 Bad Request – “Access denied” The session user doesn’t have permissions to access the file.

Response Headers:

  • Content-Type – The MIME type of the response is automatically determined using the requested filename.

  • X-Slycat-Message – For errors, contains a human-readable description of the problem.

  • X-Slycat-Hint – For errors, contains an optional description of how to fix the problem.

Sample Request

GET /api/remotes/localhost/file/home/slycat/src/slycat-data/TAIS/workdir.244/stress_zz_000001.png?cache=project&project=fe372daf01f75276c7e5228e6e000024&key=localhost%252Fhome%252Fslycat%252Fsrc%252Fslycat-data%252FTAIS%252Fworkdir.244%252Fstress_zz_000001.png HTTP/1.1
Host: localhost:9000
Connection: keep-alive
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36
DNT: 1
Accept: */*
Referer: https://localhost:9000/models/514ac8d82e834e6cae2c25307ac1e69f?bid=18de324920c051bf768c9d2b7f0a23db
Accept-Encoding: gzip, deflate, br
Accept-Language: en-US,en;q=0.9
Cookie: slycatauth=f204afc7e8ce44e79cdd41fc78ecd41b; slycattimeout=timeout

Sample Response

HTTP/1.1 200 OK
X-Powered-By: Express
content-length: 59210
expires: 0
server: CherryPy/14.0.0
pragma: no-cache
cache-control: no-cache, no-store, must-revalidate
date: Thu, 27 Jun 2019 21:49:32 GMT
content-type: image/png
connection: close

See Also