Job Interface

Fetch job attributes on SYSTEM job group

GET/api/v6.3.5.1/hubs/{hub}/job_system/attributes

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `attr *: { 'arg1' : 'arg2' ?: }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist
Required permissions	read access on hub

Delete job attribute on SYSTEM job group

DELETE/api/v6.3.5.1/hubs/{hub}/job_system/attributes/{attr}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist or attribute is not set
Required permissions	write_channels access on hub
Events	Creates the following event: Job_System_Attribute_Delete `attr : { 'arg1' : 'arg2' ?: }`

Assign job attribute on SYSTEM job group

PUT/api/v6.3.5.1/hubs/{hub}/job_system/attributes/{attr}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'arg1' : 'arg2' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist
Required permissions	write_channels access on hub
Events	Creates one or more of the following events: Job_System_Attribute_Add `attr : { 'arg1' : 'arg2' ?: }` Job_System_Attribute_Change `'attr' : 'args_after' : { 'arg1' : 'arg2' ?: } 'args_before' : { 'arg1' : 'arg2' ?: }`

Fetch 'set' job attribute on SYSTEM job group

GET/api/v6.3.5.1/hubs/{hub}/job_system/env_vars

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `envvar *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist
Required permissions	read access on hub

Delete 'set' job attribute on SYSTEM job group

DELETE/api/v6.3.5.1/hubs/{hub}/job_system/env_vars/{var}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist or environment variable is not set
Required permissions	write_channels access on hub
Events	Creates the following event: Job_System_Envvar_Delete `'envvar' :`

Assign 'set' job attribute on SYSTEM job group

PUT/api/v6.3.5.1/hubs/{hub}/job_system/env_vars/{var}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'value' :`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist
Required permissions	write_channels access on hub
Events	Creates one or more of the following events: Job_System_Envvar_Add `'envvar' :` Job_System_Envvar_Change `'envvar' :`

Fetch job(s)

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

Query parameters	Prototype: `'channel' ?: ( + ) 'job' ?: ( + ) 'updated_jobs_since' ?: 'updated_err_since' ?: 'fetch' ?: 'latency'`
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' ?: 'latency' ?: secs 'next_run' ?: }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	read access on hub

Delete job

DELETE/api/v6.3.5.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	exec_jobs access on hub
Events	Creates the following event: Job_Delete `'jobs' : ( + ) 'canceled_ev_ids' ?: ( * )`

Fetch job attributes

GET/api/v6.3.5.1/hubs/{hub}/jobs/{job}/attributes

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `attr *: { 'arg1' : 'arg2' ?: }`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub does not exist
Required permissions	read access on hub

Delete job attribute

DELETE/api/v6.3.5.1/hubs/{hub}/jobs/{job}/attributes/{attr}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or job does not exist or attribute is not set
Required permissions	exec_jobs access on hub
Events	Creates the following event: Job_Attribute_Delete `'job' : attr : { 'arg1' : 'arg2' ?: }`

Assign job attribute

PUT/api/v6.3.5.1/hubs/{hub}/jobs/{job}/attributes/{attr}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'arg1' : 'arg2' ?:`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or job does not exist
Required permissions	exec_jobs access on hub
Events	Creates one or more of the following events: Job_Attribute_Add `'job' : attr : { 'arg1' : 'arg2' ?: }` Job_Attribute_Change `'job' : 'attr' : 'args_after' : { 'arg1' : 'arg2' ?: } 'args_before' : { 'arg1' : 'arg2' ?: }`

Fetch 'set' job attribute

GET/api/v6.3.5.1/hubs/{hub}/jobs/{job}/env_vars

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `envvar *: value`
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: Hub or job does not exist
Required permissions	read access on hub

Delete 'set' job attribute

DELETE/api/v6.3.5.1/hubs/{hub}/jobs/{job}/env_vars/{var}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or job does not exist or environment variable is not set
Required permissions	write_channels access on hub
Events	Creates the following event: Job_Envvar_Delete `'job' : 'envvar' :`

Assign 'set' job attribute

PUT/api/v6.3.5.1/hubs/{hub}/jobs/{job}/env_vars/{var}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'value' :`
Response headers	None
Response body	None
Status codes	✅ 204 No Content ❌ 400 Bad Request ❌ 404 Not Found: Hub or job does not exist
Required permissions	write_channels access on hub
Events	Creates one or more of the following events: Job_Envvar_Add `'job' : 'envvar' :` Job_Envvar_Change `'job' : 'envvar' :`

Delete jobs

POST/api/v6.3.5.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	exec_jobs access on hub
Events	Creates the following event: Job_Delete `'jobs' : ( + ) 'canceled_ev_ids' ?: ( * )`

Start jobs

POST/api/v6.3.5.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	exec_jobs access on hub
Events	Creates the following event: Job_Start `'jobs' : ( + )`

Suspend jobs

POST/api/v6.3.5.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	exec_jobs access on hub
Events	Creates the following event: Job_Suspend `'jobs' : ( + )`

Unsuspend jobs

POST/api/v6.3.5.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	exec_jobs access on hub
Events	Creates the following event: Job_Unsuspend `'jobs' : ( + )`