Start a job execution | Labric

Open a job execution for a script running outside the platform.

Pass the returned job_execution_id to the write and upload-file tools so everything one script run produces is attributed to a single execution and can be inspected or reverted as a unit. Pass job_id to run under an existing job, job_name to run under a job of that name (created if missing), or neither to run under the default off-platform job.

The execution is marked running immediately. Close it as completed or failed when the script finishes. Pass timeout_minutes to have the platform fail it after that long if the script has not closed it, so a crashed script does not leave it running forever.

Requires an API key with the write scope.

Open a job execution for a script running outside the platform. Pass the returned job_execution_id to the write and upload-file tools so everything one script run produces is attributed to a single execution and can be inspected or reverted as a unit. Pass job_id to run under an existing job, job_name to run under a job of that name (created if missing), or neither to run under the default off-platform job. The execution is marked running immediately. Close it as completed or failed when the script finishes. Pass timeout_minutes to have the platform fail it after that long if the script has not closed it, so a crashed script does not leave it running forever. Requires an API key with the `write` scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects a nullable object.

job_idstring or nullOptionalformat: "uuid"

ID of an existing job to run under. Omit to use job_name instead.

job_namestring or nullOptional

Name of the job to run under, created if it does not exist yet. Ignored when job_id is given. Defaults to ‘Off-Platform Manual Job’.

timeout_minutesinteger or nullOptional1-43200

Fail the execution if the script has not closed it within this many minutes (at most 43200, i.e. 30 days), so a crashed script does not leave it running forever. Omit to let it run until closed.

Response

job_execution_idstringformat: "uuid"

Pass this as job_execution_id to the write and upload-file tools.

job_idstringformat: "uuid"

ID of the job the execution belongs to.

job_namestring

Name of the job the execution belongs to.

statusstring or null

The execution's current status.

started_atdatetime or null

When the execution started.

completed_atdatetime or null

When the execution ended, or null while it is still running.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Open a job execution for a script running outside the platform.

Requires an API key with the write scope.