Overview
This node integrates with the Mikrotik API, allowing users to perform various operations on Mikrotik devices. It is designed to interact programmatically with Mikrotik routers and network equipment, enabling automation of configuration, monitoring, and management tasks.
The "custom" operation under the "Default" resource provides a flexible way to send arbitrary commands or queries to the Mikrotik device. This is useful when predefined operations do not cover specific use cases or when advanced users want to execute custom commands directly.
Practical examples:
- Automating the retrieval of specific interface statistics by specifying custom query parameters.
- Executing unique configuration commands that are not exposed via standard operations.
- Filtering output data to return only relevant properties for further processing in workflows.
Properties
| Name | Meaning |
|---|---|
| Host | The hostname or IP address of the Mikrotik device to connect to. |
| Ignore SSL Issues | Whether to accept responses even if SSL certificate validation fails (useful for self-signed certs). |
| Operation Name | The name of the operation to perform; for this node, it is fixed as "custom". |
| Properties | Optional key-value pairs representing parameters for the custom command sent to the Mikrotik API. |
| Query | Field names with values used to filter the output returned from the Mikrotik device. |
| Proplist | List of specific properties to return from the response, limiting the output to these fields only. |
Output
The node outputs JSON data representing the response from the Mikrotik API based on the custom command executed. The structure of the JSON depends on the command and filters applied but generally includes:
- Data objects corresponding to Mikrotik entities queried or modified.
- Filtered results according to the
QueryandProplistinput properties.
If binary data were involved (not indicated here), it would represent files or raw data retrieved from the device, but this node focuses on JSON responses.
Dependencies
- Requires an API key credential to authenticate with the Mikrotik device.
- Needs network access to the specified Mikrotik host.
- Supports ignoring SSL certificate issues if enabled.
- Uses internal helper classes for HTTP requests, state management, operation resolution, and execution.
Troubleshooting
- Connection failures: Ensure the
Hostis reachable and the API credentials are correct. - SSL errors: If connecting over HTTPS with self-signed certificates, enable "Ignore SSL Issues".
- Invalid parameters: Verify that keys and values in
Properties,Query, andProplistare correctly formatted and supported by the Mikrotik API. - Empty or unexpected output: Check filtering options (
QueryandProplist) to ensure they match available data fields. - Authentication errors: Confirm that the provided API key credential has sufficient permissions.