POST Submit Batch

POST /api/remotes/submit-batch

Uses an existing remote sessions to submit a batch file to start a job on a cluster running SLURM. The session must have been created successfully using POST /api/remotes.

Request JSON Object:

  • sid (string) – Unique remote session identifier.

  • filename (string) – Name for the batch file.

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 no Slycat agent present and configured on the remote system.

Response Headers:

  • Content-Type – application/json

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

Response JSON Object:

  • filename (string) – Name of the file submitted in the request.

  • jid (int) – Job ID.

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

Sample Request

POST /remotes/submit-batch HTTP/1.1

{
  sid: "505d0e463d5ed4a32bb6b0fe9a000d36",
  filename: "/home/jdoe/batch.test.bash"
}

Sample Response

HTTP/1.1 200 OK

{
  "filename": "/home/jdoe/batch.test.bash",
  "jid": 123456,
  "errors": ""
}

See Also