GET Remote Video

GET /api/remotes/(hostname)/videos/(vsid)

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

Parameters:
  • sid (string) – Unique remote session identifier.

  • vsid (string) – Unique video creation session identifier.

Query Parameters:
  • cache – Optional cache identifier. Set to project to store the retrieved video 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 video has been returned in the response body.

  • 206 Partial Content – A portion of the video has been returned in the response body.

  • 400 Bad Request – “Agent required” This call requires a remote agent, but the current session isn’t running an agent.

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

Response Headers:
  • Content-Type – video/mp4 or video/webm, depending on the original request.

  • 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/505d0e463d5ed4a32bb6b0fe9a000d36/videos/431d0e463d5ed4a32bb6b0fe9a000a37 HTTP/1.1

See Also