Reference for calling Minion Agent's own Api directly from your own code -- the Console and Worker use these exact same endpoints, nothing about them is special or internal-only.
New to this? Start with Calling the API From Your Own Code for how to sign in and the X-App-Name requirement every call has to meet. API Response Codes explains every status code you'll see back, in one place, so each page below doesn't repeat it.
Having trouble reaching the API, or logging in from another machine? See Network Access & Authentication Security -- by default the Api only answers
localhost, and PowerShell needs an extra flag once it does answer elsewhere.
Every category below is now fully written. Job Steps still has a handful of niche bonus endpoints called out individually as *not yet written* -- everything else is complete.
Jobs
- List Jobs
- Get a Job by Name
- Get a Job
- Create a Job
- Set a Job Active or Inactive
- Update a Job's Contact Info
- Rename a Job / Change Its Description
- Promote a Job to Global
- Move a Job to a Folder
- Delete a Job
- List Deleted Jobs
- Restore a Job
- Empty the Trash
- Run a Job
- Check a Job Run's Status
- Cancel a Job Run
Job Steps
- List a Job's Steps
- Create a Job Step
- Update a Step
- (There's no Delete a Step -- confirmed no such endpoint exists; steps are never removed once created, only replaced by editing a job version.)
- Set Step Dependencies (add/remove)
- Set a Step's Credential
- Set a Step's Target Server
- Run a Step Ad Hoc
- Step Comments (list/add)
- Set a Step's Parent (pool membership) -- not yet written
- Update a Step's Success/Failure Actions -- not yet written
- Promote a Step to Global -- not yet written
- Tag a Step -- not yet written
- Step Run History -- not yet written
- Step Gates -- not yet written
- Step Alert Rules -- see Manage Alert Rules, which covers both job- and step-scoped rules
Folders & Tags
- List Folders
- Create a Folder
- (No Rename, Move, or Delete for a folder -- confirmed no such endpoints exist anywhere in the API today.)
- List Tags
- Update a Tag's Color
- (No standalone Create Tag, Delete Tag, or folder-level tagging -- confirmed absent. Tags are created automatically the first time you tag something.)
- Tag a Job
- Tag a Job Step
- (No Untag for a job or step -- confirmed no such endpoint exists.)
- What a Tag Applies To
- (A job's/step's own effective + inherited tags are embedded in Get a Job / List a Job's Steps, not a separate call. A folder's own effective tags aren't exposed by any endpoint.)
Target Servers
- List Target Servers
- Register a Target Server
- Activate / Deactivate a Target Server
- (No Get-by-id, Update, or Delete for a target server -- confirmed no such endpoints exist. Active/Inactive is the only lifecycle control.)
Credentials
- List Credentials
- Create a Credential
- Update a Credential
- Set a Credential's Elevated Flag
- Request an Elevated Role Scan
- (No Get-a-single-credential and no Delete -- confirmed no such endpoints exist. Filter the list client-side for one credential; there's no deactivate/delete lifecycle for a credential today, unlike a target server.)
Roles & Permissions
- List Roles
- Create / Delete a Role
- List All Permission Keys
- Set a Role's Fleet-Wide Permissions
- Grant a Scoped Permission (to one server/folder/job/step)
- Manage Role Membership
- Check Effective Permissions
- Get a User's Permission Report
Job Sync (Fleet)
Configuration only today -- there's no "sync now" or push-to-peer call anywhere in the API. Registering peers, grouping them, and opting a job in just records the intent; see Manage Job Sync Groups for the exact caveat.
- Manage Sync Peers (list/register/update/remove)
- Manage Job Sync Groups (list/create/delete)
- Manage Job Sync Group Membership (add/remove a peer)
- Get / Set a Job's Sync Config
- Get Fleet Topology
Job Import
- Parse a Job Import Script
- Commit a Job Import
- Request a Job Import Scan (pull the script from a live server instead of pasting it)
SSIS Catalog
Alerts
- List Alert Channels (+ the webhook-app/SMTP-provider catalog)
- Create an Alert Channel
- Delete / Reassign an Alert Channel
- Test an Alert Channel (a real send, not a preview)
- Manage Alert Rules
- Manage Message Styles
- Manage Alert Schedules
- (No update for a channel -- confirmed no such endpoint exists. Delete and recreate it instead.)
Diagnostics & Support
- Download This Server's Support Bundle
- Request a Fleet Support Bundle (this server + every active sync peer)
- (Click-trace has no API surface -- it's a Console-only, in-process toggle. No health/ping, version, or log-level endpoint exists either.)
Security & Audit
- List Audit Events
- Manage App Accounts (list/create/delete, plus self-lookup)
- Set / Remove a User's Password
- Enable / Disable a User
- (No get-single-audit-event, no logout, and no session-listing endpoint -- confirmed none of these exist. See Manage Role Membership for assigning roles to an account, and command-blacklist for the separate blacklist-phrase feature, also gated in this same area.)
Authentication
- Sign In (App Account) -- see Calling the API From Your Own Code