Jobs

Update a job

Changed on

Update the configuration details of an existing job.

put/api/v1/project/{projectid}/jobs/{id}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

projectidstring required

project id (default is 123)

idinteger required

job id

Request body

activateboolean
available_streams_configstring
difference_streamsstring
frequencystring required
namestring required
selected_streams_configstring
streams_configstring

Example request

{
  "activate": true,
  "advanced_settings": {
    "index_required": true,
    "max_discover_threads": 50,
    "target_query_engines": [
      "spark",
      "duckdb"
    ]
  },
  "destination": {
    "config": "{\"host\":\"localhost\",\"port\":5432}",
    "id": 1,
    "name": "my-postgres-source",
    "type": "postgres",
    "version": "v0.2.7"
  },
  "difference_streams": "[]",
  "frequency": "0 */12 * * *",
  "name": "my-sync-job-updated",
  "source": {
    "config": "{\"host\":\"localhost\",\"port\":5432}",
    "id": 1,
    "name": "my-postgres-source",
    "type": "postgres",
    "version": "v0.2.7"
  }
}

Response

job updated successfully

Changes

  • f1bcf21b1556Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 8881928f860bRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status