machines

Cancel a job.

Sends SIGTERM to a running job. Its exit code, 143, is recorded once it has stopped. Requires the machine:exec scope.

post/v1/machines/{id}/jobs/{job_id}/cancel

Request

Base URL
https://api.smolmachines.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/smolmachines/apis/smolfleet-api/docs/v1/machines/:id/jobs/:job_id/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Machine id

job_idstring required

Job id

The job, as it stands after the signal

commandstring[] required

The command as it was run (argv).

createdAtstring required

exitCodeinteger nullable

The command's exit code once exited; 143 when it was cancelled or hit its timeout.

finishedAtstring nullable

idstring required

machineIdstring required

statestring required

running, exited (see exitCode), or lost: the machine stopped or restarted while the job ran, so it never finished.

stderrBytesinteger nullable

Bytes of stderr written so far, when the machine was asked.

stdoutBytesinteger nullable

Bytes of stdout written so far, when the machine was asked.