Mikrotik icon

Mikrotik

Consume Mikrotik API (v.0.1.4)

Overview

This node integrates with the Mikrotik API, allowing users to interact programmatically with Mikrotik devices. The "print" operation under the "Default" resource is designed to retrieve and output data from a Mikrotik device based on specified filters and property selections.

Common scenarios include:

  • Fetching specific configuration or status information from a Mikrotik router.
  • Filtering output to only include relevant fields for monitoring or automation workflows.
  • Ignoring SSL certificate issues when connecting to devices with self-signed or invalid certificates.

Practical example:
A network administrator wants to pull a filtered list of active interfaces from a Mikrotik router, specifying only certain properties like interface name and status, while ignoring SSL warnings due to a self-signed certificate.

Properties

Name Meaning
Host The hostname or IP address of the Mikrotik device to connect to.
Ignore SSL Issues Whether to accept and download responses even if the SSL certificate validation fails (true/false).
Query A collection of field names with values used to filter the output data returned by the print operation.
Proplist A collection of specific property names to return in the output, limiting the response to those fields.
  • Query and Proplist are fixed collections allowing multiple entries, each entry specifying a value string for filtering or property selection respectively.

Output

The node outputs JSON data representing the response from the Mikrotik device after applying any specified query filters and property selections. The structure depends on the Mikrotik API response but will be filtered according to the input parameters.

If binary data were involved, it would typically represent files or raw data streams from the device; however, this operation focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the Mikrotik API.
  • Needs network access to the specified Mikrotik host.
  • Optionally requires configuration to allow ignoring SSL certificate errors if connecting to devices with invalid or self-signed certificates.

Troubleshooting

  • Connection failures: Ensure the host is reachable and the API credentials are correct.
  • SSL errors: If connection fails due to SSL issues, enable "Ignore SSL Issues" to bypass certificate validation.
  • Empty or unexpected output: Verify that the Query and Proplist parameters are correctly set and match existing fields on the Mikrotik device.
  • Authentication errors: Confirm that the provided API key or authentication token has sufficient permissions.

Links and References

Discussion