Skip to main content
POST
Create templates.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
name
string
required

Globally unique job-template name within the instance. Check for an existing template with this exact name before creation; direct triggers may also resolve the template by name.

Example:

"Nightly sync"

componentId
string
required

Component identifier executed by this job template.

Example:

"bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"

executionPolicy
object | null

Saved Job execution policy. Omit or clear to inherit instance defaults. A conflicting legacy triggerUser is rejected.

Example:
category
string

Optional presentation category used to group templates.

Example:

"Operations"

desc
string

Operator-visible job template description.

Example:

"Runs the nightly data synchronization pipeline."

metadata
object | null

Optional resource metadata. Values may use any JSON type. Maximum 16 KiB and 64 top-level keys. Top-level keys starting with "__" are reserved for backend use.

Example:
componentDigest
string

Portable exact component revision identity. Omit it to follow the latest active revision.

Example:

"v1:sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

timeout
number
default:300

Job execution timeout in seconds. The effective limit comes from the instance jobTimeout quota, up to 3540 seconds (59 minutes).

Required range: 1 <= x <= 3540
Example:

300

triggerUser
string
deprecated

Deprecated execution-principal alias. Prefer executionPolicy. Existing bindings remain supported; conflicting values are rejected.

Example:

"cccccccc-cccc-4ccc-8ccc-cccccccccccc"

options
object

Execution options. Custom low-code template values live under "input".

Example:
inputs
object | null

Deprecated legacy template inputs. Use options.input. Must be a JSON object; null is stored as an empty object.

Example:

Response

Job scheduled.

Last modified on September 5, 2026