Documentation by ClonePartner

Start typing to search.

API Reference

Get job configuration schema and values

View Markdown
GET /api/jobs/{id}/config

Returns top-level job_config schema from the job's snapshotted template YAML plus current persisted values from the job_config table. This is the native job-owned configuration surface; dashboard input widgets remain compatible writers for the same keys.

Operation IDgetJobConfig

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Job configuration schema and values

Job configuration schema and values

Content typeapplication/json

responseobject
2 properties
schemaobjectrequired

Top-level job_config schema from the job snapshot, keyed by config key.

Additional properties
valueDashboardFieldMappingWidget | DashboardFormWidget

Schema-backed job_config entry copied from the job template snapshot.

One of
One of 1object

Two-column source→target field mapping. Stored value is an array of mappings.

9 properties
idstringrequired
typestringrequired
Allowed values
field_mapping
titlestring
config_keystringrequired
sourceobjectrequired

Connector-agnostic option source for input-widget pickers. options_source is a readonly call_method config resolved server-side; the *_expr fields map each raw row to { label, value, subText }. When search.on_frontend is set the server returns one bounded page and the picker filters locally.

7 properties
options_sourceunknownrequired

Readonly call_method config (object) or JSONata string resolving to one.

label_exprstring
value_exprstring
subtext_exprstring
transform_exprstring
depends_onarray<string>
Array items
itemstring
searchobject
4 properties
paramstringrequired
on_frontendboolean
placeholderstring
empty_textstring
targetobjectrequired

Connector-agnostic option source for input-widget pickers. options_source is a readonly call_method config resolved server-side; the *_expr fields map each raw row to { label, value, subText }. When search.on_frontend is set the server returns one bounded page and the picker filters locally.

7 properties
options_sourceunknownrequired

Readonly call_method config (object) or JSONata string resolving to one.

label_exprstring
value_exprstring
subtext_exprstring
transform_exprstring
depends_onarray<string>
Array items
itemstring
searchobject
4 properties
paramstringrequired
on_frontendboolean
placeholderstring
empty_textstring
allow_transformboolean
defaultunknown

Optional default mapping array when used from top-level job_config.

validation_exprstring
One of 2object

Generic typed form. Stored value is an object keyed by field key.

7 properties
idstringrequired
typestringrequired
Allowed values
form
titlestring
config_keystringrequired
fieldsarray<DashboardFormField>required
Array items
itemobject
10 properties
keystringrequired
labelstring
typestringrequired
Allowed values
text, number, boolean, select, multi_select
requiredboolean
defaultunknown
formatstring
optionsarray<object>
Array items
itemobject
2 properties
labelstring
valueunknown
options_sourceobject

Connector-agnostic option source for input-widget pickers. options_source is a readonly call_method config resolved server-side; the *_expr fields map each raw row to { label, value, subText }. When search.on_frontend is set the server returns one bounded page and the picker filters locally.

7 properties
options_sourceunknownrequired

Readonly call_method config (object) or JSONata string resolving to one.

label_exprstring
value_exprstring
subtext_exprstring
transform_exprstring
depends_onarray<string>
Array items
itemstring
searchobject
4 properties
paramstringrequired
on_frontendboolean
placeholderstring
empty_textstring
depends_onarray<string>
Array items
itemstring
hide_if_exprstring
validation_exprstring
transform_exprstring
configobjectrequired

Current persisted job_config values keyed by config key.

Additional properties are allowed.

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}