This alert informs users of a new jobDelete API now available in Operations Manager in the IP/2023.2.3 release.
Itential Platform Supports Deletion of Historical Jobs Data
As jobs collect in an Itential Platform 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
Figure 2: Confirm Delete Job
Figure 3: Successful Job Deletion
Please contact the Product Support Team if you require more information or need additional support when deleting jobs.