HomeAssistant component: MikroTik API
The mikrotik_api platform enables you to execute scripts and perform API requests in MikroTik router
To enable MikroTik API platform in your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
mikrotik_api:
host: !secret router_host
username: !secret router_user
password: !secret router_pass
Configuration variables:
- host (Required): URL of router
- port (Optional): default is
8728 - username (Required)
- password (Optional)
Install via HACS
You can find this integration in a store.
Install manually
You need to copy mikrotik_api folder from this repo to the custom_components folder in the root of your configuration, file tree should look like this:
└── ...
└── configuration.yaml
└── secrects.yaml
└── custom_components
└── mikrotik_api
└── __init__.py
└── manifest.json
└── services.yaml
Note: if the
custom_componentsdirectory does not exist, you need to create it.
Usage
You will have a 5 new services to call either from Development Tools or from scripts.
paramsandfind_paramsis key=value scheme. All strings have to be wrapped with a single of double quotes, numbers not. Special case is boolean - no quotes but the string would beTrue/Falseie.:enabled=Trueorenabled=true
Service: mikrotik_api.call examples
In case you need to disable exact item, you can search for it. Then the command will be call only if find command returns ids, you can also specify find_params to the search.
command: /ip firewall address-list disable
find: /ip firewall address-list
find_params: list="internet" comment="test"
command: /ping
params: address="1.1.1.1" count=3
command: tools ping
params: mac="00:00:00:00:00"
command: /caps-man radio provision
params: .id=0
1 May 20, 2022
21 Jan 2, 2023
24 Dec 11, 2022
2 Nov 23, 2021
138 Dec 15, 2022
5 Aug 7, 2022
6 Nov 28, 2022
3 Sep 12, 2021
1 Jan 15, 2022
5 Mar 16, 2022
259 Dec 28, 2022
25 Dec 13, 2022
4 Aug 08, 2021
5 Jun 26, 2022
2 Dec 12, 2021
1 Dec 05, 2021
3 Apr 28, 2022
11 Dec 21, 2022
22 Nov 12, 2022
4 Mar 27, 2022
17 Dec 01, 2022
1 Jan 03, 2022
1 Jan 04, 2022
0 Feb 12, 2022
2 Mar 01, 2022
205 Jan 02, 2023
59 Jan 08, 2023
4 Oct 12, 2022