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. It supports various operations on different resources exposed by the Mikrotik API. The "set" operation under the "Default" resource enables updating properties of a specified entity identified by an ID or named parameter.

Common scenarios include automating network device configuration changes, updating settings dynamically based on workflow data, or managing Mikrotik router parameters without manual intervention.

For example, you could use this node to update interface configurations or modify routing parameters by specifying the target entity and the properties to change.

Properties

Name Meaning
Host The hostname or IP address of the Mikrotik device to connect to.
Ignore SSL Issues Whether to ignore SSL certificate validation errors when connecting (true/false).
Id Identifier or named parameter of the entity to update. Examples: *1, ether1.
Properties A collection of key-value pairs representing the properties to be updated on the entity.

The Properties field allows multiple entries, each consisting of:

  • Param Name: The name of the property to update.
  • Param Value: The new value for that property.

Output

The node outputs JSON data representing the result of the set operation. This typically includes confirmation of the updated properties or any response returned by the Mikrotik API after applying the changes.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the Mikrotik API.
  • Needs network access to the specified Mikrotik host.
  • Optionally handles SSL certificate validation based on the "Ignore SSL Issues" setting.

Troubleshooting

  • Connection failures: Ensure the Host is reachable and the API credentials are correct.
  • SSL errors: If connecting over HTTPS and encountering SSL issues, enable "Ignore SSL Issues" to bypass certificate validation (not recommended for production).
  • Invalid ID or properties: Verify that the provided Id corresponds to a valid entity and that property names and values conform to Mikrotik API expectations.
  • API errors: Check the Mikrotik device logs or API documentation for error details if the node returns failure responses.

Links and References

Discussion