/job_monitoring
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /job_monitoring | Get the job summary for protection and recovery jobs that are currently running, scheduled to run, or completed in the past 24 hours. | query reportData | Available |
| GET /job_monitoring/csv_download_link | Download the job summary for protection and recovery jobs that are currently running, scheduled to run, or completed in the past 24 hours as a CSV file. This is a synchronous operation. | mutation downloadReportCSVAsync | Available |
| GET /job_monitoring/subscription | Return all unarchived email subscriptions for monitoring page in a list of summaries sorted by creation time (earliest created first). Each summary contains information for each subscription: Time attributes - when to send the email, Email addresses - who to send the email, Attachments - what attachments should the email include, Job states - which job states to include in the email (Failure, Scheduled, Success, Active, Canceled), Id - the string that identifies the subscription, Status - the status of the subscription (Active, Suspended, or Unknown), Owner - information about the owner of the subscription, user id - unique ID used to identify the owner, user name - human-readable name of user, and the time schedule to send the subscription. | Available | |
| POST /job_monitoring/subscription | Creates an email subscription to the job monitoring page, which provides information on jobs based on their type (active, in progress, canceled, scheduled, or succeeded). Users can choose which job states to include in the subscription. The email summarizes the job counts by type in the body, and includes the option to include CSV attachments for every job state selected. | Restricted | |
| GET /job_monitoring/subscription/{subscription_id} | Returns a summary of the provided monitoring subscription. | Available | |
| PATCH /job_monitoring/subscription/{subscription_id} | Updates the monitoring email subscription with the subscription ID provided. | Restricted | |
| DELETE /job_monitoring/subscription/{subscription_id} | Deletes the specified monitoring page email subscription. | Restricted | |
| GET /job_monitoring/summary_by_job_state | Get job summary separated by job state for all running jobs, jobs that have been scheduled and jobs that are complete, for protection and recovery jobs in the past 24 hours. | query reportData | Available |
| GET /job_monitoring/summary_by_job_type | Get job summaries for protection and recovery jobs, separated by job type, that have been scheduled, are currently running, or completed in the past 24 hours. | query reportData | Available |