routerosv7_restfull_api

package module
v0.0.0-...-e670964 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 13, 2023 License: MIT Imports: 12 Imported by: 0

README

RouterOS v7 Rest API Client

Description

This library is a wrapper for the RouterOS v7 Rest API. It provides a simple way to access RouterOS devices using Go.

HTTP Methods

HTTP RouterOS Description
GET print Get data record
PUT add Create a new record
PATCH set Update a record
DELETE remove Delete a record
POST Universal method to get access to all console commands

for more info see: https://help.mikrotik.com/docs/display/ROS/REST+API#RESTAPI-Overview

Overview

Package routerosv7_restfull_api functions:

  • Auth - function to authenticate the Mikrotik device
  • Print - function to get data record
  • Add - function to create a new record
  • Set - function to update a record
  • Remove - function to delete a record
  • Run - function to run console commands

Usage

Auth

This is example implementation to authenticate the Mikrotik device

package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
    // Authenticate to the router
    _, err := routerosv7_restfull_api.Auth(context.Background(),
        routerosv7_restfull_api.AuthConfig{
            Host:     "192.168.88.1", // Change this to your router's IP address
            Username: "username",      // Change this to your router's username
            Password: "password",     // Change this to your router's password
        })
    // Check if authentication failed
    if err != nil {
        fmt.Println(err)
    } else {
        fmt.Println("Authentication success")
    }
}

Print

This is example implementation to get data record

package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Print(
		context.Background(),
		"192.168.88.1",                     // Change this to your router's IP address
		"username",                         // Change this to your router's username
		"password",                         // Change this to your router's password
		"ip/address",                       // Change this to the path you want to add
	)
	
	if err != nil {
		fmt.Println("Failed to print:", err)
		return
	}
	
	fmt.Println(data)
	return
}

Add

This is example implementation to create a new record

package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	payload := fmt.Sprintf(`{"address": "%s","interface": "%s"}`, "192.168.99.1/24", "ether1")
	data, err := routerosv7_restfull_api.Add(
		context.Background(),
		"192.168.88.1",                     // Change this to your router's IP address
		"username",                         // Change this to your router's username
		"password",                         // Change this to your router's password
		"ip/address",                       // Change this to the path you want to add
		[]byte(payload))                    // Payload to add

	if err != nil {
		fmt.Println("Failed to add address:", err)
		return
	}

	fmt.Println(data)
	return
}

Set

This is example implementation to update a record

package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Set(
		context.Background(),
		"192.168.88.1",                    // Change this to your router's IP address
		"username",                        // Change this to your router's username
		"password",                        // Change this to your router's password
		"ip/address/*7A",                  // *7A is the ID of the address
		[]byte(`{"comment": "Test API"}`), // Change this to the payload you want to set
	)
	
	if err != nil {
		fmt.Println("Failed to patch data:", err)
		return
	}
	
	fmt.Println(data)
	return
}

Remove

This is example implementation to delete a record

package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	if data, _ := routerosv7_restfull_api.Remove(
		context.Background(),
		"192.168.88.1",   // Change this to your router's IP address
		"username",       // Change this to your router's username
		"password",       // Change this to your router's password
		"ip/address/*7A", // *7A is the ID of the address
	); data != nil {
		fmt.Println("Failed to delete data:", data)
		return
	} else {
		fmt.Println("Data successfully deleted")
	}
}

Run

This is example implementation to run console commands

Print
package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Run(
		context.Background(), // Create a context
		"192.168.88.1",       // Change this to your router's IP address
		"username",           // Change this to your router's username
		"password",           // Change this to your router's password
		"ip/address/print",   // Change this to the command you want to execute
		nil,                  
	)
	
	if err != nil {
		fmt.Println("Failed to retrieve data:", err)
		return
	}
	
	fmt.Println(data)
}
Add
package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Run(
		context.Background(), // Create a context
		"192.168.88.1",       // Change this to your router's IP address
		"username",            // Change this to your router's username
		"password",           // Change this to your router's password
		"ip/address/add",     // Change this to the command you want to execute
		[]byte(`{
        "address": "192.168.100.1/24",
        "interface": "ether1"}`), // Change this to the payload you want to send
	)
	
	if err != nil {
		fmt.Println("Failed to add address:", err)
		return
	}
	
	fmt.Println(data)
}
Proplist
package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Run(
		context.Background(), // Create a context
		"192.168.88.1",       // Change this to your router's IP address
		"username",            // Change this to your router's username
		"password",           // Change this to your router's password
		"ip/address/print",   // Change this to the command you want to execute
		[]byte(`{"_proplist": ["address","interface"]}`), // Change this to the desired payload data
	)
	
	if err != nil {
		fmt.Println("Failed to execute command:", err)
		return
	}
	
	fmt.Println(data)
}
Query
package main

import (
	"context"
	"fmt"
	"github.com/megadata-dev/routerosv7-restfull-api"
)

func main() {
	data, err := routerosv7_restfull_api.Run(
		context.Background(), // Create a context
		"192.168.88.1",       // Change this to your router's IP address
		"username",           // Change this to your router's username
		"password",           // Change this to your router's password
		"ip/address/print",   // Change this to the command you want to execute
		[]byte(`{
			"_proplist": ["address","interface"],
			".query": ["network=192.168.100.0","#"]
		}`)) // Change this to the payload you want to send
	
	if err != nil {
		fmt.Println("Failed to execute command:", err)
		return
	}
	
	fmt.Println(data)
}

SSL Certificates on RouterOS v7

To use secure HTTPS, set up certificates on RouterOS v7. More information can be found here.

/certificate
add name=ca-template days-valid=3650 common-name=your.server.url key-usage=key-cert-sign,crl-sign
add name=server-template days-valid=3650 common-name=your.server.url

/certificate
sign ca-template name=root-ca
:delay 3s
sign ca=root-ca server-template name=server
:delay 3s

/certificate
set root-ca trusted=yes
set server trusted=yes

/ip service
set www-ssl certificate=server disabled=no

Documentation

Index

Constants

View Source 
const (
	MethodGet    = "GET"    // MethodGet is the HTTP method for GET requests
	MethodPost   = "POST"   // MethodPost is the HTTP method for POST requests
	MethodPut    = "PUT"    // MethodPut is the HTTP method for PUT requests
	MethodPatch  = "PATCH"  // MethodPatch is the HTTP method for PATCH requests
	MethodDelete = "DELETE" // MethodDelete is the HTTP method for DELETE requests

)

Variables

This section is empty.

Functions

func Add 

func Add(ctx context.Context, host, username, password, command string, payload []byte) (interface{}, error)

Add creates a new PUT request and executes it, returning the result and error.

func Auth 

func Auth(ctx context.Context, config AuthConfig) (interface{}, error)

Auth function now uses createAndExecuteRequest with MethodGet

func Print 

func Print(ctx context.Context, host, username, password, command string) (interface{}, error)

Print creates a new GET request and executes it, returning the result and error.

func Remove 

func Remove(ctx context.Context, host, username, password, command string) (interface{}, error)

Remove creates a new DELETE request and executes it, returning the result and error.

func Run 

func Run(ctx context.Context, host, username, password, command string, payload []byte) (interface{}, error)

Run creates a new POST request and executes it, returning the result and error.

func Set 

func Set(ctx context.Context, host, username, password, command string, payload []byte) (interface{}, error)

Set creates a new PATCH request and executes it, returning the result and error.

Types

type APIRequest 

type APIRequest struct {
	Host     string // Host for the request to Mikrotik Router
	Username string // Username for the request to Mikrotik Router
	Password string // Password for the request to Mikrotik Router
	Command  string // Command for the request to Mikrotik Router
	Payload  []byte // Payload for the request to Mikrotik Router
	Method   string // Method for the request to Mikrotik Router
}

APIRequest represents a request to the API.

func (*APIRequest) URL 

func (r *APIRequest) URL() string

URL constructs the request URL based on the method and path.

type AuthConfig 

type AuthConfig struct {
	Host     string // Host for the request to Mikrotik Router
	Username string // Username for the request to Mikrotik Router
	Password string // Password for the request to Mikrotik Router
}

AuthConfig is the configuration for the AuthDevice function

Source Files

View all Source files

Directories

Path Synopsis
example
add
auth
command/add
command/print
command/proplist
command/query
print/filter-param
print/nofilter
remove
set

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.