job

run script by path

Changed on
post/w/{workspace}/jobs/run/p/{path}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/jobs/run/p/{path}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
pathstring required

Query parameters

scheduled_forstring date-time

when to schedule this job (leave empty for immediate run)

scheduled_in_secsinteger

schedule the script to execute in the number of seconds starting now

skip_preprocessorboolean

skip the preprocessor

parent_jobstring uuid

The parent job that is at the origin and responsible for the execution of this script if any

tagstring

Override the tag to use

cache_ttlstring

Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl

job_idstring uuid

The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)

retrystring

JSON-encoded retry policy (same shape as a schedule's retry) re-running the job when it fails. The returned id is the first attempt's; each retry is a job of its own, recorded as a child of the first attempt. Not supported for hub scripts, with invisible_to_owner, or for a script whose preprocessor would run.

invisible_to_ownerboolean

make the run invisible to the the script owner (default false)

Request body

ScriptArgs required

The arguments to pass to the script or flow

Response

job created

Changes