AIairbytehq
public_jobs
public
Jobs

Trigger a sync or reset job of a connection

Changed on
post/jobs

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/jobs
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

Request body

connectionIdstring UUID required
jobType'sync' | 'reset' | 'refresh' | 'clear' required

Enum that describes the different types of jobs that the platform runs.

Example request

{
  "connectionId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
  "jobType": "sync"
}

Response

Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for.

jobIdinteger required
status'pending' | 'queued' | 'running' | 'incomplete' | 'failed' | 'succeeded' | 'cancelled' required
jobType'sync' | 'reset' | 'refresh' | 'clear' required

Enum that describes the different types of jobs that the platform runs.

startTimestring required
connectionIdstring UUID required
lastUpdatedAtstring
durationstring

Duration of a sync in ISO_8601 format

bytesSyncedinteger
rowsSyncedinteger

Example response

{
  "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
  "status": "running",
  "jobType": "sync",
  "startTime": "2023-03-25T01:30:50Z",
  "duration": "PT8H6M12S"
}

Changes