Help Topics

Get Fleet Topology
Returns a snapshot of this install's own view of the fleet -- whether it's the master, the master's address, and which peers it knows about. Thi...
Thu, Sep 17, 2026 at 1:24 PM
Parse a Job Import Script
Parses SQL Server Agent job script (the exact T-SQL SSMS's "Script Job as -> CREATE To" produces) and returns a preview of what it found --...
Thu, Sep 17, 2026 at 1:24 PM
Commit a Job Import
Actually creates jobs, steps, and schedules from a previously-parsed import. Parse never persists anything -- this is the one call that does. Every step nee...
Thu, Sep 17, 2026 at 1:24 PM
Request a Job Import Scan
Asks the Worker to connect to a live SQL Server's msdb and pull its SQL Server Agent jobs as script text -- an alternative to pasting the script yoursel...
Thu, Sep 17, 2026 at 1:24 PM
Browse an SSIS Catalog
Looks up the folders, projects, or packages deployed to a target server's SSIS catalog (SSISDB) -- so you can populate an SSIS Package step (see Create ...
Thu, Sep 17, 2026 at 1:25 PM
List Alert Channels
Returns every alert channel -- an email (via Database Mail or SMTP) or a webhook (Slack, Teams, or a generic URL) that an alert rule can notify. One flat re...
Thu, Sep 17, 2026 at 1:23 PM
Create an Alert Channel
Creates a channel an alert rule can notify -- a webhook (Slack, Teams, or a generic URL) or an email (via SQL Server Database Mail or your own SMTP relay). ...
Thu, Sep 17, 2026 at 1:23 PM
Delete / Reassign an Alert Channel
Deletes a channel -- but only once nothing still uses it. If alert rules still point at it, check what's using it and either reassign those rules to a d...
Thu, Sep 17, 2026 at 1:23 PM
Test an Alert Channel
Sends a real alert through a channel -- this isn't a dry-run preview, it enqueues an actual send the same way a real alert rule firing would. Use it to ...
Thu, Sep 17, 2026 at 1:23 PM
Manage Alert Rules
An alert rule ties one job or one step (never both -- there are separate endpoints for each) to a run status (like Failed or Succeeded), a channel to notify...
Thu, Sep 17, 2026 at 1:23 PM