Mirth Connect

Connect your own Mirth Connect / NextGen Connect server by saving its base URL and Administrator username/password, after checking they actually work.

List the connected Mirth Connect / NextGen Connect servers.

Disconnect one Mirth Connect / NextGen Connect server. Nothing on the server itself is changed; only the saved credentials here are deleted.

List channels configured on the connected Mirth Connect / NextGen Connect server, optionally filtered to one channel group.

Read one channel's configuration in full.

Create a new channel with a basic source connector. For full connector/transformer configuration, build the channel in Mirth Administrator first, then manage it here.

Update selected fields of an existing channel: name, description, and/or enabled state. Only given fields change.

Permanently delete a channel. Cannot be undone -- undeploy it first if it's currently deployed.

Deploy one or more channels. Verifies each channel's actual resulting state afterward -- Mirth's own deploy endpoint always reports success even when a channel fails to deploy.

Undeploy one or more channels. Verifies each channel's actual resulting state afterward, same reasoning as deploy_channels.

Read one channel's live deployment status (state, whether the deployed revision matches the saved revision).

List live deployment status for every channel on the connected server (state, revision drift) in one call.

Read one channel's message statistics (received/sent/error/filtered/queued counts).

Reset one channel's message statistics counters to zero.

List channel tags (named groupings shown as colored labels in Mirth Administrator) configured on the connected server.

List channel groups (folders that organize channels in Mirth Administrator) configured on the connected server.

Read one channel group in full.

Create a new channel group with an optional set of member channels.

Update selected fields of an existing channel group. Only given fields change.

Permanently delete a channel group. Member channels themselves are not deleted, only the grouping.

Search messages processed by one channel, optionally filtered by status (RECEIVED, FILTERED, TRANSFORMED, SENT, QUEUED, ERROR, PENDING).

Read one message in full -- raw/encoded/transformed content -- from a channel.

Reprocess an existing message through its channel again -- either as a new message or replacing the original.

Permanently remove one message from a channel's message store. Cannot be undone.

Permanently remove ALL messages stored for one channel. Cannot be undone -- use only for a channel you explicitly intend to purge (e.g. clearing test data before go-live).

List Mirth Administrator user accounts on the connected server.

Read one Mirth Administrator user account in full.

Create a new Mirth Administrator user account on the connected server.

Update an existing Mirth Administrator user's email/first/last name.

Permanently delete a Mirth Administrator user account. Cannot be undone.

Set a new password for an existing Mirth Administrator user.

List current login status for every user on the connected server.

Force-log out a Mirth Administrator user, ending their active session.

List alerts configured on the connected Mirth Connect / NextGen Connect server.

Read one alert's details in full.

Permanently delete an alert. Cannot be undone.

Enable or disable an alert without deleting it -- e.g. silence a noisy alert temporarily.

Read the enabled/disabled status overview for every alert on the connected server in one call.

List the protocol options available for alert actions on the connected server (e.g. email, PagerDuty-style webhook channel types configured as extensions).

List code templates (reusable JavaScript snippets) on the connected Mirth Connect / NextGen Connect server.

Read one code template in full, including its JavaScript source.

Create a new code template with JavaScript source code, so it can be reused across channel transformers/filters.

Update an existing code template's name and/or JavaScript source.

Permanently delete a code template. Channels still referencing it keep their own cached copy of the code but lose the shared link.

List code template libraries -- named groups of code templates, optionally scoped to specific channels.

Read one code template library in full, including which code template ids it groups.

Create a new code template library grouping existing code template ids together.

Update an existing code template library's name, description, and/or which code template ids it groups.

Permanently delete a code template library. The code templates themselves are not deleted, only the grouping.

Read the server-wide Configuration Map -- key/value variables any channel can read via configurationMap.get('key').

Create or update one Configuration Map key/value entry, with an optional comment.

Permanently remove one Configuration Map key. Channels reading it afterward will get an empty value.

Read the server's Global Scripts -- Deploy, Undeploy, Preprocessor, and Postprocessor JavaScript that runs for every channel.

Overwrite one or more Global Script slots (deploy, undeploy, preprocessor, postprocessor) with new JavaScript source. Only the slots you pass a non-empty value for are changed. Takes effect for every channel on the server -- review the source carefully before writing.

Read the connected Mirth Connect / NextGen Connect server's own version, build date, and server id.

Read the connected server's current status: uptime, total channel count, and how many are deployed.

Read the connected server's JVM memory and processor stats.

Read the connected server's environment name, server name, and default locale.

Update the connected server's environment name and/or server name.

Read the tail of the connected server's own system log.

Restart the connected Mirth Connect / NextGen Connect server. Every channel is interrupted until the server comes back up. Requires confirm=True.

Read the connected server's host operating system name, version, and architecture.

Read basic edition/version info the connected server reports about itself (Mirth Connect vs NextGen Connect branding, version string).

List available database maintenance tasks on the connected server (e.g. reindexing, statistics rebuilds).

Run one database maintenance task by id on the connected server. Can be slow and impact a busy server -- requires confirm=True.

List extensions (connectors/plugins) installed on the connected Mirth Connect / NextGen Connect server.

Read one extension's details by name.

Enable or disable an extension. Takes effect only after the next server restart.

Read the configuration properties stored for one plugin extension.

List events from the connected server's own audit trail (who did what, at what level, and the outcome), optionally filtered by level or user.

Read one audit event in full by id.

Permanently clear the entire audit event log on the connected server. Cannot be undone -- requires confirm=True.

Deploy one or more channels and re-verify their live status afterward -- Mirth's own deploy endpoint always reports success even when a channel silently failed to deploy, so this checks the real outcome before reporting back.

Build one aggregated health report across every channel on the connected server -- counts by state, channels with queued/error messages, and a per-channel flag for anything that needs attention.

Compare a channel's live revision number against an expected revision (e.g. the one recorded in your own version control) -- a fast check for configuration drift before a riskier redeploy.

Export one channel as XML (Mirth Administrator's own Import/Export format) -- use for a manual backup before a risky change.

Export every channel on the connected server as XML in one call -- a full backup of the current channel configuration.

Import a channel from XML (as produced by export_channel/export_all_channels) as a NEW channel, optionally deploying it immediately.

Run the same lifecycle action (deploy, undeploy, enable, or disable) across several channels in one call, by explicit channel ids.