Fivetran documentation

Search the docs

/

Job Interface

Fetch job(s)

GET/api/v6.1/hubs/{hub}/jobs

Query parameters	Prototype: `'channel' ?: ( + ) 'job' ?: ( + ) 'updated_jobs_since' ?: 'updated_err_since' ?:`
Request headers	None
Request body	None
Response headers	Prototype: `X-Hvr-Err-Last-Updated : X-Hvr-Jobs-Last-Updated : X-Hvr-Schederr-Last-Updated : X-Hvr-Reload-Cache :`
Response body (JSON)	Prototype: `job *: { 'state' : 'num_retries' ?: 'log_job_err_tstamp' ?: }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	ReadOnly access level on hub

Delete job

DELETE/api/v6.1/hubs/{hub}/jobs/{job}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'canceled_ev_ids' ?: ( * )`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Job does not exist
Required permissions	ReadExec access level on hub
Events	Creates the following event Job_Delete `'jobs' : ( + ) 'canceled_ev_ids' ?: ( * )`

Delete jobs

POST/api/v6.1/hubs/{hub}/jobs_delete

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'jobs' : ( name+ )`
Response headers	None
Response body (JSON)	Prototype: `'canceled_ev_ids' ?: ( * )`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Job does not exist
Required permissions	ReadExec access level on hub
Events	Creates the following event Job_Delete `'jobs' : ( + ) 'canceled_ev_ids' ?: ( * )`

Start jobs

POST/api/v6.1/hubs/{hub}/jobs_start

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'jobs' : ( name+ ) 'unsuspend' ?: 'trigger_failed' ?:`
Response headers	None
Response body (JSON)	Prototype: `job *: { 'trigger_ctrl_id' ?: ctrl_id 'not_started' ?: reason }`
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Job does not exist
Required permissions	ReadExec access level on hub
Events	Creates the following event Job_Start `'jobs' : ( + )`

Suspend jobs

POST/api/v6.1/hubs/{hub}/jobs_suspend

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'jobs' : ( name+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Job does not exist
Required permissions	ReadExec access level on hub
Events	Creates the following event Job_Suspend `'jobs' : ( + )`

Unsuspend jobs

POST/api/v6.1/hubs/{hub}/jobs_unsuspend

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'jobs' : ( name+ )`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Job does not exist
Required permissions	ReadExec access level on hub
Events	Creates the following event Job_Unsuspend `'jobs' : ( + )`

Thanks for your feedback!

Was this page helpful?