Mira Plugin Stop

Stop a plugin in Mira App Server

Mira Plugin Stop

AI-generated

Overview

The "Mira Plugin Stop" node is designed to stop a specific plugin running on a Mira App Server. It sends a POST request to the server's API endpoint responsible for stopping plugins by their ID. This node is useful in automation workflows where you need to programmatically control the lifecycle of plugins, such as halting a plugin before updating it or managing resource usage by stopping unused plugins.

Practical examples:

  • Automatically stopping a plugin after a certain event or condition is met.
  • Integrating with deployment pipelines to stop plugins before redeploying them.
  • Managing plugin states dynamically based on system load or user actions.

Properties

Name Meaning
Token Source Choose where to get the access token from: either from stored credentials or from input data.
Server URL The URL of the Mira App Server (required if token source is from input).
Access Token The access token used for authentication, can be provided directly or via input data.
Plugin ID The unique identifier of the plugin that you want to stop (required).

Output

The node outputs JSON data with the following structure:

{
  "stopped": true,
  "pluginId": "<the plugin ID provided>",
  "response": "<full response from the Mira API>",
  "timestamp": "<ISO timestamp of when the operation was performed>",
  "operation": "stop"
}
  • stopped: A boolean indicating the plugin stop operation was triggered.
  • pluginId: The ID of the plugin that was requested to stop.
  • response: The raw response returned by the Mira App Server API.
  • timestamp: The exact time when the stop operation was executed.
  • operation: The string "stop" indicating the type of operation performed.

This output allows downstream nodes or processes to verify the success and details of the stop action.

Dependencies

  • Requires access to a Mira App Server with its API accessible.
  • Needs an access token for authentication, which can be supplied either via credentials configured in n8n or directly through input data.
  • The node depends on HTTP communication with the Mira App Server's REST API.

Troubleshooting

  • Missing Plugin ID: The node will throw an error if the Plugin ID property is empty. Ensure this field is filled with a valid plugin identifier.
  • Authentication Errors: If the access token is invalid or missing, the API call will fail. Verify that the token is correct and has sufficient permissions.
  • Server Connectivity Issues: If the server URL is incorrect or the server is unreachable, the node will not be able to perform the stop operation. Confirm the server URL and network connectivity.
  • API Response Errors: If the plugin cannot be stopped (e.g., plugin not found or already stopped), the API response will indicate the failure. Check the response field in the output for detailed error messages.

Links and References

  • Mira App Server API documentation (for plugin management endpoints)
  • n8n documentation on creating custom nodes and handling HTTP requests
  • General REST API best practices for authentication and error handling

Discussion