Infrastructure Orchestration.
A high-performance RESTful cloud bridge designed for authoritative management of MikroTik hardware behind any NAT environment.
Production Endpoint
https://api.mikrofy.net/api/v1/routersHandshake Guide
Establish connectivity to your hardware node in four steps.
Node Identity
Locate your Router ID (e.g. router008) in the Dashboard Fleet Manager.
Access Credential
Generate a 'mf_live_' API key scoped to your specific hardware node.
Cloud Handshake
Verify connectivity by fetching the system identity of your router.
Payload Execution
Process native RouterOS JSON data delivered directly from the edge.
API Request Structure
Requests are constructed using five primary segments. Mikrofy acts as a transparent proxy, forwarding your payload directly to the hardware's internal REST service.
METHOD
The HTTP verb (GET, PATCH, PUT, DELETE, POST).
ROUTER_ID
The unique platform identifier (e.g. router008).
ENDPOINT
The RouterOS module path (e.g. ip/address).
API_KEY
Your scoped 'mf_live_' Bearer token.
DATA
JSON payload required for mutating operations.
Universal Pattern
REST Semantics
Mikrofy translates standard HTTP verbs into native RouterOS management actions.
Querying & Filtering
Optimize data transfer by limiting the response payload to necessary fields using property lists and conditional queries.
Property Filtering
Use .proplist to request only specific keys. This significantly improves performance on low-resource hardware.
Conditional Stacks
Define complex filter logic using the .query array in a POST body.
Resource Mapping
Everything after the routerId in the path is forwarded directly to the RouterOS REST service. Standard modules like /interface, /ip/address, and /system/resource are supported out of the box.
Universal Commands
Access any RouterOS menu path without manual endpoint mapping. Zero abstraction management.
GET /routers/router008/interfaceGET /routers/router008/ip/dhcp-server/leaseIdentifier Usage
Target individual records using their volatile RouterOS ID (e.g. *1) or persistent property values.
PATCH /routers/r1/ip/address/*3Practical Examples
Copyable implementation patterns for common infrastructure orchestration tasks.
1. Hardware Health Pulse
Read-only request to fetch CPU load, free RAM, and uptime.
2. Search IP Addresses
List all configured addresses with server-side filtering.
3. Bounded Ping Test
Action command to verify upstream reachability. Always bound your count.
4. Establish Static Lease
Create a new resource. Requires a JSON payload with mandatory fields.
5. Config Export (RSC)
Generate a configuration backup. Note: Resource intensive on large fleets.
Live Connection Tester
Verify your integration credentials in real-time. This tester executes a live system/identity request to your hardware via the cloud bridge.
Response JSON Formats
RouterOS REST API responses adhere to specific data typing conventions that your application must handle.
Type Casting
Most values are returned as **strings**, even for numeric or boolean properties. Always parse response fields on your application side.
"disabled": "false"
Collections vs Objects
GET requests to base modules return a **JSON Array**, while requests targeting a specific ID return a **JSON Object**.
Error Reference
Authoritative HTTP status codes returned by the Mikrofy gateway.
400 Bad Request
Invalid syntax or malformed JSON payload in the request body.
401 Unauthorized
API key is missing, malformed, or invalid for the platform.
403 Forbidden
Developer key does not have permission for the requested Router ID.
404 Not Found
Target hardware node or RouterOS path does not exist.
502 Bad Gateway
Communication tunnel to the hardware node timed out.
503 Unavailable
Infrastructure gateway is under heavy load or maintenance.