Solved

Kill Jobs Through REST API

  • 2 February 2023
  • 2 replies
  • 119 views

Badge +1

I am attempting to kill jobs that are running for a client through the REST API using by first getting the jobs from this URL…

http://WebConsoleHostName/webconsole/api/Jobs [Documentation here]

and finding the jobs by client Id and then running a POST to the following URL with the job IDs of that are associate with the client id I am looking to kill jobs for…

http://WebConsoleHostName/webconsole/api/Job/{{jobId}}/action/kill [Documentation here]

The problem is that the job ids from the first REST call do not show up on any of the jobs in the Job Controller window in the GUI. If I take the job ids from the GUI and run the kill action on them it will kill them but the problem is I don’t know how to get the correct job IDs in the first place since the /api/Jobs URL is not returning the Job Ids I need.

Are the job details for jobs that show up in the Job controller located somewhere other than at the /api/Jobs endpoint?

 

icon

Best answer by Chuck Graves 2 February 2023, 19:47

View original

2 replies

Userlevel 2
Badge +3

Hello @dgberrid,

 

Thank you for reaching out! I ran through some testing in my lab environment but seemed to hit a wall when trying the following (client ID: 3 in my example):

 

http://WebConsoleHostName/webconsole/api/Job?clientId=3&jobFilter=Backup

 

 

This could be user error on my part but are you retrieving jobs at all using the REST API mentioned above?

 

Can you try running this one and see if this returns all active jobs?

 

http://WebConsoleHostName/webconsole/api/Job?jobCategory=Active

 

Worst case scenario, you can always open a support case for us to dig into this issue further.

 

-- Chuck

Badge +1

@Chuck Graves Adding the  jobCategory=Active to the URL worked. Apparently, the the API only returns completed jobs if you don’t explicitly tell it to return Active ones. 

Reply