POST Remote Launch

POST /api/remotes/launch

Uses an existing remote session to submit a command. The session must have been created successfully using POST /api/remotes.

Request JSON Object:

  • sid (string) – Unique remote session identifier.

  • command (string) – command to be ran on the remote system.

Status Codes:

  • 200 OK – The response contains the command, its output and possible errors.

  • 400 Bad Request – The request failed due to invalid parameters or a Slycat agent issue.

  • 500 Internal Server Error – The request failed due to a SSH exception.

Response Headers:

  • Content-Type – application/json

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

Response JSON Object:

  • command (string) – Command issued to the remote system.

  • output (string) – Output of the command.

  • errors (string) – Error information, if any.

Sample Request

POST /api/remotes/launch HTTP/1.1

{
  sid: "505d0e463d5ed4a32bb6b0fe9a000d36",
  command: "echo test"
}

Sample Response

HTTP/1.1 200 OK

{
  "command": "echo test",
  "output": "test",
  "errors": ""
}

See Also