Multitech MultiConnect rCell MTR-H5 Developer's Manual
  1. Manuals
  2. Brands
  3. Multitech Manuals
  4. Network Router
  5. MultiConnect rCell MTR-H5
  6. Developer's manual

Multitech MultiConnect rCell MTR-H5 Developer's Manual

Multiconnect rcell api cellular router
Hide thumbs Also See for MultiConnect rCell MTR-H5:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
MultiConnect
R
rCell API
Developer Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the MultiConnect rCell MTR-H5 and is the answer not in the manual?

Questions and answers

Related Manuals for Multitech MultiConnect rCell MTR-H5

Summary of Contents for Multitech MultiConnect rCell MTR-H5

  • Page 1 MultiConnect rCell API Developer Guide...
  • Page 2 Visit http://www.multitech.com/kb.go. Installation Resources To download manuals, firmware, and software, visit http://www.multitech.com/setup/product.go. Support Portal To create an account and submit a support case directly to our technical support team, visit: https://support.multitech.com. Technical Support Business Hours: M-F, 9am to 5pm CST Country...

  • Page 3: Table Of Contents

    CONTENTS Contents 1 Introduction 2 Requests 2.1 Making Requests ......... . . 2.2 Logging In .
  • Page 4 CONTENTS 5 Statistics dns ..........gps .

  • Page 5: Introduction

    REQUESTS Introduction The MultiConnect rCell is a cellular router that uses a RESTful JSON API for managing configurations, polling statistics, and issuing commands. This document provides information on the design, patterns, and methods within the rCell API. The Appendix of this document has additional information for those unfamiliar with the REST architecture or JSON data format.

  • Page 6: Logging In

    REQUESTS " mac " "00 DC " " maxLeases " " options " " dhcp - authoritative " " rangeEnd " "192.168.2.2 54" " rangeStart " "192 .168.2 .100" " subnetAddress " "192.168.2.0" " subnetMask " "255 .255.2 55.0" " status " "...

  • Page 7: Logging Out

    REQUESTS " code " " result " " address " "192.16 8.2.1 03" " permission " " admin " " port " "59486" " timestamp " "2 389" " token " " B 7 0 8 3 A 0 B 1 4 C 0 F 0 B E F F B E D 8 9 B 9 9 E F B C " "...

  • Page 8: Passing Json Data

    REQUESTS Passing JSON Data Data can be sent to the rCell by passing a JSON object as the request content or by passing a JSON object in the URI parameter: data. As an example, the following request uses a RESTful PUT call to edit the current DHCP configurations by passing in a JSON object with the enabled member set to false Example: To disable DHCP, send the following request: https://192.168.2.1/apidhcp?data={"enabled":false}&method=PUT...

  • Page 9: Uri Parameters

    REQUESTS Example: Retrieving a more human-readable description of the DHCP member enabled. GET https://192.168.2.1/api/help/Setup/DHCP/Settings/Enabled Status HTTP /1.1 200 OK " code " " result " " S e t u p _ D H C P _ S e t t i n g s _ E n a b l e d " "...

  • Page 10: Responses

    RESPONSES Responses All API requests return a JSON object. The JSON response will always contain the members code and status. The status member indicates a high-level result of the request and has two possible values: success and fail. The code member is a HTTP response code describing the outcome of the API result. Certain actions or events in the API may result in a URL redirect, such as trying to access API methods when a user is not logged in.

  • Page 11: Error Codes

    RESPONSES 3.2.2 Error Codes Code Error Bad Request Unauthorized Forbidden Not Found Method Not Allowed Not Acceptable Request Timeout Conflict Internal Server Error Not Implemented Multi-Tech Systems, Inc. MultiConnect rCell API Developer Guide...

  • Page 12: Commands And Collections

    COMMANDS AND COLLECTIONS Commands and Collections Commands The API supports a set of special actions through the Command URL ( api/command ). To execute a command, the call method must be a POST request. A RESTful GET request will return an array of all of the commands. Command Description Parameters...

  • Page 13: Collections

    COMMANDS AND COLLECTIONS Collections Collections are groups of related elements used to configure a service or capability. There are four main actions that can be performed on a collection: get, edit, add, and delete. These actions align with RESTful calls: GET, PUT, POST, and DELETE.

  • Page 14: Autoreboot

    COMMANDS AND COLLECTIONS 4.3.2 autoReboot Description: cause the device to automatically reboot : OBJECT Element Type Description hour UINT based on the mode as either Hour of Day or Hours from Boot mode STRING DISABLED, TIME, or TIMER (default: DISABLED) 4.3.3 bluetooth Description: allow a device to connect via Bluetooth : OBJECT...

  • Page 15: Ddns

    COMMANDS AND COLLECTIONS Element Type Description address1 STRING address of company for support contact address2 STRING address of company for support contact city STRING city of company for support contact companyName STRING company name for support contact country STRING country of company for support contact STRING fax number of company for support contact icon...

  • Page 16: Dhcp

    COMMANDS AND COLLECTIONS Element Type Description friendlyName STRING friendly name to associate with device STRING mac address of device name STRING name of device 4.3.7 dhcp Description: DHCP settings : OBJECT Element Type Description defaultGateway STRING default gateway of network (default:’192.168.2.1’) domain STRING network domain name...

  • Page 17: Gccp

    COMMANDS AND COLLECTIONS Element Type Description action STRING action of filter: ACCEPT, REJECT, LOG or DROP description STRING filter description direction STRING direction of traffic: INGRESS or EGRESS dstIp STRING ip address of destination or ’ANY’ dstMask UINT network mask of destination (0-32) dstPortEnd STRING end of destination port range or ’ANY’...

  • Page 18: Gretunnels

    COMMANDS AND COLLECTIONS Element Type Description client OBJECT settings for gps client enabled BOOL enable or disable gps client (default:false) password STRING password to use when connecting to remote server port UINT port to connect on remote server (default:5445) protocol STRING protocol to when making connection, UDP or TCP (default:TCP) remoteHost...

  • Page 19: Ipsectunnels

    COMMANDS AND COLLECTIONS Element Type Description activation STRING signal to start connection description STRING summary of the pipe enabled BOOL enable or disable this pipe STRING ip address of the remote end of the pipe mode STRING determines whether local end point is a client or server or both name STRING label of the pipe...

  • Page 20: Lan

    COMMANDS AND COLLECTIONS Element Type Description authMethod STRING how the two security gateways should authenticate each other compression BOOL whether IPComp compression of content is proposed on the connection description STRING a note about the tunnel enabled BOOL enable or disable this tunnel encryptMethod STRING IKE encryption/authentication algorithm to be used for phase 1 and phase 2 of...

  • Page 21: Networks

    COMMANDS AND COLLECTIONS Element Type Description description STRING description of rule direction STRING direction of rule, INGRESS or EGRESS enabled BOOL enable or disable rule (default:true) guid STRING rule guid lanIp STRING LAN ip address of rule lanPortEnd STRING LAN end port range of rule lanPortStart STRING LAN beginning port range of rule...
  • Page 22 COMMANDS AND COLLECTIONS Element Type Description authentication OBJECT PPP authentication settings password STRING password of ppp account type STRING type of authentication to use when connecting to ppp, PAP, CHAP or PAP-CHAP (default:’PAP-CHAP’) username STRING username of ppp account connectTimeout UINT time in seconds to wait for a connection while in receive mode (default:90) dialOnDemand...

  • Page 23: Remoteaccess

    COMMANDS AND COLLECTIONS 4.3.19 remoteAccess Description: settings to configure remote access of device : OBJECT Element Type Description bruteForcePrevention OBJECT settings to configure login attempt throttling enabled BOOL enable device to throttle username and password combination attempts (de- fault:false) failAttempts UINT set the number of consecutive failures before locking out an account (default:3) lockoutSeconds...

  • Page 24: Routes

    (default:43200) queryServerInterval UINT set the check-in interval in seconds (default:43200) serverName STRING remote management platform’s url or IP address (default:ds.multitech.com) serverPort UINT remote management platform’s IP port (default:5798) sslEnabled BOOL enable traffic encryption (default:true)

  • Page 25: Syslog

    COMMANDS AND COLLECTIONS 4.3.24 syslog Description: settings for syslog support : OBJECT Element Type Description enabled BOOL enable or disable syslog daemon (default:false) ipAddress STRING ip address of syslog server logLevel UINT level of debug output to log, 20(warning), 30(info), 50(debug), 60(trace) or 100(maximum) (default:30) outputToFile BOOL...

  • Page 26: Users

    COMMANDS AND COLLECTIONS Element Type Description capabilities OBJECT hardware capabilites BOOL true if device supports analog inputs, otherwise false bluetooth BOOL true if device supports bluetooth, otherwise false BOOL true if device supports digital inputs, otherwise false dout BOOL true if device supports digital outputs, otherwise false externalSerialPort BOOL true if device supports external serial port, otherwise false...

  • Page 27: Wifi

    COMMANDS AND COLLECTIONS Element Type Description name STRING name of user password STRING password hash permission STRING permission level : ADMIN, USER, GUEST 4.3.27 wifi Description: settings for wi-fi services : OBJECT Element Type Description OBJECT wi-fi access point settings beaconInterval UINT time in msec between beacon frames (default:100)

  • Page 28: Statistics

    STATISTICS Statistics The API supports collecting dynamic system data through its Statistics URL. This data is read-only. Every call actively collects the latest data associated with the selected stats element. For a list of pollable options, use a GET request on https://[rcell ip]/api/stats. Statistic Group Description Current DNS servers...

  • Page 29: Dns

    STATISTICS Description: current dns server ip addresses : ARRAY Element Type Description dhcpLease ARRAY array of dns servers issued to dhcp clients with lease servers ARRAY array of dns servers available for domain name resolution Description: statistics and positional information of gps device : OBJECT Element Type Description...

  • Page 30: Ipsec

    STATISTICS ipsec Description: statistics on ipsec interfaces : OBJECT Element Type Description ipsec0 OBJECT statistics on ipsec lan interface STRING the ip address assigned to this interface STRING maximum transmission unit in bytes OBJECT statistics on ipsec lan interface received bytes bytes STRING number of received bytes...

  • Page 31: Modbus

    STATISTICS Element Type Description STRING the ip address assigned to this interface STRING maximum transmission unit in bytes OBJECT statistics on local area network received bytes bytes STRING number of received bytes dropped STRING number of received byte drops errors STRING number of received byte errors frame...

  • Page 32: Serial

    STATISTICS Element Type Description areaCode STRING identification code of area dnsServers ARRAY an array of strings representing ip addresses of DNS servers STRING the ip address assigned to this interface link STRING status of the link localIp STRING the ip address assigned to this interface STRING maximum transmission unit in bytes number...

  • Page 33: Wlan

    STATISTICS Element Type Description ddns OBJECT status on ddns services enabled BOOL indicates whether or not service is employed status STRING status of ddns dialOnDemand OBJECT status on dial-on-demand services enabled BOOL indicates whether or not service is employed status STRING status of dial-on-demand keepAlive...

  • Page 34: Appendix

    APPENDIX Appendix REST Architecture A REST (Representational State Transfer) architecture is a style for interacting with distributed systems and is commonly used in websites. There are four methods to REST: POST, GET, PUT, and DELETE. These actions expose the four basic functions of persistent storage: Create, Read, Update, and Delete (CRUD). The responses to these RESTful actions can be returned in various formats.

  • Page 35: Using Curl To Enable Ppp

    APPENDIX expire date 2014 -05 -01 16 06 GMT issuer C = US ; ST = Minnesota ; L = Minneapolis ; CN = rcell . example . com SSL certificate verify result self signed certificate (18) continuing anyway . >...

  • Page 36: Using Curl To Add A Firewall Dnat Rule

    APPENDIX 6.3.3 Using Curl to add a firewall DNAT rule curl -- sslv3 -k -X POST -H " Content - Type application / json " -d ’ " description " "" " direction " " INGRESS " " enabled " true "...

  • Page 37: Using Curl To Delete A Firewall Filter Rule By Name

    APPENDIX 6.3.5 Using Curl to delete a firewall filter rule by name curl -- sslv3 -k -X DELETE " https //192.1 68.2.1/ api / filters / FTP - SERVER ? token =2442 C B 0 C B 6 0 B 2 E E 9 F 5 A 3 5 D F 5 E D 8 C 3 3 Curl result: "...

This manual is also suitable for:

Multiconnect rcell mtr-h6Multiconnect rcell mtr-g3Multiconnect rcell mtr-ev3Multiconnect rcell mtr-c2Multiconnect rcell mtr-h6Multiconnect rcell mtr-g3 ... Show all

Table of Contents