read thedocs.

[ docs // guides & reference ]

Connector setup guides, tool references, auth flows, and platform concepts — everything you need to run StackJack, in one place.

Browse the Docs All Connectors

34 connectors documented // 6,712 tools referenced // setup, auth & platform guides

↓

No pages match that search. Clear it

← All documentation

ImmyBot Tools

immy_ · 555 tools · Free 264 · Pro 291 App-only OAuth2 client-credentials against the CUSTOMER'S Microsoft Entra ID (login.microsoftonline.com/, scope /.default); the Azure Bearer token is used directly against https://.immy.bot/ with no ImmyBot-native token exchange and NO refresh token (fresh mint on expiry); four credential components (Azure app client id + secret, Azure tenant id/domain, instance URL); host-only BaseAddress so every path is full (api/v1/…, plus a few host-rooted plugins/auth paths); mixed pagination — Sieve Page/pageSize/Filters/Sorts on list endpoints, DevExtreme skip/take on /dx grid feeds (page size capped at 100); POST is verb-overloaded (many RPC-style reads); raw JSON passthrough except the 4 XLSX /export tools, which return SAS URLs to blob-stored spreadsheets.

Computers

Tool	Plan	Access	Description
`immy_add_tags_to_computers`	Pro	Write	[ImmyBot] Add one or more tags to a set of computers (bulk). Body typically carries the computer ids and the tag ids to apply. Tag ids come from immy_list_tags; computer ids from immy_list_computers.
`immy_bulk_delete_computers`	Pro	Destructive	[ImmyBot] Permanently delete multiple computers (bulk). DESTRUCTIVE — removes the computer records; recover with immy_computers_restore only where ImmyBot supports soft-delete. Body carries the list of computer ids to delete (from immy_list_computers).
`immy_computers_change_tenant`	Pro	Write	[ImmyBot] Move one or more computers to a different tenant. Body carries the computer ids and the destination tenant id (from immy_list_tenants). This reassigns which customer the endpoints belong to.
`immy_computers_exclude_from_maintenance`	Pro	Write	[ImmyBot] Exclude a computer from maintenance (it will be skipped by maintenance sessions). computerId comes from immy_list_computers. Body carries the exclusion options (e.g. reason/duration) as ImmyBot's schema allows; pass for defaults.
`immy_computers_notes`	Pro	Write	[ImmyBot] Set/update the notes on a computer. computerId comes from immy_list_computers. Body carries the notes payload (e.g. {"notes":"..."}).
`immy_computers_reinventory`	Pro	Write	[ImmyBot] Trigger a reinventory of a computer (re-collect its software/inventory data). computerId comes from immy_list_computers. This action takes no options — pass for the body.
`immy_computers_restore`	Pro	Write	[ImmyBot] Restore previously (soft-)deleted computers. Body is a JSON array of the computer ids to restore. Counterpart of immy_bulk_delete_computers.
`immy_computers_set_to_needs_onboarding`	Pro	Write	[ImmyBot] Flag a computer as needing onboarding (re-enters the onboarding pipeline). computerId comes from immy_list_computers. This action takes no options — pass for the body. Inverse of immy_computers_skip_onboarding.
`immy_computers_skip_onboarding`	Pro	Write	[ImmyBot] Mark computers to skip onboarding. Body is a JSON array of skip-onboarding requests (each identifying a computer and its skip options). See immy_list_computers_onboarding for the onboarding queue and immy_computers_set_to_needs_onboarding for the inverse.
`immy_computers_update_additional_persons`	Pro	Write	[ImmyBot] Update the additional (secondary) persons associated with a computer. computerId comes from immy_list_computers; person ids from immy_list_persons. Body carries the additional-person assignments. See also immy_computers_update_primary_person.
`immy_computers_update_primary_person`	Pro	Write	[ImmyBot] Update the primary person associated with a computer (its main user). computerId comes from immy_list_computers; person id from immy_list_persons. Body carries the primary-person assignment. See also immy_computers_update_additional_persons.
`immy_get_computers`	Free	Read-only	[ImmyBot] Get a single computer by id, including its default detail (sessions, primary/additional persons and provider-agent data as ImmyBot resolves them). computerId comes from immy_list_computers / immy_list_computers_paged.
`immy_list_computers`	Free	Read-only	[ImmyBot] List managed computers (basic view). Only pageSize is supported here (capped at 100). For server-side filtering, sorting or paging use immy_list_computers_paged or immy_list_computers_dx; for per-computer detail use immy_get_computers.
`immy_list_computers_agent_status`	Free	Read-only	[ImmyBot] List computers with their agent connectivity/health status (DevExtreme grid feed). filters/sorts use DevExtreme syntax: filters is a JSON filter array (e.g. ["name","contains","srv"]) and sorts a JSON sort array (e.g. [{"selector":"name","desc":false}]). pageSize is capped at 100. See also immy_list_computers_status for a single computer.
`immy_list_computers_device_update_form_data`	Free	Read-only	[ImmyBot] Get the device-update form data for a computer (the fields/options used to drive a device update). computerId comes from immy_list_computers.
`immy_list_computers_dx`	Free	Read-only	[ImmyBot] List computers via the raw DevExtreme grid feed. Accepts native DevExtreme load options: skip, take (capped at 100), filter (JSON filter array string) and sort (JSON sort array string). Set requireTotalCount=true to include the total row count in the response.
`immy_list_computers_events`	Free	Read-only	[ImmyBot] List the event history for a computer. The endpoint pages via skip/take only (no server-side filter/sort); page/pageSize are mapped onto them and pageSize is capped at 100. computerId comes from immy_list_computers.
`immy_list_computers_export`	Free	Read-only	[ImmyBot] Export the computers grid to an XLSX spreadsheet. The binary is uploaded to StackJack blob storage and returned as a short-lived (~15 minute) read-only SAS URL envelope {sasUrl, contentType, suggestedFilename, sizeBytes, expiresAt} — fetch the file from sasUrl within the window; do NOT decode the URL as content. filters/sorts use DevExtreme syntax.
`immy_list_computers_my`	Free	Read-only	[ImmyBot] List the computers scoped to the calling identity/session. Takes no parameters. For the full tenant inventory use immy_list_computers or immy_list_computers_paged.
`immy_list_computers_onboarding`	Free	Read-only	[ImmyBot] List computers currently in the onboarding pipeline (awaiting or undergoing onboarding). Takes no parameters. Related actions: immy_computers_skip_onboarding, immy_computers_set_to_needs_onboarding.
`immy_list_computers_paged`	Free	Read-only	[ImmyBot] List computers with DevExtreme server-side paging, filtering and sorting — the richer counterpart to immy_list_computers. filter/sort use DevExtreme syntax (JSON array strings). pageSize is capped at 100. Some vendor convenience boolean flags (staleOnly, onboardingOnly, orphanedOnly and similar) are not exposed by this tool; express the equivalent constraint through the DevExtreme filter instead.
`immy_list_computers_parent_tenant_info`	Free	Read-only	[ImmyBot] Get the parent-tenant information for a computer (the tenant hierarchy context the computer belongs to). computerId comes from immy_list_computers.
`immy_list_computers_status`	Free	Read-only	[ImmyBot] Get the current status of a single computer (online/agent/maintenance state). computerId comes from immy_list_computers. For a fleet-wide view use immy_list_computers_agent_status.
`immy_remove_tags_from_computers`	Pro	Write	[ImmyBot] Remove one or more tags from a set of computers (bulk). Body carries the computer ids and the tag ids to remove. Counterpart of immy_add_tags_to_computers.
`immy_resolve_computer_onboarding_target_assignments`	Free	Read-only	[ImmyBot] Resolve the onboarding target-assignments (deployments) that can be overridden for a computer — a preview used before onboarding. computerId comes from immy_list_computers. Read-only.
`immy_update_computers`	Pro	Write	[ImmyBot] Update a computer (PUT). computerId comes from immy_list_computers. Body is the computer object with the fields to change (e.g. name, notes, tenant assignment as ImmyBot's schema allows).

immy_add_tags_to_computers parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the target computer ids and tag ids to add.

immy_bulk_delete_computers parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object/array identifying the computer ids to delete.

immy_computers_change_tenant parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the computer ids and destination tenant id.

immy_computers_exclude_from_maintenance parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	JSON object with the exclusion options. Pass for defaults.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_notes parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the notes to set.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_reinventory parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON body. This action takes no options — pass (the default).
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_restore parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON array of computer ids to restore.

immy_computers_set_to_needs_onboarding parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON body. This action takes no options — pass (the default).
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_skip_onboarding parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON array of skip-onboarding requests.

immy_computers_update_additional_persons parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the additional-person assignments.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_update_primary_person parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the primary-person assignment.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_get_computers parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers parameters

Param	Type	Required	Default	Description
`pageSize`	integer	no	null	Optional. Max rows to return (1-100). Defaults to the ImmyBot server default.

immy_list_computers_agent_status parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`page`	integer	no	null	Optional. 1-based page number (mapped to DevExtreme skip).
`pageSize`	integer	no	null	Optional. Rows per page, 1-100 (DevExtreme take).
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_device_update_form_data parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`requireTotalCount`	boolean	no	null	Optional. Set true to include a total row count.
`skip`	integer	no	null	Optional. Rows to skip (DevExtreme offset).
`sort`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.
`take`	integer	no	null	Optional. Rows to take, 1-100.

immy_list_computers_events parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).
`page`	integer	no	null	Optional. 1-based page number (mapped to skip).
`pageSize`	integer	no	null	Optional. Rows per page, 1-100 (take).

immy_list_computers_export parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_paged parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`page`	integer	no	null	Optional. 1-based page number (mapped to DevExtreme skip).
`pageSize`	integer	no	null	Optional. Rows per page, 1-100 (DevExtreme take).
`sort`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_parent_tenant_info parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_status parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_remove_tags_from_computers parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the target computer ids and tag ids to remove.

immy_resolve_computer_onboarding_target_assignments parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_update_computers parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id to update (from immy_list_computers).
`fieldsJson`	string	yes		JSON object with the computer fields to update.

Computer Inventory

Tool	Plan	Access	Description
`immy_computers_exclude_from_user_affinity`	Pro	Write	[ImmyBot] Exclude a single computer from user-affinity tracking. computerId comes from immy_list_computers. Pass for the body unless ImmyBot expects exclusion options. For a bulk operation use immy_computers_set_excluded_from_user_affinity.
`immy_computers_set_excluded_from_user_affinity`	Pro	Write	[ImmyBot] Bulk set whether a set of computers are excluded from user-affinity tracking. Body carries the computer ids and the excluded flag. For a single computer use immy_computers_exclude_from_user_affinity.
`immy_get_computers_inventory_script_results`	Free	Read-only	[ImmyBot] Get the results of a specific inventory script for a computer, keyed by inventoryKey. computerId comes from immy_list_computers; inventoryKey identifies which inventory-task/script's output to return.
`immy_list_computers_detected_computer_software`	Free	Read-only	[ImmyBot] List the detected (installed) software for a single computer. computerId comes from immy_list_computers. Returns the full detected-software set (no server-side paging).
`immy_list_computers_inventory`	Free	Read-only	[ImmyBot] List the collected computer inventory (DevExtreme grid feed). filters/sorts use DevExtreme syntax (JSON array strings); pageSize is capped at 100. For a single computer's detected software use immy_list_computers_detected_computer_software.
`immy_list_computers_inventory_export`	Free	Read-only	[ImmyBot] Export the computer-inventory grid to an XLSX spreadsheet. Returns a short-lived (~15 minute) read-only SAS URL envelope {sasUrl, contentType, suggestedFilename, sizeBytes, expiresAt} — fetch the file from sasUrl within the window; do NOT decode the URL as content. filters/sorts use DevExtreme syntax.
`immy_list_computers_inventory_software_search_by_name`	Free	Read-only	[ImmyBot] Search the software inventory across computers by (partial) product name. Returns matching installed-software records. Use immy_list_computers_inventory_software_search_by_upgrade_code to search by MSI upgrade code instead.
`immy_list_computers_inventory_software_search_by_upgrade_code`	Free	Read-only	[ImmyBot] Search the software inventory across computers by MSI upgrade code. Returns matching installed-software records. Use immy_list_computers_inventory_software_search_by_name to search by product name instead.
`immy_list_computers_user_affinities`	Free	Read-only	[ImmyBot] List computer↔user affinities (which persons are associated with which computers, inferred from usage). DevExtreme grid feed — filters/sorts use DevExtreme syntax (JSON array strings); pageSize is capped at 100.
`immy_list_computers_user_affinities_export`	Free	Read-only	[ImmyBot] Export the computer user-affinity grid to an XLSX spreadsheet. Returns a short-lived (~15 minute) read-only SAS URL envelope {sasUrl, contentType, suggestedFilename, sizeBytes, expiresAt} — fetch the file from sasUrl within the window; do NOT decode the URL as content. filters/sorts use DevExtreme syntax.

immy_computers_exclude_from_user_affinity parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	JSON object with the exclusion options. Pass for defaults.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_set_excluded_from_user_affinity parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the computer ids and the excluded flag.

immy_get_computers_inventory_script_results parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).
`inventoryKey`	string	yes		Inventory key identifying which inventory script's results to return.

immy_list_computers_detected_computer_software parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_inventory parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`page`	integer	no	null	Optional. 1-based page number (mapped to DevExtreme skip).
`pageSize`	integer	no	null	Optional. Rows per page, 1-100 (DevExtreme take).
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_inventory_export parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_inventory_software_search_by_name parameters

Param	Type	Required	Default	Description
`name`	string	yes		Software name (or substring) to search for.

immy_list_computers_inventory_software_search_by_upgrade_code parameters

Param	Type	Required	Default	Description
`upgradeCode`	string	yes		MSI upgrade code (or substring) to search for.

immy_list_computers_user_affinities parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`page`	integer	no	null	Optional. 1-based page number (mapped to DevExtreme skip).
`pageSize`	integer	no	null	Optional. Rows per page, 1-100 (DevExtreme take).
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

immy_list_computers_user_affinities_export parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional. DevExtreme filter expression as a JSON array string.
`sorts`	string	no	null	Optional. DevExtreme sort expression as a JSON array string.

Computer Agents

Tool	Plan	Access	Description
`immy_computers_ephemeral_agent_circuit_breaker_reset`	Pro	Write	[ImmyBot] Reset the ephemeral-agent circuit breaker for a computer (clears the tripped state so agent launches are retried). computerId comes from immy_list_computers. This action takes no options — pass for the body. Inspect state first with immy_list_computers_ephemeral_agent_circuit_breaker.
`immy_computers_registry_keys`	Free	Read-only	[ImmyBot] Enumerate the registry sub-keys under a supplied path on a computer (read-only; POST is used to carry the query path). computerId comes from immy_list_computers. Body identifies the hive/path to enumerate (e.g. {"path":"HKLM:\SOFTWARE"}). Use immy_computers_registry_values to read the values within a key.
`immy_computers_registry_values`	Free	Read-only	[ImmyBot] Read the registry values under a supplied key on a computer (read-only; POST is used to carry the query key). computerId comes from immy_list_computers. Body identifies the hive/key to read (e.g. {"path":"HKLM:\SOFTWARE\..."}). Use immy_computers_registry_keys to list sub-keys first.
`immy_end_ephemeral_agent_session`	Pro	Destructive	[ImmyBot] End (terminate) the live ephemeral-agent session on a computer. DESTRUCTIVE — the active agent session is torn down immediately; any in-flight work on that session is interrupted. computerId comes from immy_list_computers. Launch a new session with immy_launch_ephemeral_agent.
`immy_launch_ephemeral_agent`	Pro	Write	[ImmyBot] Launch a short-lived ephemeral agent on a computer (an ACTION despite the GET verb — it establishes a live agent session, so it is NOT read-only). computerId comes from immy_list_computers. Check state with immy_list_computers_ephemeral_agent and tear down with immy_end_ephemeral_agent_session.
`immy_list_computers_ephemeral_agent`	Free	Read-only	[ImmyBot] Get the current ephemeral-agent state for a computer (whether a short-lived agent session is active and its details). computerId comes from immy_list_computers. Launch one with immy_launch_ephemeral_agent; end one with immy_end_ephemeral_agent_session.
`immy_list_computers_ephemeral_agent_circuit_breaker`	Free	Read-only	[ImmyBot] Get the ephemeral-agent circuit-breaker state for a computer (whether repeated agent-launch failures have tripped the breaker). computerId comes from immy_list_computers. Reset it with immy_computers_ephemeral_agent_circuit_breaker_reset.
`immy_list_computers_provider_links_screen_share_url`	Free	Read-only	[ImmyBot] Get the provider-link screen-share (remote-control) URL for a computer through a specific provider integration. computerId comes from immy_list_computers; providerLinkId identifies which linked RMM/tool provides the session.

immy_computers_ephemeral_agent_circuit_breaker_reset parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON body. This action takes no options — pass (the default).
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_registry_keys parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object identifying the registry hive/path to enumerate.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_computers_registry_values parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object identifying the registry hive/key whose values to read.
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_end_ephemeral_agent_session parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_launch_ephemeral_agent parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_ephemeral_agent parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_ephemeral_agent_circuit_breaker parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).

immy_list_computers_provider_links_screen_share_url parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		Computer id (from immy_list_computers).
`providerLinkId`	string	yes		Provider link id (which linked provider integration supplies the screen-share).

Software

Tool	Plan	Access	Description
`immy_delete_software_global`	Pro	Destructive	[ImmyBot] Delete a global software item by softwareIdentifier, including all its versions. Deployments (target-assignments) referencing it will break. Cannot be undone. Returns the raw ImmyBot result.
`immy_delete_software_local`	Pro	Destructive	[ImmyBot] Delete a local software item by softwareIdentifier, including all its versions. Deployments (target-assignments) referencing it will break. Cannot be undone. Returns the raw ImmyBot result.
`immy_get_software_global`	Free	Read-only	[ImmyBot] Get a single global software item by softwareIdentifier (from immy_list_software_global). Returns the raw ImmyBot software JSON. Use immy_list_software_global_versions for its version list.
`immy_get_software_local`	Free	Read-only	[ImmyBot] Get a single local software item by softwareIdentifier (from immy_list_software_local). Returns the raw ImmyBot software JSON. Use immy_list_software_local_versions for its version list.
`immy_list_software_global`	Free	Read-only	[ImmyBot] List global (shared/vendor-maintained) software items, optionally filtered with a Sieve `filters` expression. Global software is available to every tenant. Returns raw ImmyBot JSON. Use immy_get_software_global for one item, immy_list_software_global_versions for its versions, or immy_list_software_local for instance-authored software.
`immy_list_software_global_latest`	Free	Read-only	[ImmyBot] Get the latest version of a global software item by softwareIdentifier (from immy_list_software_global). Returns the raw ImmyBot version JSON for the newest version. Use immy_list_software_global_versions for the full history.
`immy_list_software_local`	Free	Read-only	[ImmyBot] List local (instance-authored) software items, optionally filtered with a Sieve `filters` expression. Local software is defined inside this ImmyBot instance and can be migrated to global. Returns raw ImmyBot JSON. Use immy_get_software_local for one item, or immy_list_software_global for shared software.
`immy_list_software_local_authorization`	Free	Read-only	[ImmyBot] Get the authorization (tenant/scope access) configuration for a local software item by softwareIdentifier. Shows which tenants may use it. Returns raw ImmyBot JSON. Use immy_software_local_authorization to change it.
`immy_list_software_local_latest`	Free	Read-only	[ImmyBot] Get the latest version of a local software item by softwareIdentifier (from immy_list_software_local). Returns the raw ImmyBot version JSON for the newest version. Use immy_list_software_local_versions for the full history.
`immy_list_software_local_migrate_local_to_global_what_if`	Free	Read-only	[ImmyBot] Preview (what-if) migrating a local software item to the global catalog by softwareIdentifier — reports what would change WITHOUT migrating. Run this before immy_software_local_migrate_local_to_global. Returns the raw ImmyBot preview JSON.
`immy_patch_software_global`	Pro	Write	[ImmyBot] Partially update a global software item by softwareIdentifier. Provide a JSON object body (fieldsJson) with only the fields to change (JSON merge-patch semantics). Returns the updated software JSON.
`immy_patch_software_local`	Pro	Write	[ImmyBot] Partially update a local software item by softwareIdentifier. Provide a JSON object body (fieldsJson) with only the fields to change (JSON merge-patch semantics). Returns the updated software JSON.
`immy_software_global`	Pro	Write	[ImmyBot] Create a global software item. Provide a JSON object body (fieldsJson) with the software definition (name, install/detection method, etc.). For a quick minimal create use immy_software_global_fast_create; to upload the installer binary use immy_software_global_upload; add versions with immy_create_global_software_version. Returns the created software JSON.
`immy_software_global_analyze`	Free	Read-only	[ImmyBot] Analyze a global software definition WITHOUT saving it — a read-only preview that returns detection/install evaluation for the supplied definition. Provide a JSON object body (fieldsJson) describing the software/version to analyze. POST is used only to carry the body; nothing is created. Returns the raw analysis JSON.
`immy_software_global_fast_create`	Pro	Write	[ImmyBot] Fast-create a global software item from a minimal definition (ImmyBot infers install/detection defaults). Provide a JSON object body (fieldsJson) — typically just name and package/source hints. Use immy_software_global for full control. Returns the created software JSON.
`immy_software_global_upload`	Pro	Write	[ImmyBot] Upload an installer binary for global software (multipart/form-data). Provide the file bytes base64-encoded (base64Content) and a fileName; the file is posted as the `file` form part. Returns the raw ImmyBot upload result JSON (reference the uploaded payload when creating a version with immy_create_global_software_version).
`immy_software_local`	Pro	Write	[ImmyBot] Create a local (instance-authored) software item. Provide a JSON object body (fieldsJson) with the software definition. For a quick minimal create use immy_software_local_fast_create; to upload the installer use immy_software_local_upload; add versions with immy_create_local_software_version. Returns the created software JSON.
`immy_software_local_analyze`	Free	Read-only	[ImmyBot] Analyze a local software definition WITHOUT saving it — a read-only preview returning detection/install evaluation for the supplied definition. Provide a JSON object body (fieldsJson). POST is used only to carry the body; nothing is created. Returns the raw analysis JSON.
`immy_software_local_authorization`	Pro	Write	[ImmyBot] Set the authorization (tenant/scope access) for a local software item by softwareIdentifier. Provide a JSON object body (fieldsJson) describing which tenants/scopes may use it. Read the current config first with immy_list_software_local_authorization. Returns the raw ImmyBot result.
`immy_software_local_fast_create`	Pro	Write	[ImmyBot] Fast-create a local software item from a minimal definition (ImmyBot infers install/detection defaults). Provide a JSON object body (fieldsJson) — typically just name and package/source hints. Use immy_software_local for full control. Returns the created software JSON.
`immy_software_local_migrate_local_to_global`	Pro	Write	[ImmyBot] Migrate a local software item to the global catalog by softwareIdentifier, making it shared across the instance. Preview the effect first with immy_list_software_local_migrate_local_to_global_what_if. The optional fieldsJson carries migration options (usually none — leave as ). Returns the raw ImmyBot result.
`immy_software_local_upload`	Pro	Write	[ImmyBot] Upload an installer binary for local software (multipart/form-data). Provide the file bytes base64-encoded (base64Content) and a fileName; the file is posted as the `file` form part. Returns the raw ImmyBot upload result JSON (reference the uploaded payload when creating a version with immy_create_local_software_version).

immy_delete_software_global parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The global software identifier to delete (from immy_list_software_global).

immy_delete_software_local parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The local software identifier to delete (from immy_list_software_local).

immy_get_software_global parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).

immy_get_software_local parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_list_software_global parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=Chrome". Omit for no filter.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`sorts`	string	no	null	Sieve sort expression (leading - = descending). Omit for default order.

immy_list_software_global_latest parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).

immy_list_software_local parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=Line-of-Business". Omit for no filter.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`sorts`	string	no	null	Sieve sort expression (leading - = descending). Omit for default order.

immy_list_software_local_authorization parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_list_software_local_latest parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_list_software_local_migrate_local_to_global_what_if parameters

Param	Type	Required	Default	Description
`softwareIdentifier`	string	yes		The local software identifier to preview migrating (from immy_list_software_local).

immy_patch_software_global parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with only the fields to change (partial update).
`softwareIdentifier`	string	yes		The global software identifier to update (from immy_list_software_global).

immy_patch_software_local parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with only the fields to change (partial update).
`softwareIdentifier`	string	yes		The local software identifier to update (from immy_list_software_local).

immy_software_global parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the global software item.

immy_software_global_analyze parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the global software/version definition to analyze.

immy_software_global_fast_create parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Minimal JSON object body (name and package/source hints).

immy_software_global_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The installer file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "setup.exe").

immy_software_local parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the local software item.

immy_software_local_analyze parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the local software/version definition to analyze.

immy_software_local_authorization parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the tenant/scope authorization.
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_software_local_fast_create parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Minimal JSON object body (name and package/source hints).

immy_software_local_migrate_local_to_global parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	Optional JSON object body with migration options. Leave as "" (default) when none are needed.
`softwareIdentifier`	string	yes		The local software identifier to migrate (from immy_list_software_local).

immy_software_local_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The installer file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "setup.msi").

Software Versions

Tool	Plan	Access	Description
`immy_create_global_software_version`	Pro	Write	[ImmyBot] Add a new version to a global software item (softwareIdentifier from immy_list_software_global). Provide a JSON object body (fieldsJson) with the semanticVersion, install/detection metadata, and payload reference. To upload the binary, use immy_software_global_upload. Returns the created version JSON.
`immy_create_local_software_version`	Pro	Write	[ImmyBot] Add a new version to a local software item (softwareIdentifier from immy_list_software_local). Provide a JSON object body (fieldsJson) with the semanticVersion, install/detection metadata, and payload reference. To upload the binary, use immy_software_local_upload. Returns the created version JSON.
`immy_delete_software_global_versions`	Pro	Destructive	[ImmyBot] Delete a version from a global software item (softwareIdentifier + semanticVersion). Deployments pinned to this version will no longer resolve. Cannot be undone. Returns the raw ImmyBot result.
`immy_delete_software_local_versions`	Pro	Destructive	[ImmyBot] Delete a version from a local software item (softwareIdentifier + semanticVersion). Deployments pinned to this version will no longer resolve. Cannot be undone. Returns the raw ImmyBot result.
`immy_get_software_global_versions`	Free	Read-only	[ImmyBot] Get a single global software version by softwareIdentifier + semanticVersion (both from immy_list_software_global_versions). Returns the raw ImmyBot version JSON, including install metadata.
`immy_get_software_local_versions`	Free	Read-only	[ImmyBot] Get a single local software version by softwareIdentifier + semanticVersion (both from immy_list_software_local_versions). Returns the raw ImmyBot version JSON, including install metadata.
`immy_list_software_global_versions`	Free	Read-only	[ImmyBot] List the versions of a global (shared/vendor) software item by its softwareIdentifier (from immy_list_software_global / immy_get_software_global). Returns raw ImmyBot JSON. Use immy_get_software_global_versions for one version, or immy_list_software_global_latest for the newest.
`immy_list_software_global_versions_request_download`	Free	Read-only	[ImmyBot] Request a download URL for a global software version's install payload by softwareIdentifier + semanticVersion. Returns a JSON body containing the URL string — a normal passthrough read, not a binary export. Fetch the URL out-of-band to retrieve the payload.
`immy_list_software_local_versions`	Free	Read-only	[ImmyBot] List the versions of a local (per-instance) software item by its softwareIdentifier (from immy_list_software_local / immy_get_software_local). Returns raw ImmyBot JSON. Use immy_get_software_local_versions for one version, or immy_list_software_local_latest for the newest.
`immy_list_software_local_versions_request_download`	Free	Read-only	[ImmyBot] Request a download URL for a local software version's install payload by softwareIdentifier + semanticVersion. Returns a JSON body containing the URL string — a normal passthrough read, not a binary export. Fetch the URL out-of-band to retrieve the payload.
`immy_patch_software_global_versions`	Pro	Write	[ImmyBot] Partially update a global software version (softwareIdentifier + semanticVersion). Provide a JSON object body (fieldsJson) with only the fields to change (JSON merge-patch semantics). Returns the updated version JSON.
`immy_patch_software_local_versions`	Pro	Write	[ImmyBot] Partially update a local software version (softwareIdentifier + semanticVersion). Provide a JSON object body (fieldsJson) with only the fields to change (JSON merge-patch semantics). Returns the updated version JSON.

immy_create_global_software_version parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new version (semanticVersion, install/detection metadata, payload reference).
`softwareIdentifier`	string	yes		The global software identifier to add a version to (from immy_list_software_global).

immy_create_local_software_version parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new version (semanticVersion, install/detection metadata, payload reference).
`softwareIdentifier`	string	yes		The local software identifier to add a version to (from immy_list_software_local).

immy_delete_software_global_versions parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version to delete (from immy_list_software_global_versions).
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).

immy_delete_software_local_versions parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version to delete (from immy_list_software_local_versions).
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_get_software_global_versions parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version, e.g. "119.0.6045.124" (from immy_list_software_global_versions).
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).

immy_get_software_local_versions parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version, e.g. "1.2.3" (from immy_list_software_local_versions).
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_list_software_global_versions parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).
`sorts`	string	no	null	Sieve sort expression (leading - = descending). Omit for default order.

immy_list_software_global_versions_request_download parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version whose payload URL to request (from immy_list_software_global_versions).
`softwareIdentifier`	string	yes		The global software identifier (from immy_list_software_global).

immy_list_software_local_versions parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).
`sorts`	string	no	null	Sieve sort expression (leading - = descending). Omit for default order.

immy_list_software_local_versions_request_download parameters

Param	Type	Required	Default	Description
`semanticVersion`	string	yes		The semantic version whose payload URL to request (from immy_list_software_local_versions).
`softwareIdentifier`	string	yes		The local software identifier (from immy_list_software_local).

immy_patch_software_global_versions parameters

Param	Type	Required	Description
`fieldsJson`	string	yes	JSON object body with only the fields to change (partial update).
`semanticVersion`	string	yes	The semantic version to update (from immy_list_software_global_versions).
`softwareIdentifier`	string	yes	The global software identifier (from immy_list_software_global).

immy_patch_software_local_versions parameters

Param	Type	Required	Description
`fieldsJson`	string	yes	JSON object body with only the fields to change (partial update).
`semanticVersion`	string	yes	The semantic version to update (from immy_list_software_local_versions).
`softwareIdentifier`	string	yes	The local software identifier (from immy_list_software_local).

Licenses

Tool	Plan	Access	Description
`immy_delete_licenses`	Pro	Destructive	[ImmyBot] Delete a software license by id (from immy_list_licenses). This permanently removes the license and its stored key/file; deployments that reference it will no longer activate. Cannot be undone. Returns the raw ImmyBot result.
`immy_get_licenses`	Free	Read-only	[ImmyBot] Get a single software license by id (from immy_list_licenses). Returns the raw ImmyBot license JSON. Use immy_list_licenses_request_download for a download URL to the license file, if any.
`immy_licenses`	Pro	Write	[ImmyBot] Create a software license. Provide a JSON object body (fieldsJson) — typically name, softwareId (from immy_list_software_global/immy_list_software_local), the license key/value, and any tenant/scope fields. To attach a license FILE, create the license then use immy_licenses_upload. Returns the created license JSON.
`immy_licenses_upload`	Pro	Write	[ImmyBot] Upload a license file (multipart/form-data). Provide the file bytes base64-encoded (base64Content) and a fileName. The file is decoded and posted as the `file` form part. Returns the raw ImmyBot upload result JSON. Pair with immy_licenses to bind the uploaded file to a license record.
`immy_list_chocolatey_find_packages_by_id`	Free	Read-only	[ImmyBot] Look up Chocolatey community-feed packages by exact package id (e.g. "googlechrome", "7zip"). Use this when authoring a Chocolatey-backed global/local software item to confirm the package id and available versions. Returns the raw Chocolatey search JSON. See immy_list_chocolatey_search for a fuzzy term search.
`immy_list_chocolatey_search`	Free	Read-only	[ImmyBot] Fuzzy-search the Chocolatey community feed by term (matches package id/title). Use this to discover the correct package id before authoring a Chocolatey-backed software item; then confirm with immy_list_chocolatey_find_packages_by_id. Returns the raw Chocolatey search JSON.
`immy_list_licenses`	Free	Read-only	[ImmyBot] List software licenses, optionally filtered with a Sieve `filters` expression (e.g. "name@=Adobe"). Each license binds an activation key/file to software applied during deployment. Returns raw ImmyBot JSON. Use immy_list_licenses_dx for the grid/DevExtreme feed, or immy_get_licenses for a single license.
`immy_list_licenses_dx`	Free	Read-only	[ImmyBot] DevExtreme grid feed for the licenses table (skip/take paging plus DevExtreme filter/sort). This backs the ImmyBot UI grid; prefer immy_list_licenses for straightforward listing. Returns the raw DevExtreme envelope {data, totalCount}.
`immy_list_licenses_request_download`	Free	Read-only	[ImmyBot] Request a download URL for a license's uploaded file by license id (from immy_list_licenses). Returns a JSON body containing the URL string — this is a normal passthrough read, not a binary export. Fetch the URL out-of-band to retrieve the file.
`immy_update_licenses`	Pro	Write	[ImmyBot] Update (full replace) a software license by id (from immy_list_licenses). Provide the complete JSON object body (fieldsJson) — omitted fields are cleared, so fetch with immy_get_licenses first and send the merged object. Returns the updated license JSON.

immy_delete_licenses parameters

Param	Type	Required	Default	Description
`licenseId`	string	yes		The license id to delete (from immy_list_licenses).

immy_get_licenses parameters

Param	Type	Required	Default	Description
`licenseId`	string	yes		The license id (from immy_list_licenses).

immy_licenses parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the license (name, softwareId, key, scope, …).

immy_licenses_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The license file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "office-license.lic").

immy_list_chocolatey_find_packages_by_id parameters

Param	Type	Required	Default	Description
`id`	string	no	null	Exact Chocolatey package id to look up (e.g. "googlechrome"). Omit to return the default result set.
`page`	integer	no	null	1-based page number for the Sieve page window. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).

immy_list_chocolatey_search parameters

Param	Type	Required	Default	Description
`page`	integer	no	null	1-based page number for the Sieve page window. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`query`	string	no	null	Free-text search term (matches package id/title, e.g. "chrome"). Omit to return the default result set.

immy_list_licenses parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=Adobe" (contains) or "softwareId==123". Omit for no filter.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`sorts`	string	no	null	Sieve sort expression, e.g. "name" or "-createdDate" (leading - = descending). Omit for default order.

immy_list_licenses_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	If true, the response includes totalCount. Omit to let the server decide.
`skip`	integer	no	null	Number of records to skip (DevExtreme paging offset). Omit for 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for default order.
`take`	integer	no	null	Number of records to take (clamped to 100).

immy_list_licenses_request_download parameters

Param	Type	Required	Default	Description
`licenseId`	string	yes		The license id whose file download URL to request (from immy_list_licenses).

immy_update_licenses parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Complete JSON object body for the license (full replace).
`licenseId`	string	yes		The license id to update (from immy_list_licenses).

Script Catalog & Functions

Tool	Plan	Access	Description
`immy_list_metascript_catalog_describe`	Free	Read-only	[ImmyBot] List the metascript catalog with full descriptions — the reusable ImmyBot metascript building blocks available to compose scripts and maintenance tasks. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Use immy_list_metascript_catalog_search for a lighter keyword search.
`immy_list_metascript_catalog_search`	Free	Read-only	[ImmyBot] Search the metascript catalog by keyword. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Use immy_list_metascript_catalog_describe for full catalog entry descriptions.
`immy_list_scripts_functions`	Free	Read-only	[ImmyBot] List the PowerShell/metascript functions exposed to scripts (the built-in function library scripts can call). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Validate a function's PowerShell syntax with immy_scripts_functions_syntax.
`immy_list_scripts_language_service_language`	Free	Read-only	[ImmyBot] Get the language/analysis state for an active script language-service terminal. terminalId comes from immy_scripts_language_service_start. Read-only editor support surface.
`immy_scripts_functions_syntax`	Free	Read-only	[ImmyBot] Analyze the syntax of a script function (read-only static analysis — a POST that inspects, not a write). Body carries the function source to check; returns parse/syntax diagnostics. No script is created or run.
`immy_scripts_language_service_start`	Pro	Write	[ImmyBot] Start a script language-service session (editor/analysis backend), returning a terminalId used by immy_list_scripts_language_service_language. Body carries the session/init options. This allocates a server-side session — a write.

immy_list_metascript_catalog_describe parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression, e.g. 'name@=backup'. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression, e.g. 'name' or '-createdAt'. Optional.

immy_list_metascript_catalog_search parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression, e.g. 'name@=install'. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression, e.g. 'name'. Optional.

immy_list_scripts_functions parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_language_service_language parameters

Param	Type	Required	Default	Description
`terminalId`	string	yes		Language-service terminal id (from immy_scripts_language_service_start).

immy_scripts_functions_syntax parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the function source/body to analyze. Passed through verbatim to POST /api/v1/scripts/functions/syntax.

immy_scripts_language_service_start parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the language-service start options. Passed through verbatim to POST /api/v1/scripts/language-service/start.

Script Execution

Tool	Plan	Access	Description
`immy_cancel_debug_script_run`	Pro	Destructive	[ImmyBot] Cancel an in-progress debug script run identified by cancellationId. This aborts a running execution — flagged Destructive because it terminates work in flight. Body carries any additional cancel options.
`immy_list_scripts_disabled_preflight_scripts`	Free	Read-only	[ImmyBot] List the preflight scripts currently disabled (preflight scripts run before maintenance to decide applicability). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Toggle enablement with immy_scripts_set_preflight_script_enablement.
`immy_scripts_default_variables`	Free	Read-only	[ImmyBot] Resolve the default variables ImmyBot would supply for a script (a POST that computes/reads defaults — it does not run the script or change state). Body carries the script/context to evaluate; returns the resolved variable set.
`immy_scripts_does_script_have_param_block`	Free	Read-only	[ImmyBot] Inspect a script and report whether it declares a PowerShell param() block (read-only static analysis via POST). Body carries the script source; returns a boolean/analysis result. No script is created or run.
`immy_scripts_run`	Pro	Destructive	[ImmyBot] Execute a script against target computers/tenants. This RUNS PowerShell/metascript code on managed endpoints and can change system state — flagged Destructive so it requires explicit approval. Body carries the script reference, target selection, and parameters. Preview/validate first with immy_scripts_syntax_check and immy_scripts_validate_param_block_parameters.
`immy_scripts_run_adhoc_metascript`	Pro	Destructive	[ImmyBot] Execute an ad-hoc metascript (inline PowerShell/metascript code, not a saved script) against targets. This RUNS arbitrary code on managed endpoints and can change system state — flagged Destructive so it requires explicit approval. Body carries the metascript source, target selection, and parameters.
`immy_scripts_set_preflight_script_enablement`	Pro	Write	[ImmyBot] Enable or disable a preflight script. Body carries the script identifier and desired enabled state. Changes which preflight checks run before maintenance — a configuration write. Use immy_list_scripts_disabled_preflight_scripts to see current state.
`immy_scripts_syntax_check`	Free	Read-only	[ImmyBot] Static syntax check of a script (a POST that parses and returns diagnostics — it does not run the script). Body carries the script source; returns parse errors/warnings.
`immy_scripts_validate_param_block_parameters`	Free	Read-only	[ImmyBot] Validate a set of parameters against a script's param() block (read-only validation via POST — it checks, it does not persist anything). Body carries the param block and candidate parameter values; returns validation results. Note: immy_users_invalidate_cache is a DIFFERENT, write operation despite the similar name.

immy_cancel_debug_script_run parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with additional cancel options (may be an empty object ''). Passed through verbatim to POST /api/v1/scripts/debug/cancel/.
`cancellationId`	string	yes		The cancellation id of the debug script run to cancel.

immy_list_scripts_disabled_preflight_scripts parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_scripts_default_variables parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object describing the script/context to resolve defaults for. Passed through verbatim to POST /api/v1/scripts/default-variables.

immy_scripts_does_script_have_param_block parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the script source to inspect. Passed through verbatim to POST /api/v1/scripts/does-script-have-param-block.

immy_scripts_run parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the script reference, targets, and parameters. Passed through verbatim to POST /api/v1/scripts/run.

immy_scripts_run_adhoc_metascript parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the ad-hoc metascript source, targets, and parameters. Passed through verbatim to POST /api/v1/scripts/run-adhoc-metascript.

immy_scripts_set_preflight_script_enablement parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the script id and enabled flag. Passed through verbatim to POST /api/v1/scripts/set-preflight-script-enablement.

immy_scripts_syntax_check parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the script source to syntax-check. Passed through verbatim to POST /api/v1/scripts/syntax-check.

immy_scripts_validate_param_block_parameters parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the param block and candidate parameter values to validate. Passed through verbatim to POST /api/v1/scripts/validate-param-block-parameters.

Scripts

Tool	Plan	Access	Description
`immy_create_global_script`	Pro	Write	[ImmyBot] Create a new global script (shared platform-wide). Body carries the script name, source, and metadata. Validate the source first with immy_scripts_syntax_check.
`immy_create_local_script`	Pro	Write	[ImmyBot] Create a new local script (tenant-scoped). Body carries the script name, source, and metadata. Validate the source first with immy_scripts_syntax_check.
`immy_delete_scripts_global`	Pro	Destructive	[ImmyBot] Permanently delete a global script. Any maintenance task or deployment referencing it loses that script — this cannot be undone. scriptId comes from immy_list_scripts_global; check immy_list_scripts_global_references first.
`immy_delete_scripts_local`	Pro	Destructive	[ImmyBot] Permanently delete a local script. Any maintenance task or deployment referencing it loses that script — this cannot be undone. scriptId comes from immy_list_scripts_local; check immy_list_scripts_local_references first.
`immy_get_scripts_global`	Free	Read-only	[ImmyBot] Get a single global script by id, including its source and metadata. scriptId comes from immy_list_scripts_global.
`immy_get_scripts_local`	Free	Read-only	[ImmyBot] Get a single local script by id, including its source and metadata. scriptId comes from immy_list_scripts_local.
`immy_list_scripts_dx`	Free	Read-only	[ImmyBot] List scripts via the DevExtreme grid feed (the data source behind the ImmyBot scripts grid). Uses DevExtreme paging: skip/take (take clamped to 100) plus optional filter/sort and requireTotalCount. For a standard list use immy_list_scripts_global or immy_list_scripts_local.
`immy_list_scripts_global`	Free	Read-only	[ImmyBot] List global scripts (shared platform-wide). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Each entry carries a scriptId used by immy_get_scripts_global, immy_update_global_script, and immy_delete_scripts_global.
`immy_list_scripts_global_audit`	Free	Read-only	[ImmyBot] List the audit history (change events) for a global script. scriptId comes from immy_list_scripts_global. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Use immy_list_scripts_global_audit_summaries for a rolled-up view.
`immy_list_scripts_global_audit_summaries`	Free	Read-only	[ImmyBot] List rolled-up audit summaries for a global script (aggregated change events). scriptId comes from immy_list_scripts_global. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100.
`immy_list_scripts_global_names`	Free	Read-only	[ImmyBot] List just the id+name pairs of global scripts (a lightweight pick-list for referencing scripts). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100.
`immy_list_scripts_global_references`	Free	Read-only	[ImmyBot] List the entities (maintenance tasks, deployments, etc.) that reference a global script. scriptId comes from immy_list_scripts_global. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Check references before deleting with immy_delete_scripts_global.
`immy_list_scripts_local`	Free	Read-only	[ImmyBot] List local scripts (tenant-scoped). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Each entry carries a scriptId used by immy_get_scripts_local, immy_update_local_script, and immy_delete_scripts_local.
`immy_list_scripts_local_audit`	Free	Read-only	[ImmyBot] List the audit history (change events) for a local script. scriptId comes from immy_list_scripts_local. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Use immy_list_scripts_local_audit_summaries for a rolled-up view.
`immy_list_scripts_local_audit_summaries`	Free	Read-only	[ImmyBot] List rolled-up audit summaries for a local script (aggregated change events). scriptId comes from immy_list_scripts_local. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100.
`immy_list_scripts_local_authorization`	Free	Read-only	[ImmyBot] Get the authorization (who may view/run/edit) for a local script. scriptId comes from immy_list_scripts_local. Set authorization with immy_scripts_local_authorization.
`immy_list_scripts_local_migrate_local_to_global_what_if`	Free	Read-only	[ImmyBot] Preview what would happen if a local script were migrated to a global script (a read-only what-if — nothing is migrated). scriptId comes from immy_list_scripts_local. Perform the migration with immy_scripts_local_migrate_local_to_global.
`immy_list_scripts_local_names`	Free	Read-only	[ImmyBot] List just the id+name pairs of local scripts (a lightweight tenant-scoped pick-list). Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100.
`immy_list_scripts_local_references`	Free	Read-only	[ImmyBot] List the entities that reference a local script. scriptId comes from immy_list_scripts_local. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100. Check references before deleting with immy_delete_scripts_local.
`immy_list_scripts_references_count`	Free	Read-only	[ImmyBot] Get the reference counts for scripts (how many maintenance tasks/deployments reference each script). No parameters. Use immy_list_scripts_global_references / immy_list_scripts_local_references for the detailed referencing entities of one script.
`immy_list_scripts_search`	Free	Read-only	[ImmyBot] Search across scripts (global + local) by keyword. Sieve-paged (Page/pageSize/Filters/Sorts); pageSize is clamped to 100.
`immy_scripts_duplicate`	Pro	Write	[ImmyBot] Duplicate an existing script into a new script. Body carries the source scriptId and any new-script overrides (e.g. name). Creates a new script — a write.
`immy_scripts_local_authorization`	Pro	Write	[ImmyBot] Set the authorization (who may view/run/edit) for a local script. scriptId comes from immy_list_scripts_local; body carries the authorization grants. Read current state with immy_list_scripts_local_authorization.
`immy_scripts_local_migrate_local_to_global`	Pro	Write	[ImmyBot] Migrate a local (tenant-scoped) script to a global (platform-wide) script. scriptId comes from immy_list_scripts_local; body carries migration options. Preview the effect first with immy_list_scripts_local_migrate_local_to_global_what_if.
`immy_update_global_script`	Pro	Write	[ImmyBot] Update an existing global script (POST-based update, not a PATCH). scriptId comes from immy_list_scripts_global; body carries the updated script fields. Validate the source first with immy_scripts_syntax_check.
`immy_update_local_script`	Pro	Write	[ImmyBot] Update an existing local script (POST-based update, not a PATCH). scriptId comes from immy_list_scripts_local; body carries the updated script fields. Validate the source first with immy_scripts_syntax_check.

immy_create_global_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the new global script (name, source, metadata). Passed through verbatim to POST /api/v1/scripts/global.

immy_create_local_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the new local script (name, source, metadata). Passed through verbatim to POST /api/v1/scripts/local.

immy_delete_scripts_global parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Global script id to delete (from immy_list_scripts_global).

immy_delete_scripts_local parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Local script id to delete (from immy_list_scripts_local).

immy_get_scripts_global parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Global script id (from immy_list_scripts_global).

immy_get_scripts_local parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).

immy_list_scripts_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Optional.
`requireTotalCount`	boolean	no	null	Whether to include the total row count. Optional.
`skip`	integer	no	null	DevExtreme skip (offset). Optional.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Optional.
`take`	integer	no	null	DevExtreme take (page size, max 100). Optional.

immy_list_scripts_global parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_global_audit parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Global script id (from immy_list_scripts_global).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_global_audit_summaries parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Global script id (from immy_list_scripts_global).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_global_names parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_global_references parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Global script id (from immy_list_scripts_global).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_local parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_local_audit parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_local_audit_summaries parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_local_authorization parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).

immy_list_scripts_local_migrate_local_to_global_what_if parameters

Param	Type	Required	Default	Description
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).

immy_list_scripts_local_names parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_local_references parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_scripts_search parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression, e.g. 'name@=install'. Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Sieve page size (max 100). Optional.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_scripts_duplicate parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object identifying the source script and duplicate options. Passed through verbatim to POST /api/v1/scripts/duplicate.

immy_scripts_local_authorization parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the authorization grants. Passed through verbatim to POST /api/v1/scripts/local//authorization.
`scriptId`	string	yes		Local script id (from immy_list_scripts_local).

immy_scripts_local_migrate_local_to_global parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with migration options (may be an empty object ''). Passed through verbatim to POST /api/v1/scripts/local//migrate-local-to-global.
`scriptId`	string	yes		Local script id to migrate (from immy_list_scripts_local).

immy_update_global_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the updated global script fields. Passed through verbatim to POST /api/v1/scripts/global/.
`scriptId`	string	yes		Global script id to update (from immy_list_scripts_global).

immy_update_local_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the updated local script fields. Passed through verbatim to POST /api/v1/scripts/local/.
`scriptId`	string	yes		Local script id to update (from immy_list_scripts_local).

Deployments

Tool	Plan	Access	Description
`immy_delete_target_assignments`	Pro	Destructive	[ImmyBot] Permanently delete a deployment (target assignment) by its id (from immy_list_target_assignments). This removes the deployment and cannot be undone.
`immy_delete_target_assignments_global`	Pro	Destructive	[ImmyBot] Permanently delete a global (cross-tenant) deployment by its id (from immy_list_target_assignments_global). This removes the deployment from every tenant it applied to and cannot be undone.
`immy_get_computer_optional_target_assignment_approvals`	Free	Read-only	[ImmyBot] Get the optional (opt-in) deployment approvals available for a specific computer, by computerId (from immy_list_computers). Optional deployments require per-computer approval before they run; this shows which are pending/available. Grant one with immy_target_assignments_optional_target_assignment_approvals.
`immy_get_target_assignments`	Free	Read-only	[ImmyBot] Get a single deployment (target assignment) by its id (from immy_list_target_assignments). Returns the full deployment definition — maintenance item, targets, desired state, schedule, and scope.
`immy_get_target_assignments_global`	Free	Read-only	[ImmyBot] Get a single global (cross-tenant) deployment by its id (from immy_list_target_assignments_global). Returns the full deployment definition.
`immy_list_target_assignments`	Free	Read-only	[ImmyBot] List deployments (target assignments) across the ImmyBot instance. A deployment binds a maintenance item (software/task/script) to targets (tenant, tag, computer, person, or MSP). Supports Sieve paging and filtering (Page, pageSize up to 100, Filters, Sorts). Use immy_get_target_assignments for one deployment, immy_list_target_assignments_global for cross-tenant deployments.
`immy_list_target_assignments_global`	Free	Read-only	[ImmyBot] List global (cross-tenant) deployments — target assignments that apply across every tenant rather than to a single one. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Use immy_get_target_assignments_global for one global deployment.
`immy_list_target_assignments_global_type`	Free	Read-only	[ImmyBot] Get the maintenance-item type (software / maintenance task / script) of a global deployment by its id (from immy_list_target_assignments_global). Lightweight lookup used to disambiguate which item family the deployment targets.
`immy_list_target_assignments_maintenance_item_orders`	Free	Read-only	[ImmyBot] List the ordering of maintenance items as resolved by deployments — the sequence in which items run during maintenance. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Change the order with immy_target_assignments_update_maintenance_item_order.
`immy_list_target_assignments_recommended_approvals`	Free	Read-only	[ImmyBot] List recommended deployment approvals — deployments ImmyBot recommends approving based on current state. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Apply the recommendations with immy_target_assignments_recommended_approvals_update.
`immy_list_target_assignments_type`	Free	Read-only	[ImmyBot] Get the maintenance-item type (software / maintenance task / script) of a deployment by its id (from immy_list_target_assignments). Lightweight lookup used to disambiguate which item family the deployment targets.
`immy_patch_target_assignments_batch_update`	Pro	Write	[ImmyBot] Batch-update multiple deployments in one call. Provide a JSON body containing the set of deployments and the fields to change on each. Use for bulk edits instead of many immy_update_target_assignments calls.
`immy_target_assignment_migrate_to_superseding_what_if`	Free	Read-only	[ImmyBot] Preview (what-if, no changes made) migrating deployments onto a superseding target assignment — shows what would happen without applying it. POST-as-read: provide a JSON body describing the migration (source deployments and superseding target). Apply for real with immy_target_assignments_migrate_to_superseding_assignment.
`immy_target_assignments`	Pro	Write	[ImmyBot] Create a new deployment (target assignment). Provide a JSON object body defining the maintenance item, targets (tenant/tag/computer/person/MSP), desired state, and schedule. Preview the resolved targets first with immy_target_assignments_target_preview / _tenant_target_preview / _persons_target_preview.
`immy_target_assignments_duplicate`	Pro	Write	[ImmyBot] Duplicate a single deployment (target assignment) into a new one. Provide a JSON body identifying the source deployment and any overrides for the copy. See immy_target_assignments_duplicates to duplicate several at once.
`immy_target_assignments_duplicates`	Pro	Write	[ImmyBot] Duplicate multiple deployments (target assignments) in one call. Provide a JSON body identifying the source deployments and any overrides. See immy_target_assignments_duplicate for a single copy.
`immy_target_assignments_global_create`	Pro	Write	[ImmyBot] Create a new global (cross-tenant) deployment. Provide a JSON object body defining the maintenance item, cross-tenant targets, desired state, and schedule. List existing global deployments with immy_list_target_assignments_global.
`immy_target_assignments_global_notes`	Pro	Write	[ImmyBot] Set or update the notes on a global (cross-tenant) deployment by its id (from immy_list_target_assignments_global). Provide a JSON body containing the notes text.
`immy_target_assignments_global_override`	Pro	Write	[ImmyBot] Apply an override to a global (cross-tenant) deployment by its id (from immy_list_target_assignments_global). Provide a JSON body describing the override (e.g. a tenant-level exception to the cross-tenant deployment).
`immy_target_assignments_migrate_deployments_to_provider_links`	Pro	Write	[ImmyBot] Migrate deployments so their targeting is driven by provider-link (RMM/PSA integration) data instead of legacy targeting. Provide a JSON body identifying the deployments and target provider links.
`immy_target_assignments_migrate_to_superseding_assignment`	Pro	Write	[ImmyBot] Migrate deployments onto a superseding target assignment (applies the change). Provide a JSON body identifying the source deployments and the superseding target. Preview first with immy_target_assignment_migrate_to_superseding_what_if.
`immy_target_assignments_notes`	Pro	Write	[ImmyBot] Set or update the notes on a deployment (target assignment) by its id (from immy_list_target_assignments). Provide a JSON body containing the notes text.
`immy_target_assignments_optional_target_assignment_approvals`	Pro	Write	[ImmyBot] Approve (opt in) an optional deployment for a target, by the optional-approval id. Provide a JSON body with the approval decision. Discover available approvals with immy_get_computer_optional_target_assignment_approvals.
`immy_target_assignments_override`	Pro	Write	[ImmyBot] Apply an override to a deployment (target assignment) by its id (from immy_list_target_assignments). Provide a JSON body describing the override (e.g. a per-computer or per-tenant exception to the deployment).
`immy_target_assignments_persons_target_preview`	Free	Read-only	[ImmyBot] Preview which persons a deployment target would resolve to (no changes made). POST-as-read: provide a JSON body describing the target criteria; returns the matching persons. See immy_target_assignments_target_preview (computers) and immy_target_assignments_tenant_target_preview (tenants).
`immy_target_assignments_recommended_approvals_update`	Pro	Write	[ImmyBot] Apply recommended deployment approvals. Provide a JSON body selecting which of the recommendations to approve/reject. List the recommendations first with immy_list_target_assignments_recommended_approvals.
`immy_target_assignments_target_preview`	Free	Read-only	[ImmyBot] Preview which computers a deployment target would resolve to (no changes made). POST-as-read: provide a JSON body describing the target criteria; returns the matching computers. See immy_target_assignments_tenant_target_preview and immy_target_assignments_persons_target_preview for tenant/person previews.
`immy_target_assignments_tenant_target_preview`	Free	Read-only	[ImmyBot] Preview which tenants a deployment target would resolve to (no changes made). POST-as-read: provide a JSON body describing the target criteria; returns the matching tenants. See immy_target_assignments_target_preview (computers) and immy_target_assignments_persons_target_preview (persons).
`immy_target_assignments_update_maintenance_item_order`	Pro	Write	[ImmyBot] Update the run order of maintenance items resolved by deployments. Provide a JSON body containing the desired ordering. View the current order with immy_list_target_assignments_maintenance_item_orders.
`immy_target_assignments_visibility`	Pro	Write	[ImmyBot] Set the visibility of deployments (e.g. hide/show in tenant-facing views). Provide a JSON body identifying the deployments and the visibility setting.
`immy_update_target_assignments`	Pro	Write	[ImmyBot] Update (replace) a deployment (target assignment) by its id (from immy_list_target_assignments). Provide the full JSON deployment definition — this is a PUT/replace, so include all fields you want to keep. For bulk edits use immy_patch_target_assignments_batch_update.
`immy_update_target_assignments_global`	Pro	Write	[ImmyBot] Update (replace) a global (cross-tenant) deployment by its id (from immy_list_target_assignments_global). Provide the full JSON deployment definition — this is a PUT/replace, so include all fields you want to keep.

immy_delete_target_assignments parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The deployment id to delete, from immy_list_target_assignments.

immy_delete_target_assignments_global parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The global deployment id to delete, from immy_list_target_assignments_global.

immy_get_computer_optional_target_assignment_approvals parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		The computer id, from immy_list_computers.

immy_get_target_assignments parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The deployment (target-assignment) id, from immy_list_target_assignments.

immy_get_target_assignments_global parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The global deployment (target-assignment) id, from immy_list_target_assignments_global.

immy_list_target_assignments parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression, e.g. 'name@=Chrome'. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression, e.g. '-updatedDate'. Optional.

immy_list_target_assignments_global parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_target_assignments_global_type parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The global deployment (target-assignment) id, from immy_list_target_assignments_global.

immy_list_target_assignments_maintenance_item_orders parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_target_assignments_recommended_approvals parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_target_assignments_type parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The deployment (target-assignment) id, from immy_list_target_assignments.

immy_patch_target_assignments_batch_update parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the batch of deployments and the fields to update.

immy_target_assignment_migrate_to_superseding_what_if parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the migration to preview (source deployment ids + superseding target).

immy_target_assignments parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body defining the deployment (maintenance item, targets, desired state, schedule).

immy_target_assignments_duplicate parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the source deployment id and any overrides for the copy.

immy_target_assignments_duplicates parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the source deployment ids and any overrides for the copies.

immy_target_assignments_global_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body defining the global deployment.

immy_target_assignments_global_notes parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body containing the notes to set.
`deploymentId`	string	yes		The global deployment id, from immy_list_target_assignments_global.

immy_target_assignments_global_override parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the override to apply.
`deploymentId`	string	yes		The global deployment id, from immy_list_target_assignments_global.

immy_target_assignments_migrate_deployments_to_provider_links parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the deployments to migrate and the target provider links.

immy_target_assignments_migrate_to_superseding_assignment parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the source deployments and the superseding target.

immy_target_assignments_notes parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body containing the notes to set.
`deploymentId`	string	yes		The deployment id, from immy_list_target_assignments.

immy_target_assignments_optional_target_assignment_approvals parameters

Param	Type	Required	Default	Description
`approvalId`	string	yes		The optional-target-assignment-approval id to act on.
`bodyJson`	string	yes		JSON body containing the approval decision.

immy_target_assignments_override parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the override to apply.
`deploymentId`	string	yes		The deployment id, from immy_list_target_assignments.

immy_target_assignments_persons_target_preview parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the persons target criteria to resolve.

immy_target_assignments_recommended_approvals_update parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body selecting which recommended approvals to apply.

immy_target_assignments_target_preview parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the computer target criteria to resolve.

immy_target_assignments_tenant_target_preview parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the tenant target criteria to resolve.

immy_target_assignments_update_maintenance_item_order parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body containing the desired maintenance-item ordering.

immy_target_assignments_visibility parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the deployments and desired visibility.

immy_update_target_assignments parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		Full JSON deployment definition (PUT/replace).
`deploymentId`	string	yes		The deployment id to update, from immy_list_target_assignments.

immy_update_target_assignments_global parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		Full JSON deployment definition (PUT/replace).
`deploymentId`	string	yes		The global deployment id to update, from immy_list_target_assignments_global.

Deployment Change Requests

Tool	Plan	Access	Description
`immy_apply_change_request`	Pro	Write	[ImmyBot] Apply a deployment change request by its changeRequestId (from immy_list_target_assignment_change_requests) — commits the proposed deployment edits. Provide a JSON body with any apply options. Review the diff (immy_list_target_assignments_change_request_diff) before applying.
`immy_create_change_request`	Pro	Write	[ImmyBot] Create an instance-wide deployment change request — a reviewable proposal of deployment edits. Provide a JSON body describing the proposed changes. Review its diff with immy_list_target_assignments_change_request_diff, then apply with immy_apply_change_request.
`immy_create_deployment_change_request`	Pro	Write	[ImmyBot] Create a change request scoped to a single deployment, by deploymentId (from immy_list_target_assignments). Provide a JSON body describing the proposed change to that deployment. List a deployment's change requests with immy_list_deployment_change_requests.
`immy_get_target_assignments_change_request`	Free	Read-only	[ImmyBot] Get a single deployment change request by its changeRequestId (from immy_list_target_assignment_change_requests). Returns the proposed change to a deployment. Inspect what it would alter with immy_list_target_assignments_change_request_diff.
`immy_list_deployment_change_requests`	Free	Read-only	[ImmyBot] List the change requests scoped to a single deployment, by deploymentId (from immy_list_target_assignments). Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Create one with immy_create_deployment_change_request.
`immy_list_target_assignment_change_requests`	Free	Read-only	[ImmyBot] List deployment change requests across the instance. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). For change requests scoped to one deployment use immy_list_deployment_change_requests.
`immy_list_target_assignments_change_request_diff`	Free	Read-only	[ImmyBot] Get the diff of a deployment change request by its changeRequestId (from immy_list_target_assignment_change_requests) — the before/after of what applying it would change. Review this before immy_apply_change_request.
`immy_update_deployment_change_request`	Pro	Write	[ImmyBot] Update an existing change request scoped to a deployment, by deploymentId and changeRequestId (both from immy_list_deployment_change_requests). Provide a JSON body with the revised proposed change.

immy_apply_change_request parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with apply options (may be an empty object ).
`changeRequestId`	string	yes		The change request id to apply, from immy_list_target_assignment_change_requests.

immy_create_change_request parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the proposed deployment change(s).

immy_create_deployment_change_request parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the proposed change to the deployment.
`deploymentId`	string	yes		The deployment (target-assignment) id, from immy_list_target_assignments.

immy_get_target_assignments_change_request parameters

Param	Type	Required	Default	Description
`changeRequestId`	string	yes		The change request id, from immy_list_target_assignment_change_requests.

immy_list_deployment_change_requests parameters

Param	Type	Required	Default	Description
`deploymentId`	string	yes		The deployment (target-assignment) id, from immy_list_target_assignments.
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_target_assignment_change_requests parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_target_assignments_change_request_diff parameters

Param	Type	Required	Default	Description
`changeRequestId`	string	yes		The change request id, from immy_list_target_assignment_change_requests.

immy_update_deployment_change_request parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with the revised proposed change.
`changeRequestId`	string	yes	The change request id to update, from immy_list_deployment_change_requests.
`deploymentId`	string	yes	The deployment (target-assignment) id, from immy_list_target_assignments.

Maintenance Actions

Tool	Plan	Access	Description
`immy_get_maintenance_actions_dx_for_computer`	Free	Read-only	[ImmyBot] DevExtreme grid feed of maintenance actions scoped to a single computer. Pass the computerId (from immy_list_computers). Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort JSON and requireTotalCount. Returns raw ImmyBot JSON.
`immy_get_maintenance_actions_latest_for_computer`	Free	Read-only	[ImmyBot] Get the latest maintenance actions for a single computer (from immy_list_computers). Returns raw ImmyBot JSON.
`immy_get_maintenance_actions_latest_for_tenant`	Free	Read-only	[ImmyBot] Get the latest maintenance actions for a single tenant (from immy_list_tenants). Returns raw ImmyBot JSON.
`immy_get_tenant_latest_non_compliant_maintenance_actions`	Free	Read-only	[ImmyBot] Get the latest non-compliant maintenance actions (action still required) for a single tenant (from immy_list_tenants). Returns raw ImmyBot JSON.
`immy_list_maintenance_actions_computer_needs_attention`	Free	Read-only	[ImmyBot] List the maintenance actions on one computer that currently need attention (non-compliant / action required). Pass the computerId (from immy_list_computers). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_maintenance_actions_dx`	Free	Read-only	[ImmyBot] DevExtreme grid feed of maintenance actions across the instance. Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort JSON and requireTotalCount. Returns raw ImmyBot JSON.
`immy_list_maintenance_actions_logs`	Free	Read-only	[ImmyBot] List the execution logs for a single maintenance action. Pass the actionId (from a maintenance-actions listing or a session's actions). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_maintenance_actions_maintenance_item`	Free	Read-only	[ImmyBot] List maintenance actions grouped/filtered by maintenance item (software or task). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_maintenance_actions_version`	Free	Read-only	[ImmyBot] Get the maintenance-actions version/metadata record used by the ImmyBot UI grid. Returns raw ImmyBot JSON.
`immy_maintenance_actions_latest_action_for_computers`	Free	Read-only	[ImmyBot] Look up the latest maintenance action for a set of computers for one software item or maintenance task. This is a POST-as-read (read-only): provide a JSON object body — required: maintenanceIdentifier (string). Optional: maintenanceType ('Software' or 'MaintenanceTask'; must accompany maintenanceIdentifier), computerIds (array of computer ids), dateUtc (ISO timestamp to look back from). Returns raw ImmyBot JSON.
`immy_maintenance_actions_latest_action_for_tenants`	Free	Read-only	[ImmyBot] Look up the latest maintenance action for a set of tenants for one software item or maintenance task. This is a POST-as-read (read-only): provide a JSON object body — required: maintenanceIdentifier (string). Optional: maintenanceType ('Software' or 'MaintenanceTask'; must accompany maintenanceIdentifier), tenantIds (array of tenant ids), dateUtc (ISO timestamp to look back from). Returns raw ImmyBot JSON.

immy_get_maintenance_actions_dx_for_computer parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		The computer id (from immy_list_computers).
`filter`	string	no	null	Optional DevExtreme filter expression (JSON array string).
`requireTotalCount`	boolean	no	null	When true, include the total record count in the response.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Optional.
`sort`	string	no	null	Optional DevExtreme sort expression (JSON array string).
`take`	integer	no	null	Number of records to return (DevExtreme take, max 100). Optional.

immy_get_maintenance_actions_latest_for_computer parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		The computer id (from immy_list_computers).

immy_get_maintenance_actions_latest_for_tenant parameters

Param	Type	Required	Default	Description
`tenantId`	string	yes		The tenant id (from immy_list_tenants).

immy_get_tenant_latest_non_compliant_maintenance_actions parameters

Param	Type	Required	Default	Description
`tenantId`	string	yes		The tenant id (from immy_list_tenants).

immy_list_maintenance_actions_computer_needs_attention parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		The computer id (from immy_list_computers).
`filters`	string	no	null	Optional Sieve filter expression (e.g. `name@=chrome`).
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression (e.g. `-createdDate`).

immy_list_maintenance_actions_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional DevExtreme filter expression (JSON array string).
`requireTotalCount`	boolean	no	null	When true, include the total record count in the response.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Optional.
`sort`	string	no	null	Optional DevExtreme sort expression (JSON array string).
`take`	integer	no	null	Number of records to return (DevExtreme take, max 100). Optional.

immy_list_maintenance_actions_logs parameters

Param	Type	Required	Default	Description
`actionId`	string	yes		The maintenance action id.
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_maintenance_actions_maintenance_item parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_maintenance_actions_latest_action_for_computers parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Required: maintenanceIdentifier. Optional: maintenanceType, computerIds (array), dateUtc.

immy_maintenance_actions_latest_action_for_tenants parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Required: maintenanceIdentifier. Optional: maintenanceType, tenantIds (array), dateUtc.

Maintenance Sessions

Tool	Plan	Access	Description
`immy_cancel_all_maintenance_sessions`	Pro	Destructive	[ImmyBot] Cancel ALL currently-running maintenance sessions across the instance. Destructive and broad — it aborts every in-progress session; get user approval first. Takes no meaningful body (leave fieldsJson as ``). Returns raw ImmyBot JSON.
`immy_cancel_maintenance_session`	Pro	Destructive	[ImmyBot] Cancel a single maintenance session by sessionId. Destructive — it aborts the in-progress session. This is a GET-verb action endpoint (not a read); pass the sessionId (from immy_list_maintenance_sessions_dx). Returns raw ImmyBot JSON.
`immy_cancel_maintenance_sessions`	Pro	Destructive	[ImmyBot] Cancel a specific set of running maintenance sessions. Destructive — it aborts in-progress maintenance. Provide a JSON object body: sessionIds (array of maintenance session ids from immy_list_maintenance_sessions_dx). Returns raw ImmyBot JSON.
`immy_cancel_maintenance_sessions_for_schedule`	Pro	Destructive	[ImmyBot] Cancel all maintenance sessions that were started by a given schedule. Destructive — it aborts in-progress sessions for that schedule. This is a GET-verb action endpoint (not a read); pass the scheduleId. Returns raw ImmyBot JSON.
`immy_get_maintenance_sessions`	Free	Read-only	[ImmyBot] Get a single maintenance session by sessionId (from immy_list_maintenance_sessions_dx), including its status, target, and actions. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_dx`	Free	Read-only	[ImmyBot] DevExtreme grid feed of maintenance sessions across the instance. Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort JSON and requireTotalCount. Use this to find session IDs. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_last_log`	Free	Read-only	[ImmyBot] Get the most recent log line for a maintenance session by sessionId — a lightweight way to poll live progress. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_logs`	Free	Read-only	[ImmyBot] List the full log stream for a maintenance session by sessionId. Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. For very old sessions whose logs were rolled off, use immy_list_maintenance_sessions_old_logs. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_old_logs`	Free	Read-only	[ImmyBot] List the archived/old log stream for a maintenance session by sessionId (the pre-rollover logs not returned by immy_list_maintenance_sessions_logs). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_phases`	Free	Read-only	[ImmyBot] List the phases (detection, resolution, follow-up, etc.) of a maintenance session by sessionId, with each phase's status and timing. Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_maintenance_sessions_status_counts`	Free	Read-only	[ImmyBot] Get the count of maintenance sessions in each status (e.g. running, completed, cancelled, failed). Useful for a dashboard summary. Returns raw ImmyBot JSON.
`immy_maintenance_sessions_actions_rerun`	Pro	Write	[ImmyBot] Re-run a single action within a maintenance session (re-executes just that one maintenance action). Pass the sessionId and the actionId (both from immy_get_maintenance_sessions). This endpoint takes no body — leave fieldsJson as ``. Returns raw ImmyBot JSON.
`immy_maintenance_sessions_resume`	Pro	Write	[ImmyBot] Resume a paused/waiting maintenance session by sessionId (e.g. one that stalled awaiting a reboot or user response). Pass the sessionId (from immy_list_maintenance_sessions_dx). This endpoint takes no body — leave fieldsJson as ``. Returns raw ImmyBot JSON.
`immy_rerun_maintenance_session`	Pro	Write	[ImmyBot] Re-run a single maintenance session by sessionId (re-executes maintenance against its original target). Pass the sessionId (from immy_list_maintenance_sessions_dx). This endpoint takes no body — leave fieldsJson as ``. Returns raw ImmyBot JSON.
`immy_rerun_maintenance_sessions`	Pro	Write	[ImmyBot] Re-run a set of maintenance sessions (re-executes maintenance against their original targets). Provide a JSON object body: sessionIds (array of maintenance session ids from immy_list_maintenance_sessions_dx). Returns raw ImmyBot JSON (new session IDs).
`immy_run_immy_service`	Pro	Destructive	[ImmyBot] Enqueue one or more maintenance sessions and SYNCHRONOUSLY return the started session IDs. This can install/uninstall software, run maintenance tasks, and reboot endpoints, so it is destructive — get user approval before running. Provide a JSON object body: target with exactly one of computers, tenants, or persons (arrays; mutually exclusive). Optional: maintenanceParams (the software/task to run; omit for full maintenance), detectionOnly, resolutionOnly, inventoryOnly, fullMaintenance, cacheOnly, rebootPreference, licenseId, updateTime, timeZoneInfoId, and email/prompt options. For large fan-outs prefer immy_run_immy_service_new (background). Returns raw ImmyBot JSON (started session IDs).
`immy_run_immy_service_new`	Pro	Destructive	[ImmyBot] Enqueue one or more maintenance sessions in the BACKGROUND and return immediately (202 Accepted) without waiting for the session IDs. Same target/body shape as immy_run_immy_service (exactly one of computers, tenants, or persons; optional maintenanceParams and options). Preferred for large fan-outs. Destructive — it executes maintenance (install/uninstall/reboot) on customer endpoints; get user approval first. Poll status with immy_list_maintenance_sessions_dx / immy_get_maintenance_sessions. Returns raw ImmyBot JSON.

immy_cancel_all_maintenance_sessions parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).

immy_cancel_maintenance_session parameters

Param	Type	Required	Default	Description
`sessionId`	string	yes		The maintenance session id to cancel (from immy_list_maintenance_sessions_dx).

immy_cancel_maintenance_sessions parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Required: sessionIds (array of session ids to cancel).

immy_cancel_maintenance_sessions_for_schedule parameters

Param	Type	Required	Default	Description
`scheduleId`	string	yes		The schedule id whose maintenance sessions should be cancelled.

immy_get_maintenance_sessions parameters

Param	Type	Required	Default	Description
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).

immy_list_maintenance_sessions_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional DevExtreme filter expression (JSON array string).
`requireTotalCount`	boolean	no	null	When true, include the total record count in the response.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Optional.
`sort`	string	no	null	Optional DevExtreme sort expression (JSON array string).
`take`	integer	no	null	Number of records to return (DevExtreme take, max 100). Optional.

immy_list_maintenance_sessions_last_log parameters

Param	Type	Required	Default	Description
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).

immy_list_maintenance_sessions_logs parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_maintenance_sessions_old_logs parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_maintenance_sessions_phases parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).
`sorts`	string	no	null	Optional Sieve sort expression.

immy_maintenance_sessions_actions_rerun parameters

Param	Type	Required	Default	Description
`actionId`	string	yes		The action id within the session (from immy_get_maintenance_sessions).
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`sessionId`	string	yes		The maintenance session id (from immy_list_maintenance_sessions_dx).

immy_maintenance_sessions_resume parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`sessionId`	string	yes		The maintenance session id to resume (from immy_list_maintenance_sessions_dx).

immy_rerun_maintenance_session parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`sessionId`	string	yes		The maintenance session id to rerun (from immy_list_maintenance_sessions_dx).

immy_rerun_maintenance_sessions parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Required: sessionIds (array of session ids to rerun).

immy_run_immy_service parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Targets: exactly one of computers / tenants / persons (arrays). Optional: maintenanceParams, detectionOnly, resolutionOnly, inventoryOnly, fullMaintenance, rebootPreference, licenseId, etc.

immy_run_immy_service_new parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body. Targets: exactly one of computers / tenants / persons (arrays). Optional: maintenanceParams and options. Optional sessionGroupId to correlate per-target sessions.

Maintenance Tasks

Tool	Plan	Access	Description
`immy_create_global_maintenance_task`	Pro	Write	[ImmyBot] Create a new GLOBAL (cross-tenant) maintenance task. Body (fieldsJson) is the task definition — typically name, description, the script/metascript body, execution context, and parameter definitions. Returns the created task JSON (including its assigned id).
`immy_create_local_maintenance_task`	Pro	Write	[ImmyBot] Create a new LOCAL (tenant-scoped) maintenance task. Body (fieldsJson) is the task definition — typically name, description, script/metascript body, execution context, and parameter definitions. Returns the created task JSON (including its assigned id).
`immy_delete_maintenance_tasks_global`	Pro	Destructive	[ImmyBot] Permanently delete the global maintenance task identified by id — this cannot be undone and every deployment/target-assignment referencing it will lose that task. Check immy_list_maintenance_tasks_reference_count first. id comes from immy_list_maintenance_tasks_global.
`immy_delete_maintenance_tasks_local`	Pro	Destructive	[ImmyBot] Permanently delete the local maintenance task identified by id — this cannot be undone and any deployment referencing it will lose that task. id comes from immy_list_maintenance_tasks_local.
`immy_get_maintenance_tasks_global`	Free	Read-only	[ImmyBot] Get a single global maintenance task by id, including its script/metascript body and parameter definitions. id comes from immy_list_maintenance_tasks_global or immy_list_maintenance_tasks_search.
`immy_get_maintenance_tasks_local`	Free	Read-only	[ImmyBot] Get a single local maintenance task by id, including its script/metascript body and parameter definitions. id comes from immy_list_maintenance_tasks_local or immy_list_maintenance_tasks_search.
`immy_list_maintenance_tasks_authorization`	Free	Read-only	[ImmyBot] Get the authorization/access configuration for the maintenance task identified by id (which tenants/roles may see or run it). id comes from immy_list_maintenance_tasks_global/local. Change it with the write tool immy_maintenance_tasks_authorization.
`immy_list_maintenance_tasks_global`	Free	Read-only	[ImmyBot] List global (cross-tenant) maintenance tasks. Supports Sieve paging/filtering. Each entry carries an id used by immy_get_maintenance_tasks_global and the update/delete tools. `pageSize` is clamped to 100. `filters`/`sorts` accept Sieve expressions (e.g. filters="name@=defender", sorts="name").
`immy_list_maintenance_tasks_local`	Free	Read-only	[ImmyBot] List local (tenant-scoped) maintenance tasks. Supports Sieve paging/filtering. Each entry carries an id used by immy_get_maintenance_tasks_local and the update/delete tools. `pageSize` is clamped to 100. `filters`/`sorts` accept Sieve expressions.
`immy_list_maintenance_tasks_reference_count`	Free	Read-only	[ImmyBot] Return the count of references to maintenance tasks (how many deployments/other objects point at each task) — used to gauge blast radius before editing or deleting a task. Takes no parameters.
`immy_list_maintenance_tasks_search`	Free	Read-only	[ImmyBot] Search across both global and local maintenance tasks. Supports Sieve paging/filtering — pass a Sieve `filters` expression to narrow by name/text. `pageSize` is clamped to 100. Results carry ids usable with the get/update/delete tools.
`immy_maintenance_task_migrate_local_to_global_what_if`	Free	Read-only	[ImmyBot] Preview (dry-run) what promoting the local maintenance task identified by id to a global task would do — surfaces conflicts, references, and the resulting shape without making any change. Pair with the write tool immy_maintenance_tasks_local_migrate_local_to_global to actually perform the migration. id comes from immy_list_maintenance_tasks_local.
`immy_maintenance_tasks_authorization`	Pro	Write	[ImmyBot] Set the authorization/access configuration for the maintenance task identified by id (which tenants/roles may see or run it). id comes from immy_list_maintenance_tasks_global/local. Read the current config with immy_list_maintenance_tasks_authorization. Body (fieldsJson): the authorization definition.
`immy_maintenance_tasks_duplicate`	Pro	Write	[ImmyBot] Duplicate an existing maintenance task, creating an editable copy. Body (fieldsJson): identifies the source task (e.g. its id) and any overrides (e.g. new name). Returns the newly created task JSON.
`immy_maintenance_tasks_global_param_block_from_parameters`	Free	Read-only	[ImmyBot] Generate the PowerShell param() block text for the global maintenance task identified by id from a set of parameter definitions. This is a read-only preview/codegen helper (POST-as-read) — it computes and returns the param block and does NOT modify the task. id comes from immy_list_maintenance_tasks_global. Body (fieldsJson): the parameter definitions to render.
`immy_maintenance_tasks_local_migrate_local_to_global`	Pro	Write	[ImmyBot] Promote the local maintenance task identified by id to a GLOBAL (cross-tenant) task, making it available to all tenants. Preview the effect first with immy_maintenance_task_migrate_local_to_global_what_if. id comes from immy_list_maintenance_tasks_local. Body (fieldsJson): migration options (may be an empty object).
`immy_maintenance_tasks_local_param_block_from_parameters`	Free	Read-only	[ImmyBot] Generate the PowerShell param() block text for the local maintenance task identified by id from a set of parameter definitions. This is a read-only preview/codegen helper (POST-as-read) — it computes and returns the param block and does NOT modify the task. id comes from immy_list_maintenance_tasks_local. Body (fieldsJson): the parameter definitions to render.
`immy_maintenance_tasks_validate_param_block_parameters`	Free	Read-only	[ImmyBot] Validate a set of param-block parameter definitions for a maintenance task — checks types, required-ness, and default consistency and returns validation results. This is a read-only validation helper (POST-as-read) and does NOT persist anything. Body (fieldsJson): the parameter definitions to validate.
`immy_update_global_maintenance_task`	Pro	Write	[ImmyBot] Update the global maintenance task identified by id. Body (fieldsJson) is the full task definition (replace semantics, not a partial patch). id comes from immy_list_maintenance_tasks_global. Editing a widely-referenced task affects every deployment that uses it — check immy_list_maintenance_tasks_reference_count first.
`immy_update_local_maintenance_task`	Pro	Write	[ImmyBot] Update the local maintenance task identified by id. Body (fieldsJson) is the full task definition (replace semantics, not a partial patch). id comes from immy_list_maintenance_tasks_local.

immy_create_global_maintenance_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Maintenance-task definition JSON (name, script body, execution context, parameters, ...).

immy_create_local_maintenance_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Maintenance-task definition JSON (name, script body, execution context, parameters, ...).

immy_delete_maintenance_tasks_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		Global maintenance-task id to delete (from immy_list_maintenance_tasks_global).

immy_delete_maintenance_tasks_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local maintenance-task id to delete (from immy_list_maintenance_tasks_local).

immy_get_maintenance_tasks_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		Global maintenance-task id (from immy_list_maintenance_tasks_global).

immy_get_maintenance_tasks_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local maintenance-task id (from immy_list_maintenance_tasks_local).

immy_list_maintenance_tasks_authorization parameters

Param	Type	Required	Default	Description
`id`	string	yes		Maintenance-task id (from immy_list_maintenance_tasks_global or immy_list_maintenance_tasks_local).

immy_list_maintenance_tasks_global parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=defender". Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Rows per page (max 100). Optional.
`sorts`	string	no	null	Sieve sort expression, e.g. "name" or "-updatedDate". Optional.

immy_list_maintenance_tasks_local parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=install". Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Rows per page (max 100). Optional.
`sorts`	string	no	null	Sieve sort expression, e.g. "name" or "-updatedDate". Optional.

immy_list_maintenance_tasks_search parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=chrome". Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Rows per page (max 100). Optional.
`sorts`	string	no	null	Sieve sort expression, e.g. "name". Optional.

immy_maintenance_task_migrate_local_to_global_what_if parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local maintenance-task id (from immy_list_maintenance_tasks_local).

immy_maintenance_tasks_authorization parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Authorization definition JSON.
`id`	string	yes		Maintenance-task id (from immy_list_maintenance_tasks_global or immy_list_maintenance_tasks_local).

immy_maintenance_tasks_duplicate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON identifying the source task to duplicate plus any overrides (e.g. sourceId, name).

immy_maintenance_tasks_global_param_block_from_parameters parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Parameter definitions JSON to render into a param() block.
`id`	string	yes		Global maintenance-task id (from immy_list_maintenance_tasks_global).

immy_maintenance_tasks_local_migrate_local_to_global parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Migration options JSON (may be an empty object ).
`id`	string	yes		Local maintenance-task id to promote (from immy_list_maintenance_tasks_local).

immy_maintenance_tasks_local_param_block_from_parameters parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Parameter definitions JSON to render into a param() block.
`id`	string	yes		Local maintenance-task id (from immy_list_maintenance_tasks_local).

immy_maintenance_tasks_validate_param_block_parameters parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Parameter definitions JSON to validate.

immy_update_global_maintenance_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full maintenance-task definition JSON (replace semantics).
`id`	string	yes		Global maintenance-task id (from immy_list_maintenance_tasks_global).

immy_update_local_maintenance_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full maintenance-task definition JSON (replace semantics).
`id`	string	yes		Local maintenance-task id (from immy_list_maintenance_tasks_local).

Inventory Tasks

Tool	Plan	Access	Description
`immy_create_local_inventory_task`	Pro	Write	[ImmyBot] Create a new LOCAL (tenant-authored) inventory task. Body (fieldsJson) is the inventory-task definition — typically name, description, and the inventory scripts/keys it gathers. Returns the created task JSON (including its assigned id). Only local inventory tasks are editable; global ones are read-only vendor content. Attach collection scripts afterward with immy_inventory_tasks_local_scripts.
`immy_delete_inventory_tasks_local`	Pro	Destructive	[ImmyBot] Permanently delete the local inventory task identified by id, along with its collection scripts — this cannot be undone and any detection/deployment logic referencing its inventory keys will lose that data source. id comes from immy_list_inventory_tasks. Only local inventory tasks can be deleted.
`immy_delete_inventory_tasks_local_scripts`	Pro	Destructive	[ImmyBot] Permanently remove a single collection script (identified by inventoryKey) from the local inventory task identified by taskId — this cannot be undone. taskId comes from immy_list_inventory_tasks; inventoryKey identifies the specific script/inventory slot within that task.
`immy_inventory_tasks_local_scripts`	Pro	Write	[ImmyBot] Add or update a collection script on the local inventory task identified by id. Body (fieldsJson) describes the script and its inventory key (the named slot whose output this script produces). id comes from immy_list_inventory_tasks. Remove a script with immy_delete_inventory_tasks_local_scripts.
`immy_list_inventory_tasks`	Free	Read-only	[ImmyBot] List all inventory tasks (global vendor + local tenant-authored) that collect custom inventory data from managed computers. Supports Sieve paging/filtering. Each entry carries an id used by the get/update/delete inventory-task tools. `pageSize` is clamped to 100. `filters`/`sorts` accept Sieve expressions (e.g. filters="name@=chrome", sorts="name").
`immy_update_local_inventory_task`	Pro	Write	[ImmyBot] Update the local inventory task identified by id. Body (fieldsJson) is the full inventory-task definition (this is a replace, not a partial patch). id comes from immy_list_inventory_tasks. Only local inventory tasks can be updated.

immy_create_local_inventory_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Inventory-task definition JSON (e.g. name, description, inventory keys/scripts).

immy_delete_inventory_tasks_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local inventory-task id to delete (from immy_list_inventory_tasks).

immy_delete_inventory_tasks_local_scripts parameters

Param	Type	Required	Default	Description
`inventoryKey`	string	yes		Inventory key identifying the script/slot to remove from the task.
`taskId`	string	yes		Local inventory-task id (from immy_list_inventory_tasks).

immy_inventory_tasks_local_scripts parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Script definition JSON (script body + its inventory key / metadata).
`id`	string	yes		Local inventory-task id (from immy_list_inventory_tasks).

immy_list_inventory_tasks parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=chrome". Optional.
`page`	integer	no	null	Sieve page number (1-based). Optional.
`pageSize`	integer	no	null	Rows per page (max 100). Optional.
`sorts`	string	no	null	Sieve sort expression, e.g. "name" or "-updatedDate". Optional.

immy_update_local_inventory_task parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full inventory-task definition JSON (replace semantics).
`id`	string	yes		Local inventory-task id (from immy_list_inventory_tasks).

Tenants

Tool	Plan	Access	Description
`immy_add_tags_to_tenants`	Pro	Write	[ImmyBot] Add one or more tags to one or more tenants. Provide a JSON object body identifying the tenant id(s) and tag id(s) (tags from immy_list_tags, tenants from immy_list_tenants). Remove them with immy_remove_tags_from_tenants.
`immy_get_tenants`	Free	Read-only	[ImmyBot] Get a single tenant by id (from immy_list_tenants). Returns the tenant's full detail (name, parent tenant, Azure link, flags).
`immy_get_tenants_azure_groups`	Free	Read-only	[ImmyBot] Get a single Azure (Entra) group for a tenant by tenant id (from immy_list_tenants) and group id (from immy_list_tenants_azure_groups). Returns the group's detail.
`immy_get_tenants_software_from_inventory`	Free	Read-only	[ImmyBot] Get a single software-from-inventory record by id (from immy_list_tenants_software_from_inventory_dx). Returns the discovered software detail.
`immy_list_tenants`	Free	Read-only	[ImmyBot] List the tenants (managed customer organizations) in the ImmyBot instance. Paginated via Sieve: page (1-based) + pageSize (max 100). filters/sorts accept Sieve expressions (e.g. filters="Name@=acme", sorts="Name"). Returns each tenant's id and name; feed a tenant id to immy_get_tenants and the tenant write tools.
`immy_list_tenants_azure_groups`	Free	Read-only	[ImmyBot] List the Azure (Entra) groups for a tenant by tenant id (from immy_list_tenants). Requires the tenant to have a linked Azure tenant (see immy_tenants_update_azure_tenant_link). Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts. Get one group with immy_get_tenants_azure_groups.
`immy_list_tenants_computer_counts`	Free	Read-only	[ImmyBot] List tenants with their managed-computer counts. Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts. Useful for a fleet-size overview per customer.
`immy_list_tenants_computers_excluded_from_maintenance`	Free	Read-only	[ImmyBot] List a tenant's computers that are excluded from maintenance, by tenant id (from immy_list_tenants). Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts. Exclude/include individual computers with immy_computers_exclude_from_maintenance.
`immy_list_tenants_excluded_from_cross_tenant_deployments`	Free	Read-only	[ImmyBot] List tenants that are excluded from cross-tenant (global) deployments. Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts.
`immy_list_tenants_software_from_inventory_dx`	Free	Read-only	[ImmyBot] List software discovered across tenants from inventory, as a DevExtreme grid feed. Uses DevExtreme paging: skip + take (take max 100), with optional filter/sort (DevExtreme JSON expressions) and requireTotalCount. For a downloadable spreadsheet use immy_list_tenants_software_from_inventory_export.
`immy_list_tenants_software_from_inventory_export`	Free	Read-only	[ImmyBot] Export the cross-tenant software-from-inventory report as an XLSX spreadsheet. Because the response is a binary spreadsheet (not JSON), this returns a short-lived read-only SAS URL envelope {sasUrl, contentType, suggestedFilename, sizeBytes, expiresAt} — download the spreadsheet from sasUrl out-of-band; do NOT decode the URL as content. Optional Sieve filters/sorts narrow the exported rows.
`immy_patch_tenants_activate`	Pro	Write	[ImmyBot] Activate a tenant by id (from immy_list_tenants). Sent as an HTTP PATCH to /tenants/activate/. The body is usually empty (); pass a JSON object only if the endpoint requires activation options.
`immy_patch_tenants_deactivate`	Pro	Write	[ImmyBot] Deactivate a tenant by id (from immy_list_tenants). Sent as an HTTP PATCH to /tenants/deactivate/. The body is usually empty (); pass a JSON object only if the endpoint requires deactivation options. Re-activate with immy_patch_tenants_activate.
`immy_remove_tags_from_tenants`	Pro	Write	[ImmyBot] Remove one or more tags from one or more tenants. Provide a JSON object body identifying the tenant id(s) and tag id(s) (tags from immy_list_tags, tenants from immy_list_tenants). Add them with immy_add_tags_to_tenants.
`immy_tenants`	Pro	Write	[ImmyBot] Create a tenant (managed customer organization). Provide a JSON object body — typically name plus optional parent-tenant and configuration fields. For creating many at once use immy_tenants_bulk_create.
`immy_tenants_bulk_create`	Pro	Write	[ImmyBot] Create multiple tenants in one call. Provide a JSON object body containing the array of tenants to create (each typically with a name). For a single tenant use immy_tenants.
`immy_tenants_bulk_delete`	Pro	Destructive	[ImmyBot] Permanently delete multiple tenants in one call — irreversible. Provide a JSON object body with the array of tenant id(s) to delete (from immy_list_tenants). Deleting a tenant removes its managed computers/persons associations.
`immy_tenants_bulk_merge`	Pro	Destructive	[ImmyBot] Merge tenants together — consolidates source tenants into a target and removes the sources; irreversible. Provide a JSON object body identifying the source and target tenant id(s) (from immy_list_tenants). Review affected tenants before merging.
`immy_tenants_remove_parent_tenant`	Pro	Write	[ImmyBot] Remove the parent-tenant link from one or more tenants, flattening them out of a parent/child hierarchy. Provide a JSON object body with the tenant id(s) (from immy_list_tenants). Set a parent with immy_tenants_set_parent_tenant.
`immy_tenants_resolve_assignments_for_maintenance_item`	Free	Read-only	[ImmyBot] Resolve which tenants a given maintenance item's deployments apply to (a read-only what-resolves query, sent as an HTTP POST). Provide a JSON object body describing the maintenance item / criteria. Returns the resolved tenant assignments; makes no changes.
`immy_tenants_set_parent_tenant`	Pro	Write	[ImmyBot] Set the parent-tenant link on one or more tenants, placing them under a parent in the tenant hierarchy. Provide a JSON object body identifying the child tenant id(s) and the parent tenant id (from immy_list_tenants). Remove the link with immy_tenants_remove_parent_tenant.
`immy_tenants_update_azure_tenant_link`	Pro	Write	[ImmyBot] Link (or update the link for) an ImmyBot tenant to a Microsoft Azure (Entra) tenant, enabling Azure-group inspection (immy_list_tenants_azure_groups) and Azure-scoped automation. Provide a JSON object body with the ImmyBot tenant id and the Azure tenant domain/GUID.
`immy_update_tenants`	Pro	Write	[ImmyBot] Update a tenant by id (from immy_list_tenants). Sent as an HTTP PUT to /tenants/ — provide the full JSON object body of tenant fields to set. For activation/parent-link changes use the dedicated tools (immy_patch_tenants_activate, immy_tenants_set_parent_tenant).

immy_add_tags_to_tenants parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the tenant id(s) and tag id(s) to add.

immy_get_tenants parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the tenant (from immy_list_tenants).

immy_get_tenants_azure_groups parameters

Param	Type	Required	Default	Description
`groupId`	string	yes		The id of the Azure group (from immy_list_tenants_azure_groups).
`id`	string	yes		The id of the tenant (from immy_list_tenants).

immy_get_tenants_software_from_inventory parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the software-from-inventory record (from immy_list_tenants_software_from_inventory_dx).

immy_list_tenants parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Name@=acme". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "Name" or "-Name" (descending). Omit for the default order.

immy_list_tenants_azure_groups parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`id`	string	yes		The id of the tenant (from immy_list_tenants).
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_tenants_computer_counts parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_tenants_computers_excluded_from_maintenance parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`id`	string	yes		The id of the tenant (from immy_list_tenants).
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_tenants_excluded_from_cross_tenant_deployments parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_tenants_software_from_inventory_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response. Omit to skip counting.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Omit to start at 0.
`sort`	string	no	null	DevExtreme sort expression (JSON). Omit for the default order.
`take`	integer	no	null	Number of records to take (DevExtreme take). Max 100; omit for the server default.

immy_list_tenants_software_from_inventory_export parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression to narrow the exported rows. Omit to export all.
`sorts`	string	no	null	Sieve sort expression for the exported rows. Omit for the default order.

immy_patch_tenants_activate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of activation options. Defaults to an empty object ().
`id`	string	yes		The id of the tenant to activate (from immy_list_tenants).

immy_patch_tenants_deactivate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of deactivation options. Defaults to an empty object ().
`id`	string	yes		The id of the tenant to deactivate (from immy_list_tenants).

immy_remove_tags_from_tenants parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the tenant id(s) and tag id(s) to remove.

immy_tenants parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new tenant (e.g. { "name": "Acme Corp" }).

immy_tenants_bulk_create parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the tenants to create (e.g. { "tenants": [ { "name": "Acme" } ] }).

immy_tenants_bulk_delete parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the tenant id(s) to permanently delete (from immy_list_tenants).

immy_tenants_bulk_merge parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the source and target tenant id(s) to merge (from immy_list_tenants).

immy_tenants_remove_parent_tenant parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the tenant id(s) whose parent link to remove (from immy_list_tenants).

immy_tenants_resolve_assignments_for_maintenance_item parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the maintenance item / resolution criteria.

immy_tenants_set_parent_tenant parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the child tenant id(s) and the parent tenant id (from immy_list_tenants).

immy_tenants_update_azure_tenant_link parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the ImmyBot tenant id and the Azure tenant (domain or GUID) to link.

immy_update_tenants parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body of tenant fields to set (full replace).
`id`	string	yes		The id of the tenant to update (from immy_list_tenants).

Provider Links

Tool	Plan	Access	Description
`immy_delete_provider_links`	Pro	Destructive	[ImmyBot] Permanently delete a provider link by its id (from immy_list_provider_links). This removes the integration and its client/asset mappings — destructive and not reversible. Confirm the id belongs to the link you intend to remove.
`immy_get_provider_links`	Free	Read-only	[ImmyBot] Get a single provider link by its id (from immy_list_provider_links). Returns the link's full configuration — provider type, name, credentials metadata, sync settings, and status.
`immy_get_provider_links_tickets`	Free	Read-only	[ImmyBot] Get a single ticket from the PSA provider behind a provider link (from immy_list_provider_links), identified by the provider's ticket id. Returns the ticket as the external provider reports it.
`immy_get_rmm_links`	Free	Read-only	[ImmyBot] Get a single RMM link by its id (from immy_list_rmm_links) — the RMM-scoped view of a provider link.
`immy_installer_agent_rekey_request`	Pro	Write	[ImmyBot] Request a rekey of an ImmyBot agent installer (rotate the agent's key material for re-enrollment). Provide the request parameters as a JSON object in bodyJson. This is a host-rooted installer endpoint (/installer/agent-rekey/request).
`immy_list_provider_links`	Free	Read-only	[ImmyBot] List the provider links (integrations to external RMM / PSA / documentation providers) configured in this ImmyBot instance. Returns each link's id, provider type, name, and status. Link ids feed immy_get_provider_links, immy_update_provider_links, immy_delete_provider_links, and every asset/client/agent tool. Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts. See immy_list_provider_links_with_unmapped_clients for links that still have unmapped clients.
`immy_list_provider_links_audits`	Free	Read-only	[ImmyBot] List the audit-log entries for a provider link (from immy_list_provider_links) — configuration changes, sync events, and errors over time. Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts.
`immy_list_provider_links_immy_field_samples`	Free	Read-only	[ImmyBot] List sample values for the ImmyBot-side fields available when configuring asset field mappings on a provider link (from immy_list_provider_links). Use alongside immy_list_provider_links_asset_fields (the external side) to build field mappings via immy_provider_links_asset_field_mappings.
`immy_list_provider_links_with_unmapped_clients`	Free	Read-only	[ImmyBot] List provider links that still have external clients not yet mapped to an ImmyBot tenant. Use this to find links needing client-linking work (see immy_provider_links_clients_* in the Provider Clients group). Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts.
`immy_list_rmm_links`	Free	Read-only	[ImmyBot] List provider links filtered to the RMM-capable providers only (a filtered alias view over immy_list_provider_links). Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts. Create/update RMM links via immy_rmm_links / immy_update_rmm_links.
`immy_plugin_proxy_get`	Free	Read-only	[ImmyBot] Open-world proxy: forward a GET request to a provider plugin's own API under the given provider link (from immy_list_provider_links). The catchAll sub-path and optional raw query string are passed VERBATIM to the plugin (path is host-rooted at /plugins/api/v1//); the plugin defines its own routes and response shape. Use only when a dedicated ImmyBot tool does not cover the plugin capability you need.
`immy_plugin_proxy_post`	Pro	Write	[ImmyBot] Open-world proxy: forward a POST request to a provider plugin's own API under the given provider link (from immy_list_provider_links). The catchAll sub-path is passed VERBATIM (host-rooted at /plugins/api/v1//) and bodyJson becomes the request body; the plugin defines its own routes, semantics, and response shape. This can mutate provider-side state — use only when a dedicated ImmyBot tool does not cover the capability.
`immy_provider_links`	Pro	Write	[ImmyBot] Create a provider link (a new integration to an external RMM / PSA / documentation provider). Provide the link definition as a JSON object in bodyJson — the required fields (provider type, name, credentials) depend on the provider; discover available provider types via immy_list_provider_types. For linking against an existing external provider reference, use immy_provider_links_create_with_external_provider_reference instead.
`immy_provider_links_create_with_external_provider_reference`	Pro	Write	[ImmyBot] Create a provider link from an existing external provider reference (e.g. an Azure/partner reference already known to ImmyBot). Provide the reference and link settings as a JSON object in bodyJson. Use immy_provider_links_verify_with_external_provider_reference first to validate the reference resolves before creating.
`immy_provider_links_reload`	Pro	Write	[ImmyBot] Reload a provider link by its id (from immy_list_provider_links) — reinitialize the plugin/integration and refresh its cached state. Provide any reload options as a JSON object in bodyJson (send if none).
`immy_provider_links_verify_with_external_provider_reference`	Pro	Write	[ImmyBot] Verify that an external provider reference resolves and can back a provider link, WITHOUT creating anything. Provide the reference as a JSON object in bodyJson. This is a validation call that may perform an outbound check against the provider — classified as a write. Follow with immy_provider_links_create_with_external_provider_reference to persist the link.
`immy_rmm_links`	Pro	Write	[ImmyBot] Create an RMM provider link (the RMM-scoped create path; a provider link whose provider is an RMM). Provide the link definition as a JSON object in bodyJson. See immy_list_rmm_links for the filtered view of existing RMM links.
`immy_update_provider_links`	Pro	Write	[ImmyBot] Update a provider link by its id (from immy_list_provider_links). Provide the full replacement definition as a JSON object in bodyJson (PUT semantics — send the complete link object, not a partial patch).
`immy_update_rmm_links`	Pro	Write	[ImmyBot] Update an RMM link by its id (from immy_list_rmm_links). Provide the full replacement definition as a JSON object in bodyJson (PUT semantics).

immy_delete_provider_links parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id to delete (from immy_list_provider_links).

immy_get_provider_links parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_get_provider_links_tickets parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).
`ticketId`	string	yes		The external provider's ticket id.

immy_get_rmm_links parameters

Param	Type	Required	Default	Description
`id`	string	yes		The RMM link id (from immy_list_rmm_links).

immy_installer_agent_rekey_request parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the agent-rekey request parameters.

immy_list_provider_links parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression, e.g. "Name@=acme". Optional.
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression, e.g. "-CreatedDate". Optional.

immy_list_provider_links_audits parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`id`	string	yes		The provider link id (from immy_list_provider_links).
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_links_immy_field_samples parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_list_provider_links_with_unmapped_clients parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_rmm_links parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_plugin_proxy_get parameters

Param	Type	Required	Default	Description
`catchAll`	string	yes		The plugin-defined sub-path, forwarded verbatim (may contain slashes), e.g. "devices/123/status".
`providerLinkId`	string	yes		The provider link id that owns the plugin (from immy_list_provider_links).
`query`	string	no	null	Optional raw query string WITHOUT a leading '?', e.g. "limit=50&active=true". Omit if none.

immy_plugin_proxy_post parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON request body forwarded to the plugin.
`catchAll`	string	yes	The plugin-defined sub-path, forwarded verbatim (may contain slashes).
`providerLinkId`	string	yes	The provider link id that owns the plugin (from immy_list_provider_links).

immy_provider_links parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object describing the new provider link (provider type, name, credentials, sync settings).

immy_provider_links_create_with_external_provider_reference parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the external provider reference and link settings.

immy_provider_links_reload parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object of reload options, or if none.
`id`	string	yes		The provider link id to reload (from immy_list_provider_links).

immy_provider_links_verify_with_external_provider_reference parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the external provider reference to verify.

immy_rmm_links parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object describing the new RMM link.

immy_update_provider_links parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the full replacement provider-link definition.
`id`	string	yes		The provider link id to update (from immy_list_provider_links).

immy_update_rmm_links parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object with the full replacement RMM-link definition.
`id`	string	yes		The RMM link id to update (from immy_list_rmm_links).

Provider Link Assets

Tool	Plan	Access	Description
`immy_delete_provider_links_asset_field_mappings`	Pro	Destructive	[ImmyBot] Permanently delete an asset field mapping from a provider link. Identify it by the provider link id (from immy_list_provider_links) and the mapping id (from immy_list_provider_links_asset_field_mappings). Destructive and not reversible.
`immy_delete_provider_links_asset_match_fields`	Pro	Destructive	[ImmyBot] Permanently delete an asset match field from a provider link. Identify it by the provider link id (from immy_list_provider_links) and the match field id (from immy_list_provider_links_asset_match_fields). Destructive and not reversible — removing a matcher can change how future syncs match assets to computers.
`immy_list_provider_links_asset_field_mappings`	Free	Read-only	[ImmyBot] List the asset field mappings configured on a provider link (from immy_list_provider_links) — each mapping ties an external provider field to an ImmyBot field. Mapping ids feed immy_update_provider_links_asset_field_mappings and immy_delete_provider_links_asset_field_mappings. Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts.
`immy_list_provider_links_asset_fields`	Free	Read-only	[ImmyBot] List the external asset fields exposed by the provider behind a provider link (from immy_list_provider_links) — the source side of an asset field mapping. Each field's external id feeds immy_list_provider_links_asset_fields_samples. Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts.
`immy_list_provider_links_asset_fields_samples`	Free	Read-only	[ImmyBot] List sample values for a single external asset field on a provider link — helps you preview what data a field carries before mapping it. Identify the field by the provider link id (from immy_list_provider_links) and the external field id (from immy_list_provider_links_asset_fields).
`immy_list_provider_links_asset_match_fields`	Free	Read-only	[ImmyBot] List the asset match fields configured on a provider link (from immy_list_provider_links) — the fields used to match external assets to ImmyBot computers during sync. Match-field ids feed immy_update_provider_links_asset_match_fields and immy_delete_provider_links_asset_match_fields. See immy_list_provider_links_asset_match_fields_recommended for suggested matchers. Sieve pagination: Page (1-based), pageSize (capped at 100), Filters, Sorts.
`immy_list_provider_links_asset_match_fields_recommended`	Free	Read-only	[ImmyBot] List the recommended asset match fields for a provider link (from immy_list_provider_links) — ImmyBot's suggested matchers based on the provider's field schema. Use as a starting point before creating match fields via immy_provider_links_asset_match_fields.
`immy_list_provider_links_assets_dx`	Free	Read-only	[ImmyBot] List the synced assets for a provider link (from immy_list_provider_links) as a DevExtreme grid feed. Uses DevExtreme paging: skip + take (take capped at 100), with optional filter and sort passthrough and requireTotalCount. Each asset's external id feeds immy_list_provider_links_assets_url.
`immy_list_provider_links_assets_job_state`	Free	Read-only	[ImmyBot] Get the current asset-sync job state for a provider link (from immy_list_provider_links) — whether a sync is running, queued, or idle, plus progress/last-result metadata. Trigger a sync with immy_provider_links_assets_trigger.
`immy_list_provider_links_assets_schedule`	Free	Read-only	[ImmyBot] Get the asset-sync schedule for a provider link (from immy_list_provider_links) — the cadence at which ImmyBot re-syncs assets from the external provider.
`immy_list_provider_links_assets_url`	Free	Read-only	[ImmyBot] Get the external provider URL for a single synced asset — the deep link into the provider's UI for that asset. Identify it by the provider link id (from immy_list_provider_links) and the external asset id (from immy_list_provider_links_assets_dx).
`immy_provider_links_asset_field_mappings`	Pro	Write	[ImmyBot] Create an asset field mapping on a provider link (from immy_list_provider_links) — tie one external provider field to one ImmyBot field. Provide the mapping as a JSON object in bodyJson (external field id from immy_list_provider_links_asset_fields, ImmyBot field from immy_list_provider_links_immy_field_samples).
`immy_provider_links_asset_match_fields`	Pro	Write	[ImmyBot] Create an asset match field on a provider link (from immy_list_provider_links) — a field used to match external assets to ImmyBot computers during sync. Provide the match field as a JSON object in bodyJson (see immy_list_provider_links_asset_match_fields_recommended for suggestions).
`immy_provider_links_assets_trigger`	Pro	Write	[ImmyBot] Trigger an on-demand asset sync for a provider link (from immy_list_provider_links) — pull the latest assets from the external provider now instead of waiting for the schedule. Provide any trigger options as a JSON object in bodyJson (send if none). Poll progress with immy_list_provider_links_assets_job_state.
`immy_update_provider_links_asset_field_mappings`	Pro	Write	[ImmyBot] Update an existing asset field mapping on a provider link. Identify it by the provider link id (from immy_list_provider_links) and the mapping id (from immy_list_provider_links_asset_field_mappings). Provide the full replacement mapping as a JSON object in bodyJson (PUT semantics).
`immy_update_provider_links_asset_match_fields`	Pro	Write	[ImmyBot] Update an existing asset match field on a provider link. Identify it by the provider link id (from immy_list_provider_links) and the match field id (from immy_list_provider_links_asset_match_fields). Provide the full replacement definition as a JSON object in bodyJson (PUT semantics).

immy_delete_provider_links_asset_field_mappings parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).
`mappingId`	string	yes		The asset field mapping id to delete (from immy_list_provider_links_asset_field_mappings).

immy_delete_provider_links_asset_match_fields parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).
`matchFieldId`	string	yes		The asset match field id to delete (from immy_list_provider_links_asset_match_fields).

immy_list_provider_links_asset_field_mappings parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`id`	string	yes		The provider link id (from immy_list_provider_links).
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_links_asset_fields parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`id`	string	yes		The provider link id (from immy_list_provider_links).
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_links_asset_fields_samples parameters

Param	Type	Required	Default	Description
`externalFieldId`	string	yes		The external asset field id (from immy_list_provider_links_asset_fields).
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_list_provider_links_asset_match_fields parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`id`	string	yes		The provider link id (from immy_list_provider_links).
`page`	integer	no	null	1-based page number (Sieve). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize); capped server-side at 100.
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_links_asset_match_fields_recommended parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_list_provider_links_assets_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form), forwarded verbatim. Optional.
`id`	string	yes		The provider link id (from immy_list_provider_links).
`requireTotalCount`	boolean	no	null	DevExtreme requireTotalCount — set true to include the total row count. Optional.
`skip`	integer	no	null	DevExtreme skip (records to skip). Omit for the start.
`sort`	string	no	null	DevExtreme sort expression (JSON array form), forwarded verbatim. Optional.
`take`	integer	no	null	DevExtreme take (records to return); capped server-side at 100.

immy_list_provider_links_assets_job_state parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_list_provider_links_assets_schedule parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_list_provider_links_assets_url parameters

Param	Type	Required	Default	Description
`externalAssetId`	string	yes		The external asset id (from immy_list_provider_links_assets_dx).
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_provider_links_asset_field_mappings parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object describing the new asset field mapping.
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_provider_links_asset_match_fields parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object describing the new asset match field.
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_provider_links_assets_trigger parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object of trigger options, or if none.
`id`	string	yes		The provider link id (from immy_list_provider_links).

immy_update_provider_links_asset_field_mappings parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON object with the full replacement mapping definition.
`id`	string	yes	The provider link id (from immy_list_provider_links).
`mappingId`	string	yes	The asset field mapping id (from immy_list_provider_links_asset_field_mappings).

immy_update_provider_links_asset_match_fields parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON object with the full replacement match-field definition.
`id`	string	yes	The provider link id (from immy_list_provider_links).
`matchFieldId`	string	yes	The asset match field id (from immy_list_provider_links_asset_match_fields).

Provider Agents

Tool	Plan	Access	Description
`immy_list_provider_agents_identification_logs`	Free	Read-only	[ImmyBot] List the identification logs for a single provider agent, by agentId (from immy_list_provider_agents_pending). Shows how ImmyBot attempted to match this agent to a computer/tenant and why it succeeded or failed — the primary evidence when resolving an identification failure with immy_provider_agents_resolve_failure. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts).
`immy_list_provider_agents_pending`	Free	Read-only	[ImmyBot] List provider agents that are pending identification — agents discovered through a provider link (RMM/PSA integration) that ImmyBot has not yet matched to a managed computer/tenant. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Match them with immy_provider_agents_identify, or clear them with immy_provider_agents_bulk_delete_pending. See immy_list_provider_agents_pending_counts for a quick total.
`immy_list_provider_agents_pending_conflicts`	Free	Read-only	[ImmyBot] List the pending provider-agent conflicts for a specific computer, by computerId (from immy_list_computers). A conflict is when more than one pending provider agent could map to the same computer; this shows the competing candidates so you can pick the right one before identifying. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts).
`immy_list_provider_agents_pending_counts`	Free	Read-only	[ImmyBot] Get the count of provider agents pending identification, broken down (e.g. per provider link). A lightweight summary companion to immy_list_provider_agents_pending — use it to decide whether identification work is needed before paging the full list.
`immy_provider_agents_bulk_delete_pending`	Pro	Destructive	[ImmyBot] Permanently delete a set of pending (unidentified) provider agents in one call. Provide a JSON body listing the pending agent ids to remove. This clears them from the pending queue and cannot be undone — use it for stale/duplicate discoveries rather than agents you still intend to identify with immy_provider_agents_identify.
`immy_provider_agents_identify`	Pro	Write	[ImmyBot] Identify one or more pending provider agents — match each discovered agent to a managed computer/tenant so ImmyBot can manage it. Provide a JSON body describing the agent(s) and the target computer/mapping. Review candidates first with immy_list_provider_agents_pending and immy_list_provider_agents_pending_conflicts.
`immy_provider_agents_resolve_failure`	Pro	Write	[ImmyBot] Resolve a single provider-agent identification failure, by failureId. Provide a JSON body describing the resolution (e.g. the correct computer/tenant mapping to apply). Inspect the failure evidence first with immy_list_provider_agents_identification_logs. To resolve every failure at once use immy_resolve_provider_agent_failures; to resolve all failures for one agent use immy_resolve_agent_failures_for_agent.
`immy_resolve_agent_failures_for_agent`	Pro	Write	[ImmyBot] Resolve all identification failures for one provider agent, by agentId (from immy_list_provider_agents_pending). Provide a JSON body describing the resolution. Scopes the fix to a single agent — for a specific failure use immy_provider_agents_resolve_failure, for every agent use immy_resolve_provider_agent_failures.
`immy_resolve_provider_agent_failures`	Pro	Write	[ImmyBot] Resolve provider-agent identification failures in bulk. Provide a JSON body describing the resolution to apply across the failures. For a single failure use immy_provider_agents_resolve_failure; to scope resolution to one agent use immy_resolve_agent_failures_for_agent.

immy_list_provider_agents_identification_logs parameters

Param	Type	Required	Default	Description
`agentId`	string	yes		The provider agent id, from immy_list_provider_agents_pending.
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_agents_pending parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_agents_pending_conflicts parameters

Param	Type	Required	Default	Description
`computerId`	string	yes		The computer id, from immy_list_computers.
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_provider_agents_bulk_delete_pending parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body listing the pending provider-agent ids to delete.

immy_provider_agents_identify parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the agent(s) to identify and the target computer/mapping.

immy_provider_agents_resolve_failure parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the resolution to apply.
`failureId`	string	yes		The identification-failure id to resolve.

immy_resolve_agent_failures_for_agent parameters

Param	Type	Required	Default	Description
`agentId`	string	yes		The provider agent id, from immy_list_provider_agents_pending.
`bodyJson`	string	yes		JSON body describing the resolution to apply for this agent.

immy_resolve_provider_agent_failures parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the bulk resolution to apply.

Provider Clients & Agents

Tool	Plan	Access	Description
`immy_delete_provider_links_cross_references_delete`	Pro	Destructive	[ImmyBot] Permanently delete a provider-link cross-reference, by provider-link id (from immy_list_provider_links) and externalLinkId. Removes the external link tying another system's records to this provider link and cannot be undone. Create one with immy_provider_links_cross_references_create.
`immy_list_provider_links_clients`	Free	Read-only	[ImmyBot] List the external clients a provider link exposes, by provider-link id (from immy_list_provider_links, S8). These are the RMM/PSA-side customers/organizations available to map onto ImmyBot tenants. Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Map them with immy_provider_links_clients_link_to_tenant / _auto_link_to_tenants; see immy_list_provider_links_clients_statuses for linking state.
`immy_list_provider_links_clients_statuses`	Free	Read-only	[ImmyBot] List the linking status of each client on a provider link, by provider-link id (from immy_list_provider_links). Shows which external clients are linked, unlinked, or in conflict with ImmyBot tenants — the state map you use before running a linking action. Companion to immy_list_provider_links_clients.
`immy_list_provider_links_clients_types`	Free	Read-only	[ImmyBot] List the client types a provider link supports, by provider-link id (from immy_list_provider_links). Client types describe the categories of external client the integration can expose; use them to filter or interpret immy_list_provider_links_clients.
`immy_provider_agent_onboarding_powershell_install_script`	Pro	Write	[ImmyBot] Generate a PowerShell (Windows) install script for the provider link's agent that also triggers ImmyBot onboarding on first run, by provider-link id (from immy_list_provider_links). Provide a JSON body with the script/target + onboarding options. Non-onboarding variant: immy_provider_links_agents_powershell_install_script.
`immy_provider_agent_onboarding_provisioning_package_uri`	Pro	Write	[ImmyBot] Get a download URI for a Windows provisioning-package (.ppkg) installer for the provider link's agent that also triggers ImmyBot onboarding on first run, by provider-link id (from immy_list_provider_links). Provide a JSON body with the target + onboarding options. Non-onboarding variant: immy_provider_links_agents_provisioning_package_uri.
`immy_provider_links_agents_bash_install_script`	Pro	Write	[ImmyBot] Generate a bash (macOS/Linux) install script for the provider link's agent, by provider-link id (from immy_list_provider_links). Provide a JSON body with the script/target options; returns the ready-to-run installer text. For the onboarding-enabled variant use immy_provider_links_agents_bash_install_script_with_onboarding; for Windows use immy_provider_links_agents_powershell_install_script.
`immy_provider_links_agents_bash_install_script_with_onboarding`	Pro	Write	[ImmyBot] Generate a bash (macOS/Linux) install script for the provider link's agent that also triggers ImmyBot onboarding on first run, by provider-link id (from immy_list_provider_links). Provide a JSON body with the script/target and onboarding options. Non-onboarding variant: immy_provider_links_agents_bash_install_script.
`immy_provider_links_agents_delete_offline_agent_from_computer`	Pro	Destructive	[ImmyBot] Permanently remove an offline provider agent from a computer, by provider-link id (from immy_list_provider_links) and agentId. Provide a JSON body identifying the computer/agent. This deletes the agent association on the RMM/PSA side for a device that is no longer online and cannot be undone — use it to clean up dead agents, not to temporarily pause management.
`immy_provider_links_agents_executable_uri`	Pro	Write	[ImmyBot] Get a download URI for the provider link's agent executable installer, by provider-link id (from immy_list_provider_links). Provide a JSON body with the target options; returns the URI to fetch the installer binary. For the onboarding-enabled variant use immy_provider_links_agents_executable_uri_with_onboarding.
`immy_provider_links_agents_executable_uri_with_onboarding`	Pro	Write	[ImmyBot] Get a download URI for the provider link's agent executable installer that also triggers ImmyBot onboarding on first run, by provider-link id (from immy_list_provider_links). Provide a JSON body with the target + onboarding options. Non-onboarding variant: immy_provider_links_agents_executable_uri.
`immy_provider_links_agents_external_agent_url`	Pro	Write	[ImmyBot] Get the external RMM/PSA console URL for a computer's agent, by provider-link id (from immy_list_provider_links) and computerId (from immy_list_computers). Provide a JSON body with any options; returns the deep-link into the provider's own portal for that device. A write in the API (it may resolve/refresh the link) though its purpose is retrieval.
`immy_provider_links_agents_install_on_computer`	Pro	Write	[ImmyBot] Install the provider link's agent directly onto a specific managed computer, by provider-link id (from immy_list_provider_links) and computerId (from immy_list_computers). Provide a JSON body with the install options. Unlike the script/URI generators, this dispatches the install to the target computer.
`immy_provider_links_agents_powershell_install_script`	Pro	Write	[ImmyBot] Generate a PowerShell (Windows) install script for the provider link's agent, by provider-link id (from immy_list_provider_links). Provide a JSON body with the script/target options; returns the ready-to-run installer text. For the onboarding-enabled variant use immy_provider_agent_onboarding_powershell_install_script; for macOS/Linux use immy_provider_links_agents_bash_install_script.
`immy_provider_links_agents_provisioning_package_uri`	Pro	Write	[ImmyBot] Get a download URI for a Windows provisioning-package (.ppkg) installer for the provider link's agent, by provider-link id (from immy_list_provider_links). Provide a JSON body with the target options. For the onboarding-enabled variant use immy_provider_agent_onboarding_provisioning_package_uri.
`immy_provider_links_agents_refresh_device_online_status`	Pro	Write	[ImmyBot] Refresh the online/offline status of a provider agent's device, by provider-link id (from immy_list_provider_links) and agentId. Provide a JSON body identifying the device. Forces ImmyBot to re-check the RMM/PSA for the device's current connectivity rather than waiting for the next sync.
`immy_provider_links_agents_sync`	Pro	Write	[ImmyBot] Trigger a sync of the provider link's agents, by provider-link id (from immy_list_provider_links). Provide a JSON body with any sync options. Pulls the current agent inventory from the RMM/PSA so ImmyBot's view is up to date; feeds the pending-identification queue (see immy_list_provider_agents_pending). See also immy_provider_links_clients_sync_agents to sync agents per linked client.
`immy_provider_links_clients_auto_link_to_tenants`	Pro	Write	[ImmyBot] Automatically link a provider link's external clients to ImmyBot tenants using ImmyBot's matching heuristics, by provider-link id (from immy_list_provider_links). Provide a JSON body with the auto-link options. For a stricter exact-name match use immy_provider_links_clients_link_exact_match_clients; to map one client explicitly use immy_provider_links_clients_link_to_tenant.
`immy_provider_links_clients_link_exact_match_clients`	Pro	Write	[ImmyBot] Link only the provider clients whose names exactly match an existing ImmyBot tenant, by provider-link id (from immy_list_provider_links). Provide a JSON body with the options. A conservative alternative to immy_provider_links_clients_auto_link_to_tenants — links high-confidence matches and leaves ambiguous ones for manual mapping.
`immy_provider_links_clients_link_to_new_tenant`	Pro	Write	[ImmyBot] Create a new ImmyBot tenant and link a provider client to it in one step, by provider-link id (from immy_list_provider_links). Provide a JSON body identifying the client and the new tenant details. Use this when the external client has no matching ImmyBot tenant yet; to link to an existing tenant use immy_provider_links_clients_link_to_tenant.
`immy_provider_links_clients_link_to_tenant`	Pro	Write	[ImmyBot] Link a provider client to a specific existing ImmyBot tenant, by provider-link id (from immy_list_provider_links). Provide a JSON body identifying the client and target tenant (from immy_list_tenants). The explicit, one-to-one alternative to the auto/exact-match linkers. Reverse with immy_provider_links_clients_unlink_from_tenants.
`immy_provider_links_clients_sync`	Pro	Write	[ImmyBot] Trigger a sync of the provider link's clients, by provider-link id (from immy_list_provider_links). Provide a JSON body with any sync options. Refreshes the external client list from the RMM/PSA so linking decisions act on current data; see immy_list_provider_links_clients for the result and immy_provider_links_clients_sync_agents to also sync agents.
`immy_provider_links_clients_sync_agents`	Pro	Write	[ImmyBot] Sync the agents belonging to the provider link's linked clients, by provider-link id (from immy_list_provider_links). Provide a JSON body with any options. Narrower than immy_provider_links_agents_sync — it refreshes agent inventory scoped to already-linked clients.
`immy_provider_links_clients_unlink_from_tenants`	Pro	Write	[ImmyBot] Unlink provider clients from their ImmyBot tenants, by provider-link id (from immy_list_provider_links). Provide a JSON body identifying which client links to remove. Reverses immy_provider_links_clients_link_to_tenant / _auto_link_to_tenants; the external clients remain but are no longer mapped to tenants.
`immy_provider_links_cross_references_create`	Pro	Write	[ImmyBot] Create a cross-reference on a provider link — an external link that ties another provider/system's records to this provider link, by provider-link id (from immy_list_provider_links). Provide a JSON body describing the external reference. Toggle its client-linking with immy_provider_links_cross_references_enable_client_linking / _disable_client_linking; remove it with immy_delete_provider_links_cross_references_delete.
`immy_provider_links_cross_references_disable_client_linking`	Pro	Write	[ImmyBot] Disable client linking for a provider-link cross-reference, by provider-link id (from immy_list_provider_links) and externalLinkId. Provide a JSON body with any options. Stops the cross-reference from driving client-to-tenant linking. Re-enable with immy_provider_links_cross_references_enable_client_linking.
`immy_provider_links_cross_references_enable_client_linking`	Pro	Write	[ImmyBot] Enable client linking for a provider-link cross-reference, by provider-link id (from immy_list_provider_links) and externalLinkId. Provide a JSON body with any options. Allows the cross-reference to drive client-to-tenant linking. Disable with immy_provider_links_cross_references_disable_client_linking.
`immy_provider_links_cross_references_sync_clients`	Pro	Write	[ImmyBot] Sync the clients associated with a provider-link cross-reference, by provider-link id (from immy_list_provider_links) and externalLinkId. Provide a JSON body with any options. Refreshes the client data flowing through this specific cross-reference; broader syncs are immy_provider_links_clients_sync.

immy_delete_provider_links_cross_references_delete parameters

Param	Type	Required	Default	Description
`externalLinkId`	string	yes		The external-link (cross-reference) id to delete.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_list_provider_links_clients parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`id`	string	yes		The provider-link id, from immy_list_provider_links.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_links_clients_statuses parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_list_provider_links_clients_types parameters

Param	Type	Required	Default	Description
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_agent_onboarding_powershell_install_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the install-script + onboarding options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_agent_onboarding_provisioning_package_uri parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the provisioning-package + onboarding options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_bash_install_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the install-script generation options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_bash_install_script_with_onboarding parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the install-script + onboarding options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_delete_offline_agent_from_computer parameters

Param	Type	Required	Description
`agentId`	string	yes	The provider agent id to delete.
`bodyJson`	string	yes	JSON body identifying the target computer/agent.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_executable_uri parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the executable-installer target options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_executable_uri_with_onboarding parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the executable-installer + onboarding options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_external_agent_url parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with any options (may be an empty object).
`computerId`	string	yes	The computer id, from immy_list_computers.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_install_on_computer parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with the install options.
`computerId`	string	yes	The target computer id, from immy_list_computers.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_powershell_install_script parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the install-script generation options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_provisioning_package_uri parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the provisioning-package target options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_refresh_device_online_status parameters

Param	Type	Required	Description
`agentId`	string	yes	The provider agent id whose device online status to refresh.
`bodyJson`	string	yes	JSON body identifying the device.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_agents_sync parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with sync options (may be an empty object).
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_auto_link_to_tenants parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the auto-link options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_link_exact_match_clients parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with the exact-match link options.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_link_to_new_tenant parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the client and the new tenant to create.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_link_to_tenant parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the client and the target tenant.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_sync parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with sync options (may be an empty object).
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_sync_agents parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body with sync options (may be an empty object).
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_clients_unlink_from_tenants parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body identifying the client links to remove.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_cross_references_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body describing the cross-reference to create.
`id`	string	yes		The provider-link id, from immy_list_provider_links.

immy_provider_links_cross_references_disable_client_linking parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with any options (may be an empty object).
`externalLinkId`	string	yes	The external-link (cross-reference) id.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_cross_references_enable_client_linking parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with any options (may be an empty object).
`externalLinkId`	string	yes	The external-link (cross-reference) id.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

immy_provider_links_cross_references_sync_clients parameters

Param	Type	Required	Description
`bodyJson`	string	yes	JSON body with any options (may be an empty object).
`externalLinkId`	string	yes	The external-link (cross-reference) id.
`id`	string	yes	The provider-link id, from immy_list_provider_links.

Provider Types

Tool	Plan	Access	Description
`immy_get_provider_types_form_dropdown_options`	Free	Read-only	[ImmyBot] Get the option set for a provider-type configuration-form dropdown, by its key. Provider-link configuration forms populate certain fields from server-side option lists; this returns the valid choices for one such field so you can supply a correct value when creating/updating a provider link (S8).
`immy_list_provider_types`	Free	Read-only	[ImmyBot] List the available provider types — the kinds of external RMM/PSA integration a provider link can be created against (e.g. the supported vendor integrations). Supports Sieve paging (Page, pageSize up to 100, Filters, Sorts). Use the returned type keys when creating a provider link with immy_provider_links (S8).
`immy_list_provider_types_client_group_types_client_groups`	Free	Read-only	[ImmyBot] List the client groups available for a given client-group-type, by clientGroupTypeId (from immy_list_provider_types metadata). Client groups are how a provider type organizes its customer/tenant containers; use them when configuring how a provider link maps external clients to ImmyBot tenants.
`immy_list_provider_types_device_group_types_device_groups`	Free	Read-only	[ImmyBot] List the device groups available for a given device-group-type, by deviceGroupTypeId (from immy_list_provider_types metadata). Device groups are how a provider type organizes its endpoint/device containers; use them when configuring how a provider link maps external devices to ImmyBot computers.
`immy_provider_types_bind_parameters`	Free	Read-only	[ImmyBot] Preview how a set of configuration parameters binds for a given provider type, by providerType. POST-as-read: provide a JSON body of the parameter values; ImmyBot resolves/validates them and returns the bound result without saving anything. Use it to sanity-check provider-link configuration before creating the link with immy_provider_links (S8).

immy_get_provider_types_form_dropdown_options parameters

Param	Type	Required	Default	Description
`key`	string	yes		The dropdown option-set key, as referenced by the provider-type configuration form.

immy_list_provider_types parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve Filters expression. Optional.
`page`	integer	no	null	Page number (Sieve, 1-based).
`pageSize`	integer	no	null	Records per page (Sieve pageSize; max 100).
`sorts`	string	no	null	Sieve Sorts expression. Optional.

immy_list_provider_types_client_group_types_client_groups parameters

Param	Type	Required	Default	Description
`clientGroupTypeId`	string	yes		The client-group-type id, from the provider-type metadata in immy_list_provider_types.

immy_list_provider_types_device_group_types_device_groups parameters

Param	Type	Required	Default	Description
`deviceGroupTypeId`	string	yes		The device-group-type id, from the provider-type metadata in immy_list_provider_types.

immy_provider_types_bind_parameters parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body of the parameter values to bind (preview only, nothing is saved).
`providerType`	string	yes		The provider type key/identifier, from immy_list_provider_types.

Personal Access Tokens

Tool	Plan	Access	Description
`immy_delete_personal_access_tokens`	Pro	Destructive	[ImmyBot] Permanently revoke the personal access token identified by id (from immy_list_personal_access_tokens / immy_list_personal_access_tokens_all). Any integration still using the token immediately loses API access; this cannot be undone.
`immy_list_personal_access_tokens`	Free	Read-only	[ImmyBot] List the personal access tokens (PATs) belonging to the current user. Paginated via Sieve: page (1-based) + pageSize (max 100); filters/sorts accept Sieve expressions. To see every user's PATs across the instance (admin view) use immy_list_personal_access_tokens_all. Create a PAT with immy_personal_access_tokens; revoke one with immy_delete_personal_access_tokens.
`immy_list_personal_access_tokens_all`	Free	Read-only	[ImmyBot] List ALL personal access tokens across every user in the instance (administrator view) — use this to audit outstanding API tokens. For only the current user's tokens use immy_list_personal_access_tokens. Paginated via Sieve: page + pageSize (max 100), filters/sorts accept Sieve expressions.
`immy_personal_access_tokens`	Pro	Write	[ImmyBot] Create a new personal access token (PAT). Provide a JSON object body — typically a name/description and optional expiration. The response includes the generated token secret, which is shown only once; store it securely. Revoke with immy_delete_personal_access_tokens.

immy_delete_personal_access_tokens parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the personal access token to revoke (from immy_list_personal_access_tokens).

immy_list_personal_access_tokens parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Name@=deploy". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "-CreatedDate". Omit for the default order.

immy_list_personal_access_tokens_all parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "UserId==123". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "-CreatedDate". Omit for the default order.

immy_personal_access_tokens parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new PAT (e.g. { "name": "CI deploy", "expiration": "2027-01-01" }).

Persons

Tool	Plan	Access	Description
`immy_add_tags_to_persons`	Pro	Write	[ImmyBot] Add one or more tags to one or more persons in bulk. Provide a JSON object body naming the target person ids and the tag ids to apply (discover tag ids with immy_list_tags, person ids with immy_list_persons). Remove tags with immy_remove_tags_from_persons.
`immy_delete_persons`	Pro	Destructive	[ImmyBot] Permanently delete the person identified by id (from immy_list_persons). This removes the person record and their computer/tag affinities; it cannot be undone. It does NOT delete the person's computers.
`immy_get_persons`	Free	Read-only	[ImmyBot] Get a single person by id (from immy_list_persons). Returns the person's profile — name, email, tenant, tags, owned-computer affinities, and access state.
`immy_list_persons`	Free	Read-only	[ImmyBot] List persons (managed end-users) known to the ImmyBot instance. Paginated via Sieve: page (1-based) + pageSize (max 100); filters/sorts accept Sieve expressions (e.g. filters="EmailAddress@=@contoso.com", sorts="DisplayName"). For the DevExtreme grid feed use immy_list_persons_dx. Feed a person id to immy_get_persons / immy_update_persons / immy_delete_persons.
`immy_list_persons_detected_software`	Free	Read-only	[ImmyBot] List the software detected across the computers associated with the person identified by personId (from immy_list_persons). Paginated via Sieve: page + pageSize (max 100), filters/sorts accept Sieve expressions.
`immy_list_persons_dx`	Free	Read-only	[ImmyBot] List persons via the DevExtreme grid feed (the shape the ImmyBot UI person grid consumes). Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort expressions and requireTotalCount. For standard Sieve paging use immy_list_persons.
`immy_list_persons_requesting_access`	Free	Read-only	[ImmyBot] List persons who have requested self-service portal access and are awaiting a decision. Approve a request with immy_persons_grant_access or reject it with immy_persons_deny_access. Paginated via Sieve: page + pageSize (max 100), filters/sorts accept Sieve expressions.
`immy_list_persons_self_service`	Free	Read-only	[ImmyBot] Get the self-service view for the person identified by id (from immy_list_persons) — the software and actions this person is entitled to run themselves through the ImmyBot self-service portal.
`immy_persons`	Pro	Write	[ImmyBot] Create a person (managed end-user). Provide a JSON object body — typically displayName, emailAddress, and the owning tenantId. Returns the created person JSON including its assigned id. Update it later with immy_update_persons; attach tags with immy_add_tags_to_persons.
`immy_persons_deny_access`	Pro	Write	[ImmyBot] Deny or revoke self-service portal access for the person identified by personId (from immy_list_persons / immy_list_persons_requesting_access). Provide a JSON object body with any options. Grant access with immy_persons_grant_access.
`immy_persons_grant_access`	Pro	Write	[ImmyBot] Grant self-service portal access to the person identified by personId (from immy_list_persons / immy_list_persons_requesting_access). Provide a JSON object body with any access options. Revoke with immy_persons_deny_access.
`immy_remove_tags_from_persons`	Pro	Write	[ImmyBot] Remove one or more tags from one or more persons in bulk. Provide a JSON object body naming the target person ids and the tag ids to remove. Add tags with immy_add_tags_to_persons.
`immy_update_persons`	Pro	Write	[ImmyBot] Update the person identified by id (from immy_list_persons). Body (fieldsJson) is the person definition to apply (replace semantics). Use immy_add_tags_to_persons / immy_remove_tags_from_persons for tag membership rather than editing tags here.

immy_add_tags_to_persons parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the target person ids and the tag ids to add (e.g. { "personIds": [1,2], "tagIds": [10] }).

immy_delete_persons parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the person to delete (from immy_list_persons).

immy_get_persons parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the person (from immy_list_persons).

immy_list_persons parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "DisplayName@=smith". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "DisplayName" or "-DisplayName". Omit for the default order.

immy_list_persons_detected_software parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Name@=chrome". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`personId`	string	yes		The id of the person (from immy_list_persons).
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_persons_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include the total record count in the response. Omit for the server default.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Omit to start at 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for the default order.
`take`	integer	no	null	Number of records to take (DevExtreme take). Max 100; omit for the server default.

immy_list_persons_requesting_access parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_persons_self_service parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the person (from immy_list_persons).

immy_persons parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new person (e.g. { "displayName": "Jane Doe", "emailAddress": "jane@contoso.com", "tenantId": 42 }).

immy_persons_deny_access parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the denial (may be an empty object ).
`personId`	string	yes		The id of the person to deny access to (from immy_list_persons).

immy_persons_grant_access parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the access to grant (may be an empty object ).
`personId`	string	yes		The id of the person to grant access to (from immy_list_persons).

immy_remove_tags_from_persons parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the target person ids and the tag ids to remove (e.g. { "personIds": [1,2], "tagIds": [10] }).

immy_update_persons parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the person fields to apply.
`id`	string	yes		The id of the person to update (from immy_list_persons).

Users

Tool	Plan	Access	Description
`immy_bulk_delete_users`	Pro	Destructive	[ImmyBot] Permanently delete multiple ImmyBot console users in one call. Provide a JSON object/array body naming the user ids to delete (from immy_list_users). This is sent as an HTTP DELETE with a request body; it cannot be undone. Deleted users immediately lose console access.
`immy_delete_users`	Pro	Destructive	[ImmyBot] Permanently delete the ImmyBot console user identified by userId (from immy_list_users). The user immediately loses console access; this cannot be undone. To remove several users at once use immy_bulk_delete_users.
`immy_get_users`	Free	Read-only	[ImmyBot] Get a single ImmyBot console user by userId (from immy_list_users). Returns the user's profile, status, and expiration. See their group memberships with immy_list_users_groups and role assignments with immy_get_user_role_assignments_users.
`immy_list_users`	Free	Read-only	[ImmyBot] List ImmyBot console users (operators/technicians). Paginated via Sieve: page (1-based) + pageSize (max 100); filters/sorts accept Sieve expressions (e.g. filters="Email@=@msp.com", sorts="Email"). Feed a user id to immy_get_users, immy_list_users_groups, immy_users (update), or immy_delete_users. For the person (end-user) directory use immy_list_persons instead.
`immy_list_users_claims`	Free	Read-only	[ImmyBot] Get the identity claims for the currently authenticated caller — the claim set the ImmyBot backend associates with this session/token. Useful for confirming which identity and roles the connector is acting as.
`immy_list_users_groups`	Free	Read-only	[ImmyBot] List the RBAC groups the user identified by userId (from immy_list_users) belongs to. Paginated via Sieve: page + pageSize (max 100), filters/sorts accept Sieve expressions. Manage group membership with immy_groups_members / immy_delete_groups_members (RBAC slice).
`immy_users`	Pro	Write	[ImmyBot] Update the ImmyBot console user identified by userId (from immy_list_users). Body (fieldsJson) is the user definition to apply. Note: ImmyBot updates a user via HTTP POST to /users/, not PUT. Adjust the user's expiration separately with immy_users_update_expiration and role/group membership via the RBAC tools.
`immy_users_bulk_create`	Pro	Write	[ImmyBot] Create multiple ImmyBot console users in one call. Provide a JSON object/array body describing the users to create (typically each with email and role/group assignments). Returns the created users. Delete users in bulk with immy_bulk_delete_users.
`immy_users_impersonate`	Pro	Write	[ImmyBot] Begin impersonating the ImmyBot console user identified by userId (from immy_list_users) — subsequent actions are performed as that user, for support/troubleshooting. Provide a JSON object body with any impersonation options (may be ). End the session with immy_users_stop_impersonating.
`immy_users_invalidate_cache`	Pro	Write	[ImmyBot] Invalidate the server-side user/permission cache so identity and RBAC changes take effect immediately. Provide a JSON object body with any scope options (may be ). Despite the name this is a state-changing operation, not a validation read.
`immy_users_stop_impersonating`	Pro	Write	[ImmyBot] End the current user-impersonation session started by immy_users_impersonate, returning to the caller's own identity. Provide a JSON object body with any options (may be ).
`immy_users_submit_feedback`	Pro	Write	[ImmyBot] Submit product feedback to ImmyBot on behalf of the current user. Provide a JSON object body with the feedback content (e.g. message/category).
`immy_users_update_expiration`	Pro	Write	[ImmyBot] Set or change the expiration for one or more ImmyBot console users. Provide a JSON object body naming the target user id(s) and the new expiration (or clearing it). Expired users lose console access at the given time.

immy_bulk_delete_users parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON body identifying the user ids to delete (e.g. { "userIds": [1,2,3] }).

immy_delete_users parameters

Param	Type	Required	Default	Description
`userId`	string	yes		The id of the user to delete (from immy_list_users).

immy_get_users parameters

Param	Type	Required	Default	Description
`userId`	string	yes		The id of the user (from immy_list_users).

immy_list_users parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Email@=admin". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "Email" or "-Email". Omit for the default order.

immy_list_users_groups parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.
`userId`	string	yes		The id of the user (from immy_list_users).

immy_users parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the user fields to apply.
`userId`	string	yes		The id of the user to update (from immy_list_users).

immy_users_bulk_create parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON body describing the users to create (e.g. { "users": [ { "email": "tech@msp.com" } ] }).

immy_users_impersonate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with impersonation options (may be an empty object ).
`userId`	string	yes		The id of the user to impersonate (from immy_list_users).

immy_users_invalidate_cache parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with any cache-invalidation scope options (may be an empty object ).

immy_users_stop_impersonating parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with any stop-impersonation options (may be an empty object ).

immy_users_submit_feedback parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the feedback content (e.g. { "message": "..." }).

immy_users_update_expiration parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the user id(s) and the expiration to apply (e.g. { "userId": 5, "expiration": "2027-06-01" }).

Roles, Groups & Permissions

Tool	Plan	Access	Description
`immy_delete_groups`	Pro	Destructive	[ImmyBot] Permanently delete an RBAC group by id (from immy_list_groups). This removes the group and its role assignments; members lose any access granted through it. Cannot be undone.
`immy_delete_groups_members`	Pro	Destructive	[ImmyBot] Remove a user from a group. Provide the group id (from immy_list_groups) and the user id (from immy_list_groups_members / immy_list_users). The user loses any access granted through this group. Cannot be undone (re-add with immy_groups_members).
`immy_delete_roles`	Pro	Destructive	[ImmyBot] Permanently delete a role by id (from immy_list_roles). This removes the role and revokes it from every user/group it is assigned to (see immy_list_roles_assignments). Cannot be undone.
`immy_effective_permissions_groups_evaluate_all_assignments`	Free	Read-only	[ImmyBot] Evaluate the effective permissions a group would have across ALL of its role assignments (POST-as-read what-if — nothing is changed). Provide the group id (from immy_list_groups) plus a JSON body describing the evaluation context. Use the resource/tenant variants (immy_effective_permissions_groups_evaluate_resource / _tenant) to scope the evaluation.
`immy_effective_permissions_groups_evaluate_resource`	Free	Read-only	[ImmyBot] Evaluate a group's effective permissions against a specific resource (POST-as-read what-if — nothing is changed). Provide the group id (from immy_list_groups) plus a JSON body identifying the resource. See immy_effective_permissions_groups_evaluate_tenant for tenant-scoped and immy_effective_permissions_groups_evaluate_all_assignments for the full picture.
`immy_effective_permissions_groups_evaluate_tenant`	Free	Read-only	[ImmyBot] Evaluate a group's effective permissions within a specific tenant (POST-as-read what-if — nothing is changed). Provide the group id (from immy_list_groups) plus a JSON body identifying the tenant. See immy_effective_permissions_groups_evaluate_resource for resource-scoped evaluation.
`immy_effective_permissions_users_evaluate_all_assignments`	Free	Read-only	[ImmyBot] Evaluate the effective permissions a user would have across ALL of their role assignments (POST-as-read what-if — nothing is changed). Provide the user id (from immy_list_users) plus a JSON body describing the evaluation context. Use the resource/tenant variants (immy_effective_permissions_users_evaluate_resource / _tenant) to scope the evaluation.
`immy_effective_permissions_users_evaluate_resource`	Free	Read-only	[ImmyBot] Evaluate a user's effective permissions against a specific resource (POST-as-read what-if — nothing is changed). Provide the user id (from immy_list_users) plus a JSON body identifying the resource. See immy_effective_permissions_users_evaluate_tenant for tenant-scoped and immy_effective_permissions_users_evaluate_all_assignments for the full picture.
`immy_effective_permissions_users_evaluate_tenant`	Free	Read-only	[ImmyBot] Evaluate a user's effective permissions within a specific tenant (POST-as-read what-if — nothing is changed). Provide the user id (from immy_list_users) plus a JSON body identifying the tenant. See immy_effective_permissions_users_evaluate_resource for resource-scoped evaluation.
`immy_get_groups`	Free	Read-only	[ImmyBot] Get a single RBAC group by id (from immy_list_groups). Returns the group's id, name, and configuration. List its members with immy_list_groups_members and its role assignments with immy_list_groups_role_assignments.
`immy_get_roles`	Free	Read-only	[ImmyBot] Get a single role by id (from immy_list_roles). Returns the role's id, name, and the permissions it grants. List where the role is assigned with immy_list_roles_assignments.
`immy_groups`	Pro	Write	[ImmyBot] Create an RBAC group. Provide a JSON object body — typically name (string) plus optional description. The created group id can then take members (immy_groups_members) and role assignments.
`immy_groups_members`	Pro	Write	[ImmyBot] Add a member to a group by id (from immy_list_groups). Provide a JSON object body identifying the user to add (e.g. { "userId": ... }). To add several at once use immy_groups_members_bulk; to remove one use immy_delete_groups_members.
`immy_groups_members_bulk`	Pro	Write	[ImmyBot] Add multiple members to a group by id (from immy_list_groups) in one call. Provide a JSON body containing the collection of users to add. For a single member use immy_groups_members.
`immy_list_groups`	Free	Read-only	[ImmyBot] List RBAC groups. Groups bundle users and carry role assignments. Paginated via Sieve: page (1-based) + pageSize (max 100); filters/sorts accept Sieve expressions. Feed a group id to immy_get_groups, immy_list_groups_members, immy_list_groups_role_assignments, immy_update_groups, or immy_delete_groups.
`immy_list_groups_members`	Free	Read-only	[ImmyBot] List the users that belong to a group by id (from immy_list_groups). Paginated via Sieve (page, pageSize up to 100, filters, sorts). Add members with immy_groups_members (single) / immy_groups_members_bulk (many) and remove one with immy_delete_groups_members.
`immy_list_groups_role_assignments`	Free	Read-only	[ImmyBot] List the role assignments attached to a group by id (from immy_list_groups) — which roles the group grants and at what scope. Paginated via Sieve (page, pageSize up to 100, filters, sorts). Create user/group role assignments with the immy_user_role_assignments_*_create family.
`immy_list_roles`	Free	Read-only	[ImmyBot] List RBAC roles. A role bundles a set of permissions (enumerate the full permission catalog with immy_list_roles_permissions). Paginated via Sieve (page, pageSize up to 100, filters, sorts). Feed a role id to immy_get_roles, immy_list_roles_assignments, immy_update_roles, immy_roles_clone, or immy_delete_roles.
`immy_list_roles_assignments`	Free	Read-only	[ImmyBot] List the assignments of a role by id (from immy_list_roles) — which users/groups hold this role and at what scope. Paginated via Sieve (page, pageSize up to 100, filters, sorts). Create assignments with the immy_user_role_assignments_*_create family.
`immy_list_roles_permissions`	Free	Read-only	[ImmyBot] List the full catalog of permissions that roles can grant (the building blocks referenced when creating/updating a role with immy_roles / immy_update_roles). Paginated via Sieve (page, pageSize up to 100, filters, sorts). This is the permission universe, not the permissions of one role.
`immy_roles`	Pro	Write	[ImmyBot] Create an RBAC role. Provide a JSON object body — typically name plus the collection of permissions it grants (enumerate valid permissions with immy_list_roles_permissions). To copy an existing role instead, use immy_roles_clone.
`immy_roles_clone`	Pro	Write	[ImmyBot] Clone an existing role by id (from immy_list_roles) into a new role. Provide a JSON object body for the clone (typically the new name plus any overrides). The source role is unchanged.
`immy_update_groups`	Pro	Write	[ImmyBot] Update a group by id (from immy_list_groups) via HTTP PUT. Provide a JSON object body with the fields to change (e.g. name, description).
`immy_update_roles`	Pro	Write	[ImmyBot] Update a role by id (from immy_list_roles) via HTTP PUT. Provide a JSON object body with the fields to change (e.g. name, permissions). Valid permission identifiers come from immy_list_roles_permissions.

immy_delete_groups parameters

Param	Type	Required	Default	Description
`groupId`	string	yes		The id of the group to delete (from immy_list_groups).

immy_delete_groups_members parameters

Param	Type	Required	Default	Description
`groupId`	string	yes		The id of the group (from immy_list_groups).
`userId`	string	yes		The id of the user to remove (from immy_list_groups_members).

immy_delete_roles parameters

Param	Type	Required	Default	Description
`roleId`	string	yes		The id of the role to delete (from immy_list_roles).

immy_effective_permissions_groups_evaluate_all_assignments parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the evaluation context.
`groupId`	string	yes		The id of the group to evaluate (from immy_list_groups).

immy_effective_permissions_groups_evaluate_resource parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the resource to evaluate against.
`groupId`	string	yes		The id of the group to evaluate (from immy_list_groups).

immy_effective_permissions_groups_evaluate_tenant parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the tenant to evaluate within.
`groupId`	string	yes		The id of the group to evaluate (from immy_list_groups).

immy_effective_permissions_users_evaluate_all_assignments parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the evaluation context.
`userId`	string	yes		The id of the user to evaluate (from immy_list_users).

immy_effective_permissions_users_evaluate_resource parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the resource to evaluate against.
`userId`	string	yes		The id of the user to evaluate (from immy_list_users).

immy_effective_permissions_users_evaluate_tenant parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the tenant to evaluate within.
`userId`	string	yes		The id of the user to evaluate (from immy_list_users).

immy_get_groups parameters

Param	Type	Required	Default	Description
`groupId`	string	yes		The id of the group (from immy_list_groups).

immy_get_roles parameters

Param	Type	Required	Default	Description
`roleId`	string	yes		The id of the role (from immy_list_roles).

immy_groups parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body for the new group (e.g. { "name": "Help Desk" }).

immy_groups_members parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the user to add.
`groupId`	string	yes		The id of the group (from immy_list_groups).

immy_groups_members_bulk parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON body containing the users to add (e.g. an array of user ids).
`groupId`	string	yes		The id of the group (from immy_list_groups).

immy_list_groups parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Name@=admins". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "Name" or "-Name" (descending). Omit for the default order.

immy_list_groups_members parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`groupId`	string	yes		The id of the group (from immy_list_groups).
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_groups_role_assignments parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`groupId`	string	yes		The id of the group (from immy_list_groups).
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_roles parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_roles_assignments parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`roleId`	string	yes		The id of the role (from immy_list_roles).
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_roles_permissions parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_roles parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body for the new role (name + permissions).

immy_roles_clone parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body for the cloned role (e.g. { "name": "Help Desk (copy)" }).
`roleId`	string	yes		The id of the role to clone (from immy_list_roles).

immy_update_groups parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body with the group fields to change.
`groupId`	string	yes		The id of the group to update (from immy_list_groups).

immy_update_roles parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body with the role fields to change.
`roleId`	string	yes		The id of the role to update (from immy_list_roles).

User Role Assignments

Tool	Plan	Access	Description
`immy_delete_user_role_assignment`	Pro	Destructive	[ImmyBot] Delete (revoke) a user-role assignment. This is an HTTP DELETE that carries a JSON body identifying the assignment to remove (as returned by immy_list_user_role_assignments / immy_get_user_role_assignments_users). The affected user/group loses the access that assignment granted. Cannot be undone (recreate with the matching immy_user_role_assignments_*_create tool).
`immy_get_user_role_assignments_users`	Free	Read-only	[ImmyBot] Get all role assignments for a single user by id (from immy_list_users). Returns each role bound to the user and its scope. Count them with immy_list_user_role_assignments_users_count.
`immy_list_user_role_assignments`	Free	Read-only	[ImmyBot] List user-role assignments across the instance — the bindings of roles to users/groups at their scopes. Paginated via Sieve (page, pageSize up to 100, filters, sorts). For a single user use immy_get_user_role_assignments_users; create assignments with the immy_user_role_assignments_*_create family; remove one with immy_delete_user_role_assignment.
`immy_list_user_role_assignments_users_count`	Free	Read-only	[ImmyBot] Get the number of role assignments a single user has, by user id (from immy_list_users). Enumerate the assignments themselves with immy_get_user_role_assignments_users.
`immy_user_role_assignments_category_resource_create`	Pro	Write	[ImmyBot] Create a role assignment scoped to a CATEGORY of resources — grants a role to a user/group over an entire resource category. Provide a JSON object body identifying the user/group, the role (from immy_list_roles), and the resource category. For a single resource use immy_user_role_assignments_specific_resource_create.
`immy_user_role_assignments_msp_create`	Pro	Write	[ImmyBot] Create an MSP-WIDE role assignment — grants a role to a user/group across the entire MSP (all tenants). Provide a JSON object body identifying the user/group and the role (from immy_list_roles). This is the broadest scope; prefer a narrower create tool (specific-tenant/specific-resource/tag) where possible.
`immy_user_role_assignments_owner_create`	Pro	Write	[ImmyBot] Create an OWNER-scoped role assignment — grants a role to a user/group at the owner (instance-owner) scope. Provide a JSON object body identifying the user/group and the role (from immy_list_roles). This is a high-privilege grant; use deliberately.
`immy_user_role_assignments_specific_resource_create`	Pro	Write	[ImmyBot] Create a role assignment scoped to a SPECIFIC resource — grants a role to a user/group on one identified resource only. Provide a JSON object body identifying the user/group, the role (from immy_list_roles), and the target resource. For a category of resources use immy_user_role_assignments_category_resource_create; for tag-matched resources use immy_user_role_assignments_tag_resource_create.
`immy_user_role_assignments_specific_tenant_create`	Pro	Write	[ImmyBot] Create a role assignment scoped to a SPECIFIC tenant — grants a role to a user/group within one tenant only. Provide a JSON object body identifying the user/group, the role (from immy_list_roles), and the tenant (from immy_list_tenants). For all tenants sharing a tag use immy_user_role_assignments_tenant_tag_create.
`immy_user_role_assignments_tag_resource_create`	Pro	Write	[ImmyBot] Create a role assignment scoped to every resource carrying a given TAG — grants a role to a user/group over all resources with that tag. Provide a JSON object body identifying the user/group, the role (from immy_list_roles), and the resource tag (from immy_list_tags). For a single resource use immy_user_role_assignments_specific_resource_create.
`immy_user_role_assignments_tenant_tag_create`	Pro	Write	[ImmyBot] Create a role assignment scoped to every tenant carrying a given TAG — grants a role to a user/group across all tenants with that tag. Provide a JSON object body identifying the user/group, the role (from immy_list_roles), and the tenant tag (from immy_list_tags). For a single tenant use immy_user_role_assignments_specific_tenant_create.
`immy_user_role_assignments_user_tenant_create`	Pro	Write	[ImmyBot] Create a user-tenant role assignment — associates a user with a tenant and grants the accompanying role. Provide a JSON object body identifying the user (from immy_list_users), the tenant (from immy_list_tenants), and the role (from immy_list_roles).

immy_delete_user_role_assignment parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the user-role assignment to delete.

immy_get_user_role_assignments_users parameters

Param	Type	Required	Default	Description
`userId`	string	yes		The id of the user (from immy_list_users).

immy_list_user_role_assignments parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_user_role_assignments_users_count parameters

Param	Type	Required	Default	Description
`userId`	string	yes		The id of the user (from immy_list_users).

immy_user_role_assignments_category_resource_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role + resource category to scope the assignment to.

immy_user_role_assignments_msp_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role to assign MSP-wide.

immy_user_role_assignments_owner_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role to assign at owner scope.

immy_user_role_assignments_specific_resource_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role + specific resource to scope the assignment to.

immy_user_role_assignments_specific_tenant_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role + tenant to scope the assignment to.

immy_user_role_assignments_tag_resource_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role + resource tag to scope the assignment to.

immy_user_role_assignments_tenant_tag_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user/group + role + tenant tag to scope the assignment to.

immy_user_role_assignments_user_tenant_create parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body: the user + tenant + role for the assignment.

Identity & Azure

Tool	Plan	Access	Description
`immy_auth_delete_azure_tenant_auth_details`	Pro	Destructive	[ImmyBot] Permanently remove the stored Azure/Entra auth details (app registration link + consent) for one or more Azure tenants. This severs ImmyBot's ability to sync users/details for those tenants until re-consented and cannot be undone. Provide a JSON body identifying the Azure tenant(s). Read the current state with immy_get_auth_get_azure_tenant_auth_details first.
`immy_auth_request_access`	Pro	Write	[ImmyBot] Submit an access request for the calling identity (e.g. to gain access to a tenant/resource requiring approval). Provide a JSON body describing the requested access. Persons awaiting access approval can be listed via immy_list_persons_requesting_access.
`immy_auth_update_azure_tenant_auth_details`	Pro	Write	[ImmyBot] Create or update the stored Azure/Entra auth details for an Azure tenant (app registration, client credentials reference, delegated scopes). Provide a JSON body with the fields to set. Read the current state with immy_get_auth_get_azure_tenant_auth_details first; remove with immy_auth_delete_azure_tenant_auth_details.
`immy_azure_disambiguate_azure_tenant_type`	Pro	Write	[ImmyBot] Resolve/record whether an Azure tenant is a partner (CSP) tenant, a customer tenant, or standalone — used when ImmyBot cannot infer the tenant type automatically. Provide a JSON body identifying the tenant and the chosen type. This mutates stored tenant-type classification, so it is a write.
`immy_azure_preconsent_customer_tenants`	Pro	Write	[ImmyBot] Preconsent ImmyBot's app registration into one or more CSP customer tenants (grants the app the permissions it needs without visiting each tenant's consent screen). Provide a JSON body identifying the customer tenants (discover them via immy_get_azure_partner_tenant_customers). Follow with immy_azure_sync_details_from_azure_tenants / immy_azure_sync_users_from_azure_tenants to pull data.
`immy_azure_sync_details_from_azure_tenants`	Pro	Write	[ImmyBot] Trigger a sync of tenant detail/metadata from the linked Azure/Entra tenants into ImmyBot. Provide a JSON body scoping which Azure tenants to sync (or pass the documented all-tenants shape). To sync user accounts instead use immy_azure_sync_users_from_azure_tenants. Sync failures surface in immy_list_azure_errors_dx.
`immy_azure_sync_users_from_azure_tenants`	Pro	Write	[ImmyBot] Trigger a sync of user accounts from the linked Azure/Entra tenants into ImmyBot persons. Provide a JSON body scoping which Azure tenants to sync. Related: immy_syncs_azure_user_sync (the generic user-sync trigger) and immy_azure_sync_details_from_azure_tenants (tenant metadata). Failures surface in immy_list_azure_errors_dx.
`immy_azure_tenant_consented`	Pro	Write	[ImmyBot] Notify ImmyBot that an Azure/Entra tenant has completed admin consent for its app registration (the callback that finalizes the consent handshake). Provide a JSON body identifying the tenant and consent result. Typically follows immy_azure_preconsent_customer_tenants or a manual consent flow.
`immy_get_auth_get_azure_tenant_auth_details`	Free	Read-only	[ImmyBot] Get the stored Azure/Entra auth details (app registration, consent state, delegated permissions) for a single Azure tenant, keyed by its Azure tenant principal id. Update these details with immy_auth_update_azure_tenant_auth_details or remove them with immy_auth_delete_azure_tenant_auth_details.
`immy_get_azure_partner_tenant_customers`	Free	Read-only	[ImmyBot] List the CSP customer tenants under a partner (reseller) Azure tenant, keyed by the partner's Azure principal id. Use immy_list_azure_partner_tenant_infos to discover partner tenants first. These customers can then be preconsented via immy_azure_preconsent_customer_tenants.
`immy_list_auth`	Free	Read-only	[ImmyBot] List the auth context / linked Azure-tenant auth records for the ImmyBot instance. Paginated via Sieve: page (1-based) + pageSize (max 100). filters/sorts accept Sieve expressions. For the calling identity's effective permissions use immy_list_me_permissions; for a single Azure tenant's auth details use immy_get_auth_get_azure_tenant_auth_details.
`immy_list_auth_get_ip_addresses`	Free	Read-only	[ImmyBot] List the outbound IP addresses the ImmyBot instance uses when calling Azure/Entra and other external services — useful for allow-listing on customer firewalls or conditional-access policies.
`immy_list_auth_me_permissions_tenants`	Free	Read-only	[ImmyBot] List the tenants the calling identity holds a given permission type against (i.e. the scope of one permission across tenants). permissionType is an ImmyBot permission key. Paginated via Sieve: page + pageSize (max 100), filters/sorts optional. For the full permission map use immy_list_me_permissions.
`immy_list_azure_app_registration_options`	Free	Read-only	[ImmyBot] List the available Azure app-registration options / templates ImmyBot can use when wiring up Azure/Entra integration for a tenant (e.g. the permission sets and consent URLs it offers). Read-only discovery of what can be configured.
`immy_list_azure_errors_dx`	Free	Read-only	[ImmyBot] List Azure/Entra integration errors across all tenants as a DevExtreme grid feed (failed consents, throttled Graph calls, sync failures). Uses DevExtreme paging: skip + take (take max 100), with optional filter/sort (DevExtreme JSON expressions) and requireTotalCount. For a single tenant's errors use immy_list_azure_errors_for_tenant_dx.
`immy_list_azure_errors_for_tenant_dx`	Free	Read-only	[ImmyBot] List Azure/Entra integration errors for a single tenant (by Azure tenant principal id) as a DevExtreme grid feed. Uses DevExtreme paging: skip + take (take max 100), with optional filter/sort and requireTotalCount. For all tenants at once use immy_list_azure_errors_dx.
`immy_list_azure_partner_tenant_infos`	Free	Read-only	[ImmyBot] List the partner (CSP/reseller) Azure tenants known to ImmyBot. Paginated via Sieve: page + pageSize (max 100), filters/sorts optional. Feed a partner principal id to immy_get_azure_partner_tenant_customers to enumerate that partner's customer tenants.
`immy_list_me_permissions`	Free	Read-only	[ImmyBot] Get the effective permission map for the calling identity (the app registration StackJack authenticates with). Returns which actions/roles are granted. To see the tenant scope of a single permission, use immy_list_auth_me_permissions_tenants.

immy_auth_delete_azure_tenant_auth_details parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the Azure tenant(s) whose auth details to delete.

immy_auth_request_access parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the access being requested.

immy_auth_update_azure_tenant_auth_details parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body with the Azure tenant auth details to set.

immy_azure_disambiguate_azure_tenant_type parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the Azure tenant and its resolved type.

immy_azure_preconsent_customer_tenants parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the customer tenants to preconsent.

immy_azure_sync_details_from_azure_tenants parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body scoping which Azure tenants to sync details from.

immy_azure_sync_users_from_azure_tenants parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body scoping which Azure tenants to sync users from.

immy_azure_tenant_consented parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body identifying the consented Azure tenant and consent result.

immy_get_auth_get_azure_tenant_auth_details parameters

Param	Type	Required	Default	Description
`azureTenantPrincipalId`	string	yes		The Azure tenant principal id whose auth details to fetch.

immy_get_azure_partner_tenant_customers parameters

Param	Type	Required	Default	Description
`partnerPrincipalId`	string	yes		The partner (reseller) Azure principal id whose customer tenants to list.

immy_list_auth parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "-CreatedDate". Omit for the default order.

immy_list_auth_me_permissions_tenants parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`permissionType`	string	yes		The permission type/key to evaluate across tenants.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_azure_errors_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response. Omit to skip counting.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Omit to start at 0.
`sort`	string	no	null	DevExtreme sort expression (JSON). Omit for the default order.
`take`	integer	no	null	Number of records to take (DevExtreme take). Max 100; omit for the server default.

immy_list_azure_errors_for_tenant_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response. Omit to skip counting.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Omit to start at 0.
`sort`	string	no	null	DevExtreme sort expression (JSON). Omit for the default order.
`take`	integer	no	null	Number of records to take (DevExtreme take). Max 100; omit for the server default.
`tenantPrincipalId`	string	yes		The Azure tenant principal id whose errors to list.

immy_list_azure_partner_tenant_infos parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

OAuth & Syncs

Tool	Plan	Access	Description
`immy_auth_login`	Free	Read-only	[ImmyBot] Hit the host-rooted /auth/login endpoint (initiates the interactive sign-in redirect). StackJack authenticates with an app-only Azure Bearer token, so this returns the login challenge/redirect metadata rather than establishing an interactive session. Primarily useful for inspecting the instance's sign-in configuration.
`immy_auth_logout`	Free	Read-only	[ImmyBot] Hit the host-rooted /auth/logout endpoint. Under StackJack's app-only Azure Bearer auth there is no interactive session to terminate, so this is effectively inert — it returns the logout redirect metadata. Exposed for completeness of the auth surface.
`immy_auth_me`	Free	Read-only	[ImmyBot] Hit the host-rooted /auth/me endpoint — returns the current caller's identity as ImmyBot sees it (the app registration under StackJack's app-only Azure Bearer auth). For the granular permission map use immy_list_me_permissions.
`immy_delete_oauth_oauth_access_tokens`	Pro	Destructive	[ImmyBot] Permanently revoke/delete an OAuth access-token record by id (from immy_list_oauth_oauth_access_tokens). Any integration relying on this token will lose access until re-authorized and this cannot be undone. To renew instead of revoke, use immy_oauth_oauth_access_tokens_refresh.
`immy_get_oauth_oauth_access_tokens`	Free	Read-only	[ImmyBot] Get a single OAuth access-token record by its composite key (id + accessTokenId, both from immy_list_oauth_oauth_access_tokens). Returns the token's provider/scope/expiry metadata.
`immy_list_oauth_oauth_access_tokens`	Free	Read-only	[ImmyBot] List the OAuth access tokens ImmyBot holds for its provider integrations (metadata: provider, scopes, expiry, status — not the raw secret). Paginated via Sieve: page + pageSize (max 100), filters/sorts optional. Fetch one with immy_get_oauth_oauth_access_tokens, refresh with immy_oauth_oauth_access_tokens_refresh, or revoke with immy_delete_oauth_oauth_access_tokens.
`immy_oauth_begin_auth_code_flow`	Pro	Write	[ImmyBot] Begin an OAuth authorization-code flow so ImmyBot can obtain a delegated token from a third-party provider. Returns the authorization URL / flow state the operator must complete. Provide a JSON body describing the provider and requested scopes. Complete the flow with immy_oauth_finish_auth_code_flow (success) or immy_oauth_fail_auth_code_flow (error/abort).
`immy_oauth_fail_auth_code_flow`	Pro	Write	[ImmyBot] Report that an in-progress OAuth authorization-code flow failed or was aborted (records the error and clears the pending flow state). Provide a JSON body with the flow id and error details. The paired success callback is immy_oauth_finish_auth_code_flow; start a flow with immy_oauth_begin_auth_code_flow.
`immy_oauth_finish_auth_code_flow`	Pro	Write	[ImmyBot] Complete an OAuth authorization-code flow by redeeming the returned code for a token (the success callback). Provide a JSON body with the flow id, authorization code, and state. Started by immy_oauth_begin_auth_code_flow; the failure callback is immy_oauth_fail_auth_code_flow.
`immy_oauth_oauth_access_tokens_refresh`	Pro	Write	[ImmyBot] Refresh (renew) an OAuth access token by id (from immy_list_oauth_oauth_access_tokens) using its stored refresh token. Most refreshes need no body — pass (the default). This endpoint takes no parameters unless the provider requires extra fields.
`immy_syncs_azure_user_sync`	Pro	Write	[ImmyBot] Trigger an Azure/Entra user sync job (pulls users from linked Azure tenants into ImmyBot persons). Most invocations take no body — pass (the default) — or supply a JSON body to scope the sync. For a tenant-scoped variant use immy_azure_sync_users_from_azure_tenants. Failures surface in immy_list_azure_errors_dx.
`immy_syncs_expire_pending_sessions`	Pro	Write	[ImmyBot] Trigger the housekeeping job that expires stale pending maintenance sessions (clears sessions stuck in a pending state). Most invocations take no body — pass (the default). Inspect sessions first with immy_list_maintenance_sessions_dx / immy_list_maintenance_sessions_status_counts.
`immy_syncs_trigger_user_affinity_sync`	Pro	Write	[ImmyBot] Trigger a user-affinity sync (recomputes which persons are associated with which computers, e.g. primary/additional users). Most invocations take no body — pass (the default). Per-computer affinity is managed via immy_computers_update_primary_person / immy_computers_update_additional_persons.

immy_delete_oauth_oauth_access_tokens parameters

Param	Type	Required	Default	Description
`id`	string	yes		The OAuth access-token record id to delete (from immy_list_oauth_oauth_access_tokens).

immy_get_oauth_oauth_access_tokens parameters

Param	Type	Required	Default	Description
`accessTokenId`	string	yes		The access-token id component (from immy_list_oauth_oauth_access_tokens).
`id`	string	yes		The OAuth access-token record id (from immy_list_oauth_oauth_access_tokens).

immy_list_oauth_oauth_access_tokens parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_oauth_begin_auth_code_flow parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body describing the provider and scopes for the auth-code flow.

immy_oauth_fail_auth_code_flow parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body with the failing flow id and error details.

immy_oauth_finish_auth_code_flow parameters

Param	Type	Required	Default	Description
`bodyJson`	string	yes		JSON object body with the flow id, authorization code, and state.

immy_oauth_oauth_access_tokens_refresh parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON object body. This action normally takes no options — pass (the default).
`id`	string	yes		The OAuth access-token record id to refresh (from immy_list_oauth_oauth_access_tokens).

immy_syncs_azure_user_sync parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON object body scoping the sync. Pass (the default) for a full sync.

immy_syncs_expire_pending_sessions parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON object body. This action normally takes no options — pass (the default).

immy_syncs_trigger_user_affinity_sync parameters

Param	Type	Required	Default	Description
`bodyJson`	string	no	""	Optional JSON object body. This action normally takes no options — pass (the default).

Media

Tool	Plan	Access	Description
`immy_delete_media_global`	Pro	Destructive	[ImmyBot] Delete a GLOBAL media asset by id (from immy_list_media_global). This permanently removes the asset instance-wide; software items or branding that reference it will lose the image. Cannot be undone. Returns the raw ImmyBot result.
`immy_delete_media_local`	Pro	Destructive	[ImmyBot] Delete a LOCAL media asset by id (from immy_list_media_local). This permanently removes the tenant-owned asset; anything referencing it will lose the image. Cannot be undone. Returns the raw ImmyBot result.
`immy_get_media_global`	Free	Read-only	[ImmyBot] Get a single GLOBAL media asset by id (from immy_list_media_global). Returns the raw ImmyBot media JSON (metadata, category, dimensions). Use immy_list_media_global_download_url to resolve a URL for the underlying file.
`immy_get_media_local`	Free	Read-only	[ImmyBot] Get a single LOCAL media asset by id (from immy_list_media_local). Returns the raw ImmyBot media JSON. Use immy_list_media_local_download_url for a file URL and immy_list_media_local_authorization to inspect access scope.
`immy_list_media_global`	Free	Read-only	[ImmyBot] List GLOBAL media assets (shared across every tenant on the instance) via the DevExtreme grid feed. Despite the plain path this endpoint pages with skip/take, not Sieve. Optionally narrow to a media `category` (e.g. "SoftwareIcon"). Returns the raw DevExtreme envelope {data, totalCount}. See immy_list_media_local for tenant-owned assets and immy_list_media_search for a simple Sieve search.
`immy_list_media_global_download_url`	Free	Read-only	[ImmyBot] Resolve a download URL for a GLOBAL media asset's file by id (from immy_list_media_global). Returns a JSON body containing the URL string — this is a normal passthrough read, not a binary blob export. Fetch the URL out-of-band to retrieve the file bytes.
`immy_list_media_local`	Free	Read-only	[ImmyBot] List LOCAL media assets (owned by a single tenant) via the DevExtreme grid feed. Despite the plain path this endpoint pages with skip/take, not Sieve. Optionally narrow to a media `category` (e.g. "SoftwareIcon"). Returns the raw DevExtreme envelope {data, totalCount}. See immy_list_media_global for instance-shared assets.
`immy_list_media_local_authorization`	Free	Read-only	[ImmyBot] Get the authorization/access scope for a LOCAL media asset by id (from immy_list_media_local) — which tenants/roles may use it. Returns the raw ImmyBot authorization JSON. Change it with immy_media_local_authorization.
`immy_list_media_local_download_url`	Free	Read-only	[ImmyBot] Resolve a download URL for a LOCAL media asset's file by id (from immy_list_media_local). Returns a JSON body containing the URL string — this is a normal passthrough read, not a binary blob export. Fetch the URL out-of-band to retrieve the file bytes.
`immy_list_media_search`	Free	Read-only	[ImmyBot] Search media assets with a Sieve page window (Page/pageSize/Filters/Sorts), optionally restricted to global-scope assets via globalOnly. Unlike the DevExtreme grid feeds (immy_list_media_global / immy_list_media_local) this spans both scopes by default. Returns raw ImmyBot JSON.
`immy_media_global`	Pro	Write	[ImmyBot] Update a GLOBAL media asset's metadata by id (from immy_list_media_global). Provide a JSON object body (fieldsJson) with the fields to set (e.g. name, category). Returns the updated media JSON. This updates metadata only — replace the file bytes with immy_media_global_upload.
`immy_media_global_upload`	Pro	Write	[ImmyBot] Upload a GLOBAL media asset (multipart/form-data) — shared across every tenant on the instance. Provide the file bytes base64-encoded (base64Content) and a fileName; the file is decoded and posted as the `file` form part. Optionally forward the endpoint's `mediaId` form field (an existing media record id); omit it for a standard new upload. Returns the raw ImmyBot upload result JSON (including the new media id). Use immy_media_global to update an asset's metadata afterward.
`immy_media_local`	Pro	Write	[ImmyBot] Update a LOCAL media asset's metadata by id (from immy_list_media_local). Provide a JSON object body (fieldsJson) with the fields to set (e.g. name, category). Returns the updated media JSON. This updates metadata only — replace the file bytes with immy_media_local_upload.
`immy_media_local_authorization`	Pro	Write	[ImmyBot] Set the authorization/access scope for a LOCAL media asset by id (from immy_list_media_local) — which tenants/roles may use it. Provide a JSON object body (fieldsJson) describing the desired authorization. Returns the raw ImmyBot result. Inspect the current scope first with immy_list_media_local_authorization.
`immy_media_local_upload`	Pro	Write	[ImmyBot] Upload a LOCAL media asset (multipart/form-data) — owned by a single tenant. Provide the file bytes base64-encoded (base64Content) and a fileName; the file is decoded and posted as the `file` form part. Optionally forward the endpoint's `mediaId` form field (an existing media record id); omit it for a standard new upload. Returns the raw ImmyBot upload result JSON (including the new media id). Update its metadata with immy_media_local.
`immy_media_requestFileDownloadUrl`	Free	Read-only	[ImmyBot] Request a download URL for a media file (POST-as-read). Provide a JSON object body (fieldsJson) identifying the file (e.g. a media/file reference). Returns a JSON body containing the URL string — normal passthrough, not a binary export. This is a read despite the POST verb.
`immy_media_support_upload`	Pro	Write	[ImmyBot] Upload a SUPPORT media file (multipart/form-data) — e.g. a screenshot or log attached to an ImmyBot support request. Provide the file bytes base64-encoded (base64Content) and a fileName; the file is decoded and posted as the `file` form part. Returns the raw ImmyBot upload result JSON.

immy_delete_media_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		The global media asset id to delete (from immy_list_media_global).

immy_delete_media_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		The local media asset id to delete (from immy_list_media_local).

immy_get_media_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		The global media asset id (from immy_list_media_global).

immy_get_media_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		The local media asset id (from immy_list_media_local).

immy_list_media_global parameters

Param	Type	Required	Default	Description
`category`	string	no	null	Media category discriminator to filter by (e.g. "None", "SoftwareIcon"). Omit for all categories.
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	If true, the response includes totalCount. Omit to let the server decide.
`skip`	integer	no	null	Number of records to skip (DevExtreme paging offset). Omit for 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for default order.
`take`	integer	no	null	Number of records to take (clamped to 100).

immy_list_media_global_download_url parameters

Param	Type	Required	Default	Description
`id`	string	yes		The global media asset id whose download URL to resolve (from immy_list_media_global).

immy_list_media_local parameters

Param	Type	Required	Default	Description
`category`	string	no	null	Media category discriminator to filter by (e.g. "None", "SoftwareIcon"). Omit for all categories.
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	If true, the response includes totalCount. Omit to let the server decide.
`skip`	integer	no	null	Number of records to skip (DevExtreme paging offset). Omit for 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for default order.
`take`	integer	no	null	Number of records to take (clamped to 100).

immy_list_media_local_authorization parameters

Param	Type	Required	Default	Description
`id`	string	yes		The local media asset id whose authorization to read (from immy_list_media_local).

immy_list_media_local_download_url parameters

Param	Type	Required	Default	Description
`id`	string	yes		The local media asset id whose download URL to resolve (from immy_list_media_local).

immy_list_media_search parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "name@=logo" (contains). Omit for no filter.
`globalOnly`	boolean	no	null	If true, restrict results to GLOBAL-scope media only. Omit to include local assets too.
`page`	integer	no	null	1-based page number. Omit for the first page.
`pageSize`	integer	no	null	Results per page (clamped to 100).
`sorts`	string	no	null	Sieve sort expression, e.g. "name" or "-createdDate" (leading - = descending). Omit for default order.

immy_media_global parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the media metadata to set.
`id`	string	yes		The global media asset id to update (from immy_list_media_global).

immy_media_global_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The media file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "chrome-icon.png").
`mediaId`	integer	no	null	Optional. Forwards the endpoint's optional `mediaId` form field (an existing media record id). Omit for a standard new upload.

immy_media_local parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the media metadata to set.
`id`	string	yes		The local media asset id to update (from immy_list_media_local).

immy_media_local_authorization parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the authorization scope to apply.
`id`	string	yes		The local media asset id whose authorization to set (from immy_list_media_local).

immy_media_local_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The media file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "client-logo.png").
`mediaId`	integer	no	null	Optional. Forwards the endpoint's optional `mediaId` form field (an existing media record id). Omit for a standard new upload.

immy_media_requestFileDownloadUrl parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the media file whose download URL to request.

immy_media_support_upload parameters

Param	Type	Required	Default	Description
`base64Content`	string	yes		The support file, base64-encoded.
`fileName`	string	yes		The original file name (e.g. "error-screenshot.png").

Schedules

Tool	Plan	Access	Description
`immy_cancel_schedule`	Pro	Destructive	[ImmyBot] Cancel a running maintenance schedule by id (from immy_list_schedules or immy_list_schedules_running_schedule_ids), stopping its in-flight maintenance session. This interrupts automation mid-run and cannot be undone. This endpoint takes no parameters — leave fieldsJson as ``. Returns the raw ImmyBot result.
`immy_delete_schedules`	Pro	Destructive	[ImmyBot] Delete a maintenance schedule by id (from immy_list_schedules). This permanently removes the schedule and its future automation; running sessions are not rolled back. Cannot be undone. To only pause it, disable it via immy_patch_schedules_bulk_update_status instead. Returns the raw ImmyBot result.
`immy_get_schedules`	Free	Read-only	[ImmyBot] Get a single maintenance schedule by id (from immy_list_schedules). Returns the raw ImmyBot schedule JSON (target, trigger/recurrence, maintenance items). Update it with immy_update_schedules.
`immy_list_schedules`	Free	Read-only	[ImmyBot] List maintenance schedules, optionally filtered to a single tenant. Each schedule declares when a maintenance session runs against a target. Returns raw ImmyBot JSON. Use immy_list_schedules_running_schedule_ids to see which are executing right now, or immy_get_schedules for one schedule's detail.
`immy_list_schedules_running_schedule_ids`	Free	Read-only	[ImmyBot] List the ids of schedules that are currently executing (have a maintenance session in flight). Returns raw ImmyBot JSON (an id array). Cross-reference with immy_list_schedules; use immy_cancel_schedule to stop one.
`immy_patch_schedules_bulk_update_status`	Pro	Write	[ImmyBot] Bulk enable/disable schedules. Provide a JSON object body (fieldsJson) with the target schedule ids and the desired status (e.g. enabled/disabled). Disabling stops future runs without deleting the schedule. Returns the raw ImmyBot result.
`immy_schedules`	Pro	Write	[ImmyBot] Create a maintenance schedule. Provide a JSON object body (fieldsJson) — typically name, the target (tenant/computer/tag), the trigger/recurrence, and the maintenance items to run. Returns the created schedule JSON. Duplicate an existing one instead with immy_schedules_duplicate.
`immy_schedules_bulk_cancel`	Pro	Destructive	[ImmyBot] Bulk-cancel running maintenance schedules, stopping their in-flight maintenance sessions. Provide a JSON object body (fieldsJson) naming the target schedule ids. This interrupts automation mid-run and cannot be undone. Returns the raw ImmyBot result.
`immy_schedules_bulk_delete`	Pro	Destructive	[ImmyBot] Bulk-delete maintenance schedules. Provide a JSON object body (fieldsJson) naming the target schedule ids. This permanently removes the schedules and their future automation; cannot be undone. To only pause them, use immy_patch_schedules_bulk_update_status. Returns the raw ImmyBot result.
`immy_schedules_bulk_run_now`	Pro	Write	[ImmyBot] Trigger multiple maintenance schedules to run immediately. Provide a JSON object body (fieldsJson) naming the target schedule ids. Each starts its maintenance session now. Returns the raw ImmyBot result. Single-schedule variant: immy_schedules_run_now.
`immy_schedules_duplicate`	Pro	Write	[ImmyBot] Duplicate a maintenance schedule by id (from immy_list_schedules), creating a new schedule copied from it. This endpoint takes no parameters — leave fieldsJson as `` unless overrides are supported. Returns the new schedule JSON.
`immy_schedules_run_now`	Pro	Write	[ImmyBot] Trigger a maintenance schedule to run immediately by id (from immy_list_schedules), starting its maintenance session now instead of at the next scheduled time. This endpoint takes no parameters — leave fieldsJson as ``. Returns the raw ImmyBot result. Bulk variant: immy_schedules_bulk_run_now.
`immy_update_schedules`	Pro	Write	[ImmyBot] Update (full replace) a maintenance schedule by id (from immy_list_schedules). Provide the complete JSON object body (fieldsJson) — omitted fields are cleared, so fetch with immy_get_schedules first and send the merged object. Returns the updated schedule JSON.

immy_cancel_schedule parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`scheduleId`	string	yes		The schedule id to cancel (from immy_list_schedules_running_schedule_ids).

immy_delete_schedules parameters

Param	Type	Required	Default	Description
`scheduleId`	string	yes		The schedule id to delete (from immy_list_schedules).

immy_get_schedules parameters

Param	Type	Required	Default	Description
`scheduleId`	string	yes		The schedule id (from immy_list_schedules).

immy_list_schedules parameters

Param	Type	Required	Default	Description
`tenantId`	string	no	null	Optional tenant id to filter schedules to one tenant (from immy_list_tenants). Omit for all tenants.

immy_patch_schedules_bulk_update_status parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the schedule ids and the status to apply.

immy_schedules parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the schedule (name, target, trigger/recurrence, maintenance items).

immy_schedules_bulk_cancel parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body naming the schedule ids to cancel.

immy_schedules_bulk_delete parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body naming the schedule ids to delete.

immy_schedules_bulk_run_now parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body naming the schedule ids to run now.

immy_schedules_duplicate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`scheduleId`	string	yes		The schedule id to duplicate (from immy_list_schedules).

immy_schedules_run_now parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body. This endpoint takes no parameters — leave as `` (the default).
`scheduleId`	string	yes		The schedule id to run now (from immy_list_schedules).

immy_update_schedules parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Complete JSON object body for the schedule (full replace).
`scheduleId`	string	yes		The schedule id to update (from immy_list_schedules).

Dynamic Provider Types

Tool	Plan	Access	Description
`immy_create_global_dynamic_provider_type`	Pro	Write	[ImmyBot] Create a new GLOBAL (cross-tenant) dynamic provider type. Body (fieldsJson) is the provider-type definition — typically name, the provider script/definition, and its configuration-form schema. Returns the created provider type JSON (including its assigned id).
`immy_create_local_dynamic_provider_type`	Pro	Write	[ImmyBot] Create a new LOCAL (tenant-scoped) dynamic provider type. Body (fieldsJson) is the provider-type definition — typically name, the provider script/definition, and its configuration-form schema. Returns the created provider type JSON (including its assigned id).
`immy_delete_dynamic_provider_types_global`	Pro	Destructive	[ImmyBot] Permanently delete the GLOBAL dynamic provider type identified by id — this cannot be undone and any provider link built on it will break. Confirm nothing depends on it first (check immy_list_provider_links). id comes from immy_list_dynamic_provider_types.
`immy_delete_dynamic_provider_types_local`	Pro	Destructive	[ImmyBot] Permanently delete the LOCAL dynamic provider type identified by id — this cannot be undone and any provider link built on it will break. Confirm nothing depends on it first (check immy_list_provider_links). id comes from immy_list_dynamic_provider_types.
`immy_delete_dynamic_provider_types_test_environment`	Pro	Destructive	[ImmyBot] Tear down (dispose) the interactive terminal test environment identified by terminalId, releasing its terminal/session resources. This ends any in-progress test session on that terminal. terminalId comes from immy_dynamic_provider_types_test_environment.
`immy_dynamic_provider_type_test_bind_config_form`	Free	Read-only	[ImmyBot] Bind (render/evaluate) the configuration form for a dynamic provider type inside an interactive terminal test environment. This is a POST-as-read (read-only) — it evaluates the form against the supplied values without persisting anything. Pass the terminalId (from immy_dynamic_provider_types_test_environment) and a JSON object body with the current form values/parameters. Returns raw ImmyBot JSON (the bound form model).
`immy_dynamic_provider_types_global_reload`	Pro	Write	[ImmyBot] Reload (recompile/re-evaluate) the GLOBAL dynamic provider type identified by id so running provider links pick up its latest definition. id comes from immy_list_dynamic_provider_types. Body (fieldsJson) carries any reload options — pass `` for a plain reload. Returns raw ImmyBot JSON.
`immy_dynamic_provider_types_local_reload`	Pro	Write	[ImmyBot] Reload (recompile/re-evaluate) the LOCAL dynamic provider type identified by id so running provider links pick up its latest definition. id comes from immy_list_dynamic_provider_types. Body (fieldsJson) carries any reload options — pass `` for a plain reload. Returns raw ImmyBot JSON.
`immy_dynamic_provider_types_reload`	Pro	Write	[ImmyBot] Reload ALL dynamic provider types on the instance (recompile/re-evaluate every dynamic integration definition). Use after bulk edits. Body (fieldsJson) carries any reload options — pass `` for a plain reload-all. Returns raw ImmyBot JSON.
`immy_dynamic_provider_types_test_environment`	Pro	Write	[ImmyBot] Start (provision) an interactive terminal test environment for developing/debugging a dynamic provider type, and get back its terminalId. Pass a JSON object body describing the environment to spin up (typically the provider-type definition/reference and any bootstrap parameters). Use the returned terminalId with immy_dynamic_provider_type_test_bind_config_form and immy_dynamic_provider_types_test_environment_execute_method, then tear it down with immy_delete_dynamic_provider_types_test_environment. Returns raw ImmyBot JSON.
`immy_dynamic_provider_types_test_environment_execute_method`	Pro	Write	[ImmyBot] Invoke a named provider method inside the interactive terminal test environment while developing a dynamic provider type. Pass the terminalId (from immy_dynamic_provider_types_test_environment), the method name to execute, and a JSON object body with the method arguments. Runs provider code in the test terminal — get user approval before executing. Returns raw ImmyBot JSON (the method result).
`immy_get_dynamic_provider_types_global`	Free	Read-only	[ImmyBot] Get a single GLOBAL (cross-tenant) dynamic provider type by id (from immy_list_dynamic_provider_types), including its definition/script and configuration schema. Returns raw ImmyBot JSON.
`immy_get_dynamic_provider_types_local`	Free	Read-only	[ImmyBot] Get a single LOCAL (tenant-scoped) dynamic provider type by id (from immy_list_dynamic_provider_types), including its definition/script and configuration schema. Returns raw ImmyBot JSON.
`immy_list_dynamic_provider_types`	Free	Read-only	[ImmyBot] List the dynamic (code-defined) integration provider types configured on the instance (both global and local). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Use the returned ids with immy_get_dynamic_provider_types_global / immy_get_dynamic_provider_types_local. Returns raw ImmyBot JSON.
`immy_update_global_dynamic_provider_type`	Pro	Write	[ImmyBot] Update the GLOBAL dynamic provider type identified by id (from immy_list_dynamic_provider_types). Body (fieldsJson) is the full provider-type definition (replace semantics, not a partial patch). Editing a provider type affects every provider link built on it — reload afterwards with immy_dynamic_provider_types_global_reload so running links pick up the change. Returns the updated provider type JSON.
`immy_update_local_dynamic_provider_type`	Pro	Write	[ImmyBot] Update the LOCAL dynamic provider type identified by id (from immy_list_dynamic_provider_types). Body (fieldsJson) is the full provider-type definition (replace semantics, not a partial patch). Reload afterwards with immy_dynamic_provider_types_local_reload so running links pick up the change. Returns the updated provider type JSON.

immy_create_global_dynamic_provider_type parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Dynamic-provider-type definition JSON (name, provider script/definition, configuration schema, ...).

immy_create_local_dynamic_provider_type parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Dynamic-provider-type definition JSON (name, provider script/definition, configuration schema, ...).

immy_delete_dynamic_provider_types_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		Global dynamic-provider-type id to delete (from immy_list_dynamic_provider_types).

immy_delete_dynamic_provider_types_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local dynamic-provider-type id to delete (from immy_list_dynamic_provider_types).

immy_delete_dynamic_provider_types_test_environment parameters

Param	Type	Required	Default	Description
`terminalId`	string	yes		The test-environment terminal id to tear down (from immy_dynamic_provider_types_test_environment).

immy_dynamic_provider_type_test_bind_config_form parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body — the current configuration-form values/parameters to bind against.
`terminalId`	string	yes		The test-environment terminal id (from immy_dynamic_provider_types_test_environment).

immy_dynamic_provider_types_global_reload parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with reload options; pass `` for a plain reload.
`id`	string	yes		Global dynamic-provider-type id (from immy_list_dynamic_provider_types).

immy_dynamic_provider_types_local_reload parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with reload options; pass `` for a plain reload.
`id`	string	yes		Local dynamic-provider-type id (from immy_list_dynamic_provider_types).

immy_dynamic_provider_types_reload parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with reload options; pass `` for a plain reload-all.

immy_dynamic_provider_types_test_environment parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the test environment to provision (provider-type definition/reference, bootstrap parameters, ...).
`terminalId`	string	yes		The test-environment terminal id to (re)initialize. Use immy_delete_dynamic_provider_types_test_environment to tear it down when done.

immy_dynamic_provider_types_test_environment_execute_method parameters

Param	Type	Required	Description
`fieldsJson`	string	yes	JSON object body with the method arguments.
`method`	string	yes	The provider method name to execute in the test environment.
`terminalId`	string	yes	The test-environment terminal id (from immy_dynamic_provider_types_test_environment).

immy_get_dynamic_provider_types_global parameters

Param	Type	Required	Default	Description
`id`	string	yes		Global dynamic-provider-type id (from immy_list_dynamic_provider_types).

immy_get_dynamic_provider_types_local parameters

Param	Type	Required	Default	Description
`id`	string	yes		Local dynamic-provider-type id (from immy_list_dynamic_provider_types).

immy_list_dynamic_provider_types parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression (e.g. `name@=connectwise`).
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression (e.g. `-updatedDate`).

immy_update_global_dynamic_provider_type parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full dynamic-provider-type definition JSON (replace semantics).
`id`	string	yes		Global dynamic-provider-type id (from immy_list_dynamic_provider_types).

immy_update_local_dynamic_provider_type parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full dynamic-provider-type definition JSON (replace semantics).
`id`	string	yes		Local dynamic-provider-type id (from immy_list_dynamic_provider_types).

Diagnostics & Metrics

Tool	Plan	Access	Description
`immy_application_locks_request_cancellation`	Pro	Write	[ImmyBot] Request cancellation of the operation holding an application lock (a cooperative cancel — it signals the running operation to stop, releasing its lock). Pass a JSON object body identifying the lock/operation to cancel (typically the lock key/id from immy_list_application_locks). Returns raw ImmyBot JSON.
`immy_application_logs_source_context`	Pro	Write	[ImmyBot] Set (override) the minimum log level for one application-log source context — raise verbosity on a subsystem while diagnosing, e.g. to Debug/Verbose. Pass a JSON object body with the source context and desired level (see immy_list_application_logs_source_contexts for valid contexts). Clear it later with immy_application_logs_source_context_clear. Returns raw ImmyBot JSON.
`immy_application_logs_source_context_clear`	Pro	Write	[ImmyBot] Clear the log-level override for a single application-log source context, returning it to the instance default. Pass a JSON object body identifying the source context to clear (from immy_list_application_logs_source_contexts). Returns raw ImmyBot JSON.
`immy_application_logs_source_context_clear_all`	Pro	Write	[ImmyBot] Clear ALL application-log source-context level overrides at once, returning every subsystem to the instance default log level. Body (fieldsJson) carries any options — pass `` for a plain clear-all. Returns raw ImmyBot JSON.
`immy_application_logs_streaming`	Pro	Write	[ImmyBot] Start/stop or configure live application-log streaming (the diagnostic log tail the ImmyBot UI opens). Pass a JSON object body with the streaming options (e.g. enable/disable, minimum level, source-context filter). Returns raw ImmyBot JSON.
`immy_list_application_locks`	Free	Read-only	[ImmyBot] List the currently held application locks (the concurrency guards ImmyBot uses to serialize instance-level operations). Useful for diagnosing why an operation is queued/blocked. Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_application_locks_realtime_event_stream`	Free	Read-only	[ImmyBot] Get the realtime event-stream snapshot for application locks — the feed the ImmyBot UI subscribes to for live lock acquire/release events. Read-only diagnostic. Returns raw ImmyBot JSON.
`immy_list_application_logs_source_contexts`	Free	Read-only	[ImmyBot] List the known application-log source contexts (the logger source-context categories, e.g. per subsystem) and their current log-level overrides. Use these values with immy_application_logs_source_context to raise/lower verbosity. Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_audits_global_dx`	Free	Read-only	[ImmyBot] DevExtreme grid feed of GLOBAL (instance-wide) audit records — who changed what across the instance. Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort JSON and requireTotalCount. Returns raw ImmyBot JSON.
`immy_list_audits_local_dx`	Free	Read-only	[ImmyBot] DevExtreme grid feed of LOCAL (tenant-scoped) audit records — who changed what within the current tenant scope. Uses skip/take paging (take max 100) plus optional DevExtreme filter/sort JSON and requireTotalCount. Returns raw ImmyBot JSON.
`immy_list_metrics_circuit_breakers`	Free	Read-only	[ImmyBot] List the provider-link circuit breakers and their current state (closed/open/half-open) — ImmyBot opens a breaker to stop hammering a failing integration. Use this to spot degraded provider links before isolating/resetting one. Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Returns raw ImmyBot JSON.
`immy_list_metrics_provider_links`	Free	Read-only	[ImmyBot] List per-provider-link metrics (throughput, error, and rate-limit health for each integration link). Sieve-paginated: Page + pageSize (max 100) + optional Filters/Sorts. Drill into one link with immy_list_metrics_provider_links_rate_limit_statistics. Returns raw ImmyBot JSON.
`immy_list_metrics_provider_links_rate_limit_statistics`	Free	Read-only	[ImmyBot] Get the rate-limit statistics for a single provider link (requests, throttles, and backoff windows) by providerLinkId (from immy_list_provider_links or immy_list_metrics_provider_links). Returns raw ImmyBot JSON.
`immy_metrics_circuit_breakers_isolate`	Pro	Destructive	[ImmyBot] Force a provider-link circuit breaker OPEN (isolate it), immediately halting all traffic to that integration until it is reset. Destructive — it takes the integration offline; get user approval first. Pass a JSON object body identifying the breaker/provider link to isolate (from immy_list_metrics_circuit_breakers). Undo with immy_metrics_circuit_breakers_reset. Returns raw ImmyBot JSON.
`immy_metrics_circuit_breakers_reset`	Pro	Write	[ImmyBot] Reset a provider-link circuit breaker back to closed (healthy), resuming traffic to the integration — the counterpart to immy_metrics_circuit_breakers_isolate and the recovery for a breaker that tripped on failures. Pass a JSON object body identifying the breaker/provider link to reset (from immy_list_metrics_circuit_breakers). Returns raw ImmyBot JSON.

immy_application_locks_request_cancellation parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the lock/operation to cancel (e.g. its key/id from immy_list_application_locks).

immy_application_logs_source_context parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body — the source context and the log level to apply (from immy_list_application_logs_source_contexts).

immy_application_logs_source_context_clear parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the source context to clear (from immy_list_application_logs_source_contexts).

immy_application_logs_source_context_clear_all parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with options; pass `` to clear all overrides.

immy_application_logs_streaming parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with streaming options (enable/disable, level, source-context filter, ...).

immy_list_application_locks parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_application_logs_source_contexts parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_audits_global_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional DevExtreme filter expression (JSON array string).
`requireTotalCount`	boolean	no	null	When true, include the total record count in the response.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Optional.
`sort`	string	no	null	Optional DevExtreme sort expression (JSON array string).
`take`	integer	no	null	Number of records to return (DevExtreme take, max 100). Optional.

immy_list_audits_local_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	Optional DevExtreme filter expression (JSON array string).
`requireTotalCount`	boolean	no	null	When true, include the total record count in the response.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Optional.
`sort`	string	no	null	Optional DevExtreme sort expression (JSON array string).
`take`	integer	no	null	Number of records to return (DevExtreme take, max 100). Optional.

immy_list_metrics_circuit_breakers parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_metrics_provider_links parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Optional Sieve filter expression.
`page`	integer	no	null	1-based page number (Sieve Page). Optional.
`pageSize`	integer	no	null	Records per page (Sieve pageSize, max 100). Optional.
`sorts`	string	no	null	Optional Sieve sort expression.

immy_list_metrics_provider_links_rate_limit_statistics parameters

Param	Type	Required	Default	Description
`providerLinkId`	string	yes		The provider-link id (from immy_list_provider_links / immy_list_metrics_provider_links).

immy_metrics_circuit_breakers_isolate parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the circuit breaker / provider link to isolate (from immy_list_metrics_circuit_breakers).

immy_metrics_circuit_breakers_reset parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body identifying the circuit breaker / provider link to reset (from immy_list_metrics_circuit_breakers).

Brandings

Tool	Plan	Access	Description
`immy_brandings`	Pro	Write	[ImmyBot] Create a new branding profile. Provide a JSON object body describing the branding (typically name, logo references, colors, support contact, date/time format). Preview it first with immy_brandings_send_test_email.
`immy_brandings_global_default`	Pro	Write	[ImmyBot] Promote a branding profile (by id, from immy_list_brandings) to the system-wide default used when no more-specific branding applies. Takes only the branding id in the path; no body.
`immy_brandings_send_test_email`	Pro	Write	[ImmyBot] Send a preview email using the supplied branding values WITHOUT persisting them — useful to visually verify a branding before creating/updating it. Provide a JSON object body with the branding values plus the recipient/preview details. To test SMTP connectivity instead, use immy_smtp_configs_send_test_email.
`immy_brandings_validate_time_format`	Free	Read-only	[ImmyBot] Validate a .NET date-time format string by formatting the current time with it, and return the formatted result. Read-only despite being an HTTP POST — nothing is persisted. The format string travels in the URL path (e.g. timeFormat="yyyy-MM-dd HH:mm"). Use before saving a branding profile's date/time format.
`immy_delete_brandings`	Pro	Destructive	[ImmyBot] Permanently delete a branding profile by id (from immy_list_brandings). Cannot be undone. If the profile is the global default or referenced by tenants, reassign those first (immy_brandings_global_default).
`immy_get_brandings`	Free	Read-only	[ImmyBot] Fetch a single branding profile by id (from immy_list_brandings). Returns the full branding configuration (name, logos, colors, support contact, date/time format).
`immy_list_brandings`	Free	Read-only	[ImmyBot] List all branding profiles visible to the caller. Paginated via Sieve: page (1-based) + pageSize (max 100); filters/sorts accept Sieve expressions. Feed a branding id to immy_get_brandings / immy_update_brandings / immy_delete_brandings, or promote one with immy_brandings_global_default.
`immy_list_brandings_support_branding`	Free	Read-only	[ImmyBot] Fetch the support-sidebar branding override published by the active dynamic provider (the branding shown to end users in the support experience). Takes no parameters.
`immy_update_brandings`	Pro	Write	[ImmyBot] Replace a branding profile by id (from immy_list_brandings). Provide the full JSON object body — ImmyBot replaces the profile (HTTP PUT), so include all fields, not just the ones you are changing. Read the current profile with immy_get_brandings first.

immy_brandings parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new branding profile.

immy_brandings_global_default parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the branding profile to make the system-wide default (from immy_list_brandings).

immy_brandings_send_test_email parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the branding values and preview recipient details.

immy_brandings_validate_time_format parameters

Param	Type	Required	Default	Description
`timeFormat`	string	yes		The .NET date-time format string to validate, e.g. "yyyy-MM-dd HH:mm:ss".

immy_delete_brandings parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the branding profile to delete (from immy_list_brandings).

immy_get_brandings parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the branding profile (from immy_list_brandings).

immy_list_brandings parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression, e.g. "Name@=support". Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "Name" or "-Name" (descending). Omit for the default order.

immy_update_brandings parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full JSON object body for the branding profile (replaces the existing profile).
`id`	string	yes		The id of the branding profile to replace (from immy_list_brandings).

Maintenance Email Jobs

Tool	Plan	Access	Description
`immy_maintenance_email_reboot_now`	Pro	Destructive	[ImmyBot] Reboot the target computer immediately for a maintenance email (the 'reboot now' link recipients click). DESTRUCTIVE — it forces an immediate reboot of the end user's machine, despite being an HTTP GET. Identify the email by its GUID.
`immy_postpone_maintenance_email_job`	Pro	Write	[ImmyBot] Postpone the scheduled maintenance linked to a maintenance email (the 'postpone' link recipients click). An ACTION despite being an HTTP GET — it reschedules the job. Identify the email by its GUID.
`immy_run_maintenance_email_job_now`	Pro	Write	[ImmyBot] Trigger the scheduled maintenance action linked to a maintenance email to run immediately (the 'run now' link recipients click). This is an ACTION, not a read, despite being an HTTP GET — it starts maintenance on the target computer. Identify the email by its GUID (from a maintenance-email record).

immy_maintenance_email_reboot_now parameters

Param	Type	Required	Default	Description
`emailGuid`	string	yes		The maintenance email GUID whose target computer should reboot now.

immy_postpone_maintenance_email_job parameters

Param	Type	Required	Default	Description
`emailGuid`	string	yes		The maintenance email GUID whose job should be postponed.

immy_run_maintenance_email_job_now parameters

Param	Type	Required	Default	Description
`emailGuid`	string	yes		The maintenance email GUID whose job should run now.

Notifications

Tool	Plan	Access	Description
`immy_delete_notifications_unsilence`	Pro	Destructive	[ImmyBot] Remove one of the current user's notification silences by its silence id (from immy_list_notifications) — future notifications of that type/object will alert again. Flagged destructive as it deletes the silence record. To create a silence use immy_notifications_silence.
`immy_list_notifications`	Free	Read-only	[ImmyBot] List the current user's ACTIVE notification silences (the notification types/objects currently muted). Paginated via Sieve: page + pageSize (max 100), filters/sorts. To list the notifications themselves use immy_list_notifications_dx or immy_list_notifications_unacknowledged; add a silence with immy_notifications_silence and remove one with immy_delete_notifications_unsilence.
`immy_list_notifications_dx`	Free	Read-only	[ImmyBot] List notifications visible to the current user, formatted for the DevExtreme data grid. Paginated via DevExtreme skip + take (take max 100); filter/sort accept DevExtreme expressions; requireTotalCount adds a total. This is the primary read for the notification feed itself.
`immy_list_notifications_unacknowledged`	Free	Read-only	[ImmyBot] List the current user's unacknowledged, unresolved notifications, newest first. Optionally cap the result count with limit. Acknowledge them with immy_notifications_acknowledge.
`immy_notifications_acknowledge`	Pro	Write	[ImmyBot] Acknowledge a batch of notifications on behalf of the current user. Provide a JSON body identifying the notifications to acknowledge (typically an array of notification ids or an object wrapping one). List candidates with immy_list_notifications_unacknowledged.
`immy_notifications_silence`	Pro	Write	[ImmyBot] Silence future notifications of a given type for the current user, optionally narrowed to a specific object. type is the notification type (path). Provide objectId to silence only notifications for that object, or omit it to silence the whole type. Remove a silence with immy_delete_notifications_unsilence.

immy_delete_notifications_unsilence parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the notification silence to remove (from immy_list_notifications).

immy_list_notifications parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression, e.g. "-CreatedAt". Omit for the default order.

immy_list_notifications_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response.
`skip`	integer	no	null	Records to skip (DevExtreme skip). Omit for 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for the default order.
`take`	integer	no	null	Records to take (DevExtreme take). Max 100; omit for the server default.

immy_list_notifications_unacknowledged parameters

Param	Type	Required	Default	Description
`limit`	integer	no	null	Maximum number of notifications to return (newest first). Omit for the server default.

immy_notifications_acknowledge parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON body identifying the notifications to acknowledge (e.g. { "notificationIds": [1,2,3] }).

immy_notifications_silence parameters

Param	Type	Required	Default	Description
`objectId`	string	no	null	Optional object id to narrow the silence to a single object. Omit to silence the whole type.
`type`	string	yes		The notification type to silence (path segment).

Notification Preferences

Tool	Plan	Access	Description
`immy_get_preferences_tenants`	Free	Read-only	[ImmyBot] Fetch the preferences for a specific tenant by tenant id (from immy_list_tenants). Update them with immy_patch_preferences_tenants.
`immy_list_preferences`	Free	Read-only	[ImmyBot] Fetch the bundled application, tenant, and user preferences for the current user. Paginated via Sieve params where applicable. Update scopes with immy_patch_preferences_application / immy_patch_preferences_my / immy_patch_preferences_tenants.
`immy_patch_preferences_application`	Pro	Write	[ImmyBot] Apply a JSON Patch document to the application-wide (instance) preferences. Provide a JSON Patch array, e.g. [{"op":"replace","path":"/someSetting","value":true}]. Read the current values with immy_list_preferences first.
`immy_patch_preferences_my`	Pro	Write	[ImmyBot] Apply a JSON Patch document to the calling user's own preferences. Provide a JSON Patch array, e.g. [{"op":"replace","path":"/emailNotifications","value":false}].
`immy_patch_preferences_tenants`	Pro	Write	[ImmyBot] Apply a JSON Patch document to a specific tenant's preferences (tenant id from immy_list_tenants). Provide a JSON Patch array, e.g. [{"op":"replace","path":"/someSetting","value":123}]. Read the current values with immy_get_preferences_tenants first.

immy_get_preferences_tenants parameters

Param	Type	Required	Default	Description
`tenantId`	string	yes		The tenant id whose preferences to fetch (from immy_list_tenants).

immy_list_preferences parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_patch_preferences_application parameters

Param	Type	Required	Default	Description
`patchJson`	string	yes		JSON Patch document (array of operations) for the application-wide preferences.

immy_patch_preferences_my parameters

Param	Type	Required	Default	Description
`patchJson`	string	yes		JSON Patch document (array of operations) for the current user's preferences.

immy_patch_preferences_tenants parameters

Param	Type	Required	Default	Description
`patchJson`	string	yes		JSON Patch document (array of operations) for the tenant's preferences.
`tenantId`	string	yes		The tenant id whose preferences to patch (from immy_list_tenants).

SMTP Configuration

Tool	Plan	Access	Description
`immy_create_smtp_config`	Pro	Write	[ImmyBot] Create the SMTP configuration for a tenant. Provide a JSON object body with the outbound mail settings (host, port, credentials, from-address, TLS, and the tenant id). Verify it first with immy_smtp_configs_send_test_email.
`immy_delete_smtp_configs`	Pro	Destructive	[ImmyBot] Remove the SMTP configuration for a specific tenant (by tenant id from immy_list_tenants). Destructive — after removal that tenant falls back to inherited/default mail settings until a new config is created.
`immy_get_smtp_configs`	Free	Read-only	[ImmyBot] Fetch the SMTP configuration for a specific tenant by tenant id (from immy_list_tenants). Returns the outbound mail settings for that tenant.
`immy_list_smtp_configs`	Free	Read-only	[ImmyBot] List all SMTP configurations visible to the caller (per-tenant outbound mail settings). Paginated via Sieve: page + pageSize (max 100), filters/sorts. Fetch one with immy_get_smtp_configs and test connectivity with immy_smtp_configs_send_test_email.
`immy_list_smtp_configs_delivery_logs_dx`	Free	Read-only	[ImmyBot] List SMTP delivery logs for a specific tenant (by tenant id from immy_list_tenants), formatted for the DevExtreme data grid. Paginated via DevExtreme skip + take (take max 100); filter/sort accept DevExtreme expressions; requireTotalCount adds a total. Use to diagnose failed/queued outbound mail.
`immy_replace_tenant_smtp_config`	Pro	Write	[ImmyBot] Replace the SMTP configuration for a specific tenant (by tenant id from immy_list_tenants). Provide the full JSON object body with the outbound mail settings — this replaces the tenant's existing configuration. Read the current one with immy_get_smtp_configs first.
`immy_smtp_configs_send_test_email`	Pro	Write	[ImmyBot] Send a test email using the supplied SMTP settings to verify connectivity — settings are used for the test only. Provide a JSON object body with the SMTP settings and the test recipient. To preview branding instead, use immy_brandings_send_test_email.

immy_create_smtp_config parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body for the new SMTP configuration.

immy_delete_smtp_configs parameters

Param	Type	Required	Default	Description
`tenantId`	string	yes		The tenant id whose SMTP configuration to remove (from immy_list_tenants).

immy_get_smtp_configs parameters

Param	Type	Required	Default	Description
`tenantId`	string	yes		The tenant id whose SMTP configuration to fetch (from immy_list_tenants).

immy_list_smtp_configs parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_smtp_configs_delivery_logs_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON array form). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response.
`skip`	integer	no	null	Records to skip (DevExtreme skip). Omit for 0.
`sort`	string	no	null	DevExtreme sort expression (JSON array form). Omit for the default order.
`take`	integer	no	null	Records to take (DevExtreme take). Max 100; omit for the server default.
`tenantId`	string	yes		The tenant id whose delivery logs to list (from immy_list_tenants).

immy_replace_tenant_smtp_config parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		Full JSON object body with the SMTP settings (replaces the existing config).
`tenantId`	string	yes		The tenant id whose SMTP configuration to replace (from immy_list_tenants).

immy_smtp_configs_send_test_email parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the SMTP settings and test recipient details.

Billing

Tool	Plan	Access	Description
`immy_billing_billing_information`	Pro	Write	[ImmyBot] Update the billing contact/account information for this ImmyBot instance (billing address, contact, tax details). Provide a JSON object body with the fields to set. Read the current values first with immy_list_billing_information.
`immy_billing_cancel_subscription`	Pro	Destructive	[ImmyBot] Cancel this ImmyBot instance's subscription — a billing state change that can end service at the term boundary or immediately depending on the options. The body is usually empty (); pass a JSON object only if the endpoint accepts cancellation options. Reverse with immy_billing_reactivate_subscription.
`immy_billing_reactivate_subscription`	Pro	Write	[ImmyBot] Reactivate a cancelled/paused subscription for this ImmyBot instance. The body is usually empty (); pass a JSON object only if the endpoint accepts reactivation options. Inverse of immy_billing_cancel_subscription.
`immy_billing_update_addon`	Pro	Write	[ImmyBot] Add, remove, or change the quantity of a subscription add-on for this ImmyBot instance. Provide a JSON object body identifying the add-on and its target quantity/state. Review current usage with immy_list_billing_feature_usage_counts and the plan with immy_list_billing_subscription_details.
`immy_billing_update_subscription`	Pro	Write	[ImmyBot] Change this ImmyBot instance's subscription (plan/term/quantities). Provide a JSON object body describing the target subscription. Read the current state with immy_list_billing_subscription_details first; to remove the subscription entirely use immy_billing_cancel_subscription.
`immy_delete_billing_payment_sources`	Pro	Destructive	[ImmyBot] Permanently remove a payment source (credit card) from this ImmyBot instance's billing account, by payment-source id (from immy_list_billing_credit_cards). Irreversible — removing the only active payment source may interrupt renewal.
`immy_list_billing_billing_platform_details`	Free	Read-only	[ImmyBot] Get the billing-platform details for this ImmyBot instance (which billing provider/platform backs the subscription and its configuration). Read-only. See also immy_list_billing_information and immy_list_billing_subscription_details.
`immy_list_billing_credit_cards`	Free	Read-only	[ImmyBot] List the credit cards / payment sources on file for this ImmyBot instance's subscription. Paginated via Sieve: page (1-based) + pageSize (max 100), plus optional filters/sorts. Remove a payment source with immy_delete_billing_payment_sources.
`immy_list_billing_download_invoice`	Free	Read-only	[ImmyBot] Get a download reference for a billing invoice. Optionally pass invoiceId to target a specific invoice; omit it for the default/latest. Returns a JSON payload (e.g. a download URL / invoice metadata) — this is a normal JSON read, not a binary stream.
`immy_list_billing_feature_usage_counts`	Free	Read-only	[ImmyBot] Get the metered feature-usage counts for this ImmyBot instance (the quantities that drive add-on / subscription billing). Read-only. Adjust add-ons with immy_billing_update_addon.
`immy_list_billing_information`	Free	Read-only	[ImmyBot] Get the billing contact/account information on file for this ImmyBot instance (billing address, contact, tax details). Read-only. Update it with immy_billing_billing_information.
`immy_list_billing_product_catalog`	Free	Read-only	[ImmyBot] Get the billing product catalog — the plans/products available for this ImmyBot instance's subscription. Read-only. For the individual line items use immy_list_billing_product_catalog_items.
`immy_list_billing_product_catalog_items`	Free	Read-only	[ImmyBot] List the individual items in the billing product catalog (the purchasable products/add-ons and their pricing). Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts. For the catalog summary use immy_list_billing_product_catalog.
`immy_list_billing_subscription_details`	Free	Read-only	[ImmyBot] Get the current subscription details for this ImmyBot instance (plan, status, term, add-ons, renewal). Read-only. Change it with immy_billing_update_subscription / immy_billing_update_addon, or cancel with immy_billing_cancel_subscription.

immy_billing_billing_information parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the billing information fields to set.

immy_billing_cancel_subscription parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of cancellation options. Defaults to an empty object ().

immy_billing_reactivate_subscription parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of reactivation options. Defaults to an empty object ().

immy_billing_update_addon parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the add-on change (add-on id and target quantity/state).

immy_billing_update_subscription parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the target subscription (plan/term/quantities).

immy_delete_billing_payment_sources parameters

Param	Type	Required	Default	Description
`paymentSourceId`	string	yes		The id of the payment source to delete (from immy_list_billing_credit_cards).

immy_list_billing_credit_cards parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_list_billing_download_invoice parameters

Param	Type	Required	Default	Description
`invoiceId`	string	no	null	The id of the invoice to download (from the billing/subscription reads). Omit for the default/latest invoice.

immy_list_billing_product_catalog_items parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

System

Tool	Plan	Access	Description
`immy_change_requests_approve`	Pro	Write	[ImmyBot] Approve a deployment change-request by id (from immy_list_change_requests_dx), applying the proposed target-assignment edit. The body is usually empty (); pass a JSON object only if the endpoint accepts approval options.
`immy_change_requests_comment`	Pro	Write	[ImmyBot] Add a comment to a deployment change-request by id (from immy_list_change_requests_dx) without changing its approval state. Provide a JSON object body with the comment text.
`immy_change_requests_deny`	Pro	Write	[ImmyBot] Deny (reject) a deployment change-request by id (from immy_list_change_requests_dx), declining to apply the proposed edit. The body is usually empty (); pass a JSON object only if the endpoint accepts a denial reason. To request revisions instead use immy_change_requests_require_changes.
`immy_change_requests_require_changes`	Pro	Write	[ImmyBot] Send a deployment change-request back for revision by id (from immy_list_change_requests_dx) — neither approving nor denying, but requesting changes from the submitter. The body is usually empty (); pass a JSON object only if the endpoint accepts requested-change details.
`immy_delete_change_requests`	Pro	Destructive	[ImmyBot] Permanently delete a deployment change-request by id (from immy_list_change_requests_dx), discarding the proposed change without applying it. Irreversible. To reject-but-keep for revision use immy_change_requests_deny or immy_change_requests_require_changes.
`immy_get_ephemeral_session`	Free	Read-only	[ImmyBot] Get the state of a specific ephemeral-agent session, keyed by ephemeral-session id, agent-instance id, and provider-agent id (all from the ephemeral-agent launch flow — see immy_launch_ephemeral_agent / immy_list_computers_ephemeral_agent). Read-only.
`immy_get_webhooks`	Free	Read-only	[ImmyBot] Get a webhook configuration by id. Returns the webhook's target URL, events, and settings. Update it with immy_webhooks.
`immy_list_change_requests_dx`	Free	Read-only	[ImmyBot] List deployment change-requests (proposed edits to target-assignments awaiting approval) as a DevExtreme grid feed. Uses DevExtreme paging: skip + take (take max 100), with optional filter/sort (DevExtreme JSON expressions) and requireTotalCount. Act on a change-request with immy_change_requests_approve / immy_change_requests_deny / immy_change_requests_require_changes / immy_change_requests_comment.
`immy_list_change_requests_open_count`	Free	Read-only	[ImmyBot] Get the count of open (pending) deployment change-requests. Read-only — a quick badge/summary value. List the requests themselves with immy_list_change_requests_dx.
`immy_list_ephemeral_session_development_latest_ephemeral_binary`	Free	Read-only	[ImmyBot] Get metadata for the latest development ephemeral-agent binary (version/hash/reference used to launch ephemeral agents). Read-only JSON — not a binary stream. Related: immy_launch_ephemeral_agent, immy_get_ephemeral_session.
`immy_list_immy_agent_metadata_agent_hash`	Free	Read-only	[ImmyBot] Get the current Immy-agent binary hash/metadata (the version fingerprint managed endpoints are expected to run). Read-only — useful for verifying agent currency across the fleet.
`immy_list_system_immy_support_access_grant_details`	Free	Read-only	[ImmyBot] Get the details of any current Immy (vendor) support-access grant on this instance — who was granted access and until when. Read-only. Toggle access with immy_system_enable_immy_support_access / immy_system_disable_immy_support_access.
`immy_list_system_releases`	Free	Read-only	[ImmyBot] List the available ImmyBot platform releases (versions on the update channels). Paginated via Sieve: page + pageSize (max 100), plus optional filters/sorts. Change which channel this instance follows with immy_system_update_release_channel; apply an update with immy_system_pull_update.
`immy_list_system_timezones`	Free	Read-only	[ImmyBot] List the timezones known to this ImmyBot instance (the valid identifiers used by schedules and maintenance windows). Read-only reference lookup.
`immy_system_disable_immy_support_access`	Pro	Write	[ImmyBot] Revoke Immy (vendor) support access to this instance. The body is usually empty (); pass a JSON object only if the endpoint accepts options. Re-grant with immy_system_enable_immy_support_access; inspect current state with immy_list_system_immy_support_access_grant_details.
`immy_system_enable_immy_support_access`	Pro	Write	[ImmyBot] Grant Immy (vendor) support access to this instance, letting ImmyBot support staff assist. Provide a JSON object body if the endpoint accepts grant options (e.g. a duration); otherwise send an empty object (). Revoke with immy_system_disable_immy_support_access.
`immy_system_is_immy_support_access_granted`	Free	Read-only	[ImmyBot] Check whether Immy (vendor) support access is currently granted on this instance (a read-only status check, sent as an HTTP POST — it makes no changes). The body is usually empty (); pass a JSON object only if the endpoint accepts query options. For the full grant record use immy_list_system_immy_support_access_grant_details.
`immy_system_pull_update`	Pro	Destructive	[ImmyBot] Trigger this ImmyBot instance to pull and apply a platform update — a disruptive maintenance action that can restart backend services and briefly interrupt the instance. The body is usually empty (); pass a JSON object only to target a specific release. Review available releases with immy_list_system_releases first.
`immy_system_request_form_support`	Pro	Write	[ImmyBot] Submit a support request via the in-product support form. Provide a JSON object body with the request details (subject/description/contact). Sends the request to ImmyBot support.
`immy_system_request_session_support`	Pro	Write	[ImmyBot] Request a live support session (interactive assistance) from ImmyBot support. Provide a JSON object body with the session-request details. Often paired with immy_system_enable_immy_support_access so support staff can connect.
`immy_system_restart_backend`	Pro	Destructive	[ImmyBot] Restart this ImmyBot instance's backend services — disruptive: in-flight maintenance sessions and API calls can be interrupted while services cycle. The body is usually empty (); pass a JSON object only if the endpoint accepts restart options. Use with care.
`immy_system_update_release_channel`	Pro	Write	[ImmyBot] Change which release channel this ImmyBot instance follows (e.g. stable vs preview). Provide a JSON object body naming the target channel. This governs which releases immy_system_pull_update will offer; list releases with immy_list_system_releases.
`immy_webhooks`	Pro	Write	[ImmyBot] Update a webhook configuration by id (sent as an HTTP POST to /webhooks/). Provide a JSON object body with the webhook fields to set (target URL, subscribed events, settings). Read the current state first with immy_get_webhooks.

immy_change_requests_approve parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of approval options. Defaults to an empty object ().
`id`	string	yes		The id of the change-request to approve (from immy_list_change_requests_dx).

immy_change_requests_comment parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the comment (e.g. { "comment": "..." }).
`id`	string	yes		The id of the change-request to comment on (from immy_list_change_requests_dx).

immy_change_requests_deny parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of denial options (e.g. a reason). Defaults to an empty object ().
`id`	string	yes		The id of the change-request to deny (from immy_list_change_requests_dx).

immy_change_requests_require_changes parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body describing the requested changes. Defaults to an empty object ().
`id`	string	yes		The id of the change-request to send back for changes (from immy_list_change_requests_dx).

immy_delete_change_requests parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the change-request to delete (from immy_list_change_requests_dx).

immy_get_ephemeral_session parameters

Param	Type	Required	Description
`agentInstanceId`	string	yes	The agent-instance id for this ephemeral session.
`ephemeralSessionId`	string	yes	The ephemeral-session id.
`providerAgentId`	string	yes	The provider-agent id for this ephemeral session.

immy_get_webhooks parameters

Param	Type	Required	Default	Description
`id`	string	yes		The id of the webhook.

immy_list_change_requests_dx parameters

Param	Type	Required	Default	Description
`filter`	string	no	null	DevExtreme filter expression (JSON). Omit for no filter.
`requireTotalCount`	boolean	no	null	Set true to include a total record count in the response. Omit to skip counting.
`skip`	integer	no	null	Number of records to skip (DevExtreme skip). Omit to start at 0.
`sort`	string	no	null	DevExtreme sort expression (JSON). Omit for the default order.
`take`	integer	no	null	Number of records to take (DevExtreme take). Max 100; omit for the server default.

immy_list_system_releases parameters

Param	Type	Required	Default	Description
`filters`	string	no	null	Sieve filter expression. Omit for no filter.
`page`	integer	no	null	1-based page number (Sieve Page). Omit for the first page.
`pageSize`	integer	no	null	Records per page (Sieve pageSize). Max 100; omit for the server default.
`sorts`	string	no	null	Sieve sort expression. Omit for the default order.

immy_system_disable_immy_support_access parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of options. Defaults to an empty object ().

immy_system_enable_immy_support_access parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of grant options (e.g. duration). Defaults to an empty object ().

immy_system_is_immy_support_access_granted parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of query options. Defaults to an empty object ().

immy_system_pull_update parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body (e.g. a target release). Defaults to an empty object ().

immy_system_request_form_support parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the support-request details (subject, description, contact).

immy_system_request_session_support parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the session-support request details.

immy_system_restart_backend parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	no	""	JSON object body of restart options. Defaults to an empty object ().

immy_system_update_release_channel parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body naming the target release channel (e.g. { "channel": "stable" }).

immy_webhooks parameters

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the webhook fields to set.
`id`	string	yes		The id of the webhook to update.

Tool	Plan	Access	Description
`immy_create_tag`	Pro	Write	[ImmyBot] Create a tag. Provide a JSON object body — typically name (string) plus optional color/description. The created tag id can then be applied via immy_add_tags_to_computers / immy_add_tags_to_persons / immy_add_tags_to_tenants.
`immy_delete_tags`	Pro	Destructive	[ImmyBot] Permanently delete a tag by id (from immy_list_tags). This removes the tag from every computer/person/tenant it is applied to and cannot be undone.
`immy_get_tags`	Free	Read-only	[ImmyBot] Get a single tag by id (from immy_list_tags). Returns the tag's id, name, and configuration.
`immy_list_tags`	Free	Read-only	[ImmyBot] List tags defined in the ImmyBot instance. Tags label computers, persons, and tenants and can be used as deployment/role-assignment targets. Paginated via Sieve: page (1-based) + pageSize (max 100). filters/sorts accept Sieve expressions (e.g. filters="Name@=windows", sorts="Name"). Returns each tag's id and name; feed a tag id to immy_get_tags / immy_update_tag / immy_delete_tags.
`immy_list_tags_authorization`	Free	Read-only	[ImmyBot] Get the authorization (RBAC) settings for a tag by id (from immy_list_tags) — which roles/groups may act on resources carrying this tag. Update it with immy_tags_authorization.
`immy_tags_authorization`	Pro	Write	[ImmyBot] Set the authorization (RBAC) settings for a tag by id (from immy_list_tags) — which roles/groups may act on resources carrying this tag. Provide a JSON object body describing the authorization. Read the current state with immy_list_tags_authorization first.
`immy_update_tag`	Pro	Write	[ImmyBot] Update a tag by id (from immy_list_tags). Provide a JSON object body with the fields to change (e.g. name). Note: ImmyBot updates a tag via HTTP POST to /tags/, not PUT.

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body describing the tag authorization to apply.
`tagId`	string	yes		The id of the tag (from immy_list_tags).

Param	Type	Required	Default	Description
`fieldsJson`	string	yes		JSON object body with the tag fields to change.
`tagId`	string	yes		The id of the tag to update (from immy_list_tags).