API Reference

Replace job configuration values

PUT /api/jobs/{id}/config

Replaces the persisted job_config object for a job. This is the manual Job Details editor endpoint for jobs without schema-backed configuration. If the job snapshot declares schema-backed keys, values for those keys are validated and transformed before storing. Requires admin or superadmin role.

Operation IDreplaceJobConfig

Authentication

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

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

1 property

configobjectrequired

Complete persisted job_config object keyed by config key.

Additional properties are allowed.

Success response body

200Config object saved

Config object saved

Content typeapplication/json

responseobject

2 properties

okbooleanrequired

configobjectrequired

Stored job_config object after validation/transforms for schema-backed keys.

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"
}

403Insufficient permissions

Insufficient permissions

No response content schema is documented.

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"
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/jobs/YOUR_ID/config' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {}
}'

const response = await fetch("https://your-envoy.example.com/api/jobs/YOUR_ID/config", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "config": {}
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);