{"id":20563411,"url":"https://github.com/pilotak/homeassistant-mikrotik-api","last_synced_at":"2025-07-27T04:03:33.380Z","repository":{"id":91903357,"uuid":"413321463","full_name":"pilotak/homeassistant-mikrotik-api","owner":"pilotak","description":"Enables you to execute scripts and perform API requests in MikroTik router","archived":false,"fork":false,"pushed_at":"2021-11-28T20:05:37.000Z","size":33,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-14T14:57:27.820Z","etag":null,"topics":["hacs","homeassistant","mikrotik","mikrotik-api","script"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pilotak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-10-04T07:41:10.000Z","updated_at":"2024-10-31T18:44:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"a05640a5-d31b-49d3-aee9-2b90e25c17f2","html_url":"https://github.com/pilotak/homeassistant-mikrotik-api","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/pilotak/homeassistant-mikrotik-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotak%2Fhomeassistant-mikrotik-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotak%2Fhomeassistant-mikrotik-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotak%2Fhomeassistant-mikrotik-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotak%2Fhomeassistant-mikrotik-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pilotak","download_url":"https://codeload.github.com/pilotak/homeassistant-mikrotik-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pilotak%2Fhomeassistant-mikrotik-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267298294,"owners_count":24065879,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-27T02:00:11.917Z","response_time":82,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacs","homeassistant","mikrotik","mikrotik-api","script"],"created_at":"2024-11-16T04:18:35.632Z","updated_at":"2025-07-27T04:03:33.373Z","avatar_url":"https://github.com/pilotak.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HomeAssistant component: `MikroTik API`\n[![Validate](https://github.com/pilotak/homeassistant-mikrotik-api/workflows/Validate/badge.svg)](https://github.com/pilotak/homeassistant-mikrotik-api/actions)\n\nThe `mikrotik_api` platform enables you to execute scripts and perform API requests in MikroTik router\n\nTo enable MikroTik API platform in your installation, add the following to your `configuration.yaml` file:\n\n```yaml\n# Example configuration.yaml entry\nmikrotik_api:\n  host: !secret router_host\n  username: !secret router_user\n  password: !secret router_pass\n```\n\nConfiguration variables:\n\n- **host** (*Required*): URL of router\n- **port** (*Optional*): default is `8728`\n- **username** (*Required*)\n- **password** (*Optional*)\n\n## Install via [HACS](https://github.com/custom-components/hacs)\nYou can find this integration in a store.\n\n## Install manually\nYou 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:\n```\n└── ...\n└── configuration.yaml\n└── secrects.yaml\n└── custom_components\n    └── mikrotik_api\n        └── __init__.py\n        └── manifest.json\n        └── services.yaml\n```\n\n\u003e__Note__: if the `custom_components` directory does not exist, you need to create it.\n\n## Usage\nYou will have a 5 new services to call either from Development Tools or from scripts.\n\n\u003e `params` and `find_params` is 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 be `True/False` ie.: `enabled=True` or `enabled=true`\n\n### Service: `mikrotik_api.call` examples\nIn 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.\n```yaml\ncommand: /ip firewall address-list disable\nfind: /ip firewall address-list\nfind_params: list=\"internet\" comment=\"test\"\n```\n\n```yaml\ncommand: /ping\nparams: address=\"1.1.1.1\" count=3\n```\n```yaml\ncommand: tools ping\nparams: mac=\"00:00:00:00:00\"\n```\n\n```yaml\ncommand: /caps-man radio provision\nparams: .id=0\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpilotak%2Fhomeassistant-mikrotik-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpilotak%2Fhomeassistant-mikrotik-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpilotak%2Fhomeassistant-mikrotik-api/lists"}