New Job Delete API Added to Ops Manager
  • 02 Jul 2024
  • Dark
    Light
  • PDF

New Job Delete API Added to Ops Manager

  • Dark
    Light
  • PDF

Article summary

This alert informs users of a new jobDelete API now available in Operations Manager for the 2023.2.3 release.

IAP Supports Deletion of Historical Jobs Data

As jobs collect in an IAP deployment, there is oftentimes a need to periodically delete them. This operation now takes place from the Operations (Ops) Manager jobs-list interface and supports deletion of historical jobs data by id.

Job Delete API

To support deletion of jobs data, two new API endpoints were added to app-operations_manager to delete job artifacts from the database along with all of the job-related documents, including tasks documents, variables, and data stored in GridFS.

DELETE can only delete jobs that are completed or cancelled.

DELETE /operations-manager/jobs/:jobId

POST is for batch deletes accepting a payload of jobIds: ['id1', 'id2', ...]

POST /operations-manager/jobs/delete

The API response includes the status for each job id (deleted, ignored) with a 200 status code.

Delete Jobs in Ops Manager

Updates made to the Ops Manager interface include a new delete button in the Jobs table, and the ability to delete when viewing job details, all of which utilizes the new jobDelete APIs.

Also see: Jobs in Ops Manager

Figure 1: Delete Job Button
01-deleteJob

Figure 2: Confirm Delete Job
02_deleteJob

Figure 3: Successful Job Deletion
03-deleteJob

Please contact the Product Support Team if you require more information or need additional support when deleting jobs.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.