POST Cancel Job

POST /api/remotes/cancel-job

Uses an existing remote session to cancel a job submitted via the SLURM interface on a remote cluster. The session must have been created successfully using POST /api/remotes.

Request JSON Object:

  • sid (string) – Unique remote session identifier.

  • jid (string) – Job ID.

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:

  • jid (int) – Job ID.

  • output (string) – Output information, if any.

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

Sample Request

POST /remotes/checkjob HTTP/1.1

{
  sid: "505d0e463d5ed4a32bb6b0fe9a000d36",
  jid: 123456
}

HTTP/1.1 200 OK

{
  "jid": 123456,
  "output": "",
  "errors": ""
}

See Also