Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Plug matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• powerplugs: required(object)
  • plug: (integer)

    Plug number being described.

    Example:

    1

  • plugname: (string - maxLength: 24)

    Plug name being described.

    Example:

    Outlet_A1

  • state: (one of on, off, boot, default)

    Current state of the plug described.

    Example:

    off

  • busy: (one of 0, 1)

    If the plug is currently changing states. 0=no, 1=yes

    Example:

    0

  • bootdelay: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9)

    On a reboot command, this is the delay time when a plug will turn on power, after it has been turned off. 0='0.5 Secs', 1='1 Sec', 2='2 Sec', 3='5 Sec', 4='15 Sec', 5='30 Sec', 6='1 Min', 7='2 Mins', 8='3 Mins', 9='5 Mins'

    Example:

    2

  • priority: (one of 1, 2, 3, 4, 5, 6, 7, 8)

    Prioritizes which plug gets its state changed first. The lower the number the higher the priority.

    Example:

    1

  • plugoffreason: (one of 0, 1, 2, 3, 4, 5)

    The reason the plug was last turned off or rebooted. 0 - Power Up, 1 - User Action, 2 - PNA, 3 - External Alarm, 4 - Circuit Switch, 5 - Contact Switch

    Example:

    0

  • current: (integer)

    If this plug supports individual current reporting. will display current AMPs use by the port.

    Example:

    0

• plugdatacount: required(integer)

  Number of plugs returned with the query. Valid value can from 1 to the maximum number of plugs of the WTI unit.

  Example:

  1

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• powerplugs: required(object)
  • plug: (integer)

    Plug number being described.

    Example:

    1

  • plugname: (string - maxLength: 24)

    Plug name being described.

    Example:

    Outlet_A1

  • state: (one of on, off, boot, default)

    Current state of the plug described.

    Example:

    off

  • busy: (one of 0, 1)

    If the plug is currently changing states. 0=no, 1=yes

    Example:

    0

  • bootdelay: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9)

    On a reboot command, this is the delay time when a plug will turn on power, after it has been turned off. 0='0.5 Secs', 1='1 Sec', 2='2 Sec', 3='5 Sec', 4='15 Sec', 5='30 Sec', 6='1 Min', 7='2 Mins', 8='3 Mins', 9='5 Mins'

    Example:

    2

  • priority: (one of 1, 2, 3, 4, 5, 6, 7, 8)

    Prioritizes which plug gets its state changed first. The lower the number the higher the priority.

    Example:

    1

  • plugoffreason: (one of 0, 1, 2, 3, 4, 5)

    The reason the plug was last turned off or rebooted. 0 - Power Up, 1 - User Action, 2 - PNA, 3 - External Alarm, 4 - Circuit Switch, 5 - Contact Switch

    Example:

    0

  • current: (integer)

    If this plug supports individual current reporting. will display current AMPs use by the port.

    Example:

    0

• plugdatacount: required(integer)

  Number of plugs returned with the query. Valid value can from 1 to the maximum number of plugs of the WTI unit.

  Example:

  1

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "powerplugs": {
    "plug": 1,
    "plugname": "Outlet_A1",
    "state": "off",
    "busy": 1,
    "bootdelay": 2,
    "priority": 1,
    "plugoffreason": 0,
    "current": 0
  },
  "plugdatacount": 1
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Plug matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• powerplugs: required(object)
  • plug: (integer)

    Plug number being described.

    Example:

    1

  • plugname: (string - maxLength: 24)

    Name of the Plug being described.

    Example:

    Outlet_A1

  • state: (one of on, off, boot, default)

    Current state of the plug described.

    Example:

    off

  • busy: (one of 0, 1)

    If the plug is currently changing states. 0=no, 1=yes

    Example:

    0

  • bootdelay: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9)

    On a reboot command, this is the delay time when a plug will turn on power, after it has been turned off. 0='0.5 Secs', 1='1 Sec', 2='2 Sec', 3='5 Sec', 4='15 Sec', 5='30 Sec', 6='1 Min', 7='2 Mins', 8='3 Mins', 9='5 Mins'

    Example:

    3

  • priority: (one of 1, 2, 3, 4, 5, 6, 7, 8)

    Prioritizes which plug gets its state changed first. The lower the number the higher the priority.

    Example:

    1

  • default: (one of 0, 1)

    What the Plugs default state is when the device starts. 0 - Off, 1 - On

    Example:

    0

  • plugoffreason: (one of 0, 1, 2, 3, 4, 5)

    The reason the plug was last turned off or rebooted. 0 - Power Up, 1 - User Action, 2 - PNA, 3 - External Alarm, 4 - Circuit Switch, 5 - Contact Switch

    Example:

    0

  • current: (integer)

    If this plug supports individual current reporting. will display current AMPs use by the port.

    Example:

    0

• plugdatacount: required(integer)

  Number of plugs returned with the query. Valid value can from 1 to the maximum number of plugs of the WTI unit.

  Example:

  1

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• powerplugs: required(object)
  • plug: (integer)

    Plug number being described.

    Example:

    1

  • plugname: (string - maxLength: 24)

    Name of the Plug being described.

    Example:

    Outlet_A1

  • state: (one of on, off, boot, default)

    Current state of the plug described.

    Example:

    off

  • busy: (one of 0, 1)

    If the plug is currently changing states. 0=no, 1=yes

    Example:

    0

  • bootdelay: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9)

    On a reboot command, this is the delay time when a plug will turn on power, after it has been turned off. 0='0.5 Secs', 1='1 Sec', 2='2 Sec', 3='5 Sec', 4='15 Sec', 5='30 Sec', 6='1 Min', 7='2 Mins', 8='3 Mins', 9='5 Mins'

    Example:

    3

  • priority: (one of 1, 2, 3, 4, 5, 6, 7, 8)

    Prioritizes which plug gets its state changed first. The lower the number the higher the priority.

    Example:

    1

  • default: (one of 0, 1)

    What the Plugs default state is when the device starts. 0 - Off, 1 - On

    Example:

    0

  • plugoffreason: (one of 0, 1, 2, 3, 4, 5)

    The reason the plug was last turned off or rebooted. 0 - Power Up, 1 - User Action, 2 - PNA, 3 - External Alarm, 4 - Circuit Switch, 5 - Contact Switch

    Example:

    0

  • current: (integer)

    If this plug supports individual current reporting. will display current AMPs use by the port.

    Example:

    0

• plugdatacount: required(integer)

  Number of plugs returned with the query. Valid value can from 1 to the maximum number of plugs of the WTI unit.

  Example:

  1

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "powerplugs": {
    "plug": 1,
    "plugname": "Outlet_A1",
    "state": "off",
    "busy": 1,
    "bootdelay": 1,
    "default": 0,
    "priority": 1,
    "plugoffreason": 0,
    "current": 0
  },
  "plugdatacount": 1
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Plug matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• timestamp: required(datetime)

  ISO Timestamp of the unit time when Current parameters were read.

  Example:

  2019-07-18T17:45:02+00:00

• powerunit: required(integer)

  If this unit is capable of reporting power and current. 0=Power Unit, 1=Power Unit

  Example:

  1

• outletmetering: (integer)

  If this unit can report Current and Power per a port basis.

  Example:

  1

• ats: (integer)

  ATS capable means if one of the plugs is removed, the other plug distributres power to the other plugs in the removed plugs branch.

  Example:

  1

• branchcount: (integer)

  Total Branches the unit has.

  Example:

  1

• plugcount: (integer)

  Total Plugs that are accessible.

  Example:

  8

• powerfactor: (integer)

  Power Factor, this can be any whole number from 1 through 100.

  Example:

  100

• powereff: (integer)

  Power Efficiency, this can be any whole number from 1 through 100

  Example:

  100

• powerdatacount: (integer)

  Number of Current datapoints that are to follow.

  Example:

  45

• powerdata: required(object)
  • timestamp: required(datetime)

    ISO Timestamp of the WTI unit time when the Current values were recorded.

    Example:

    2019-07-18T17:45:02+00:00

  • temperature: required(integer)

    Temperature of the WTI Unit when the timestamp was recorded.

    Example:

    85

  • format: required(one of C, F)

    Denotes if the temperature is displayed in Farenheit or Celsius.

    Example:

    F

  • branch1: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage2: (number)

      Voltage Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage3: (number)

      Voltage Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage4: (number)

      Voltage Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "voltage2": 112,
      "current1": 6,
      "current2": 6
    }

  • branch2: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage2: (number)

      Voltage Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage3: (number)

      Voltage Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage4: (number)

      Voltage Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "voltage2": 112,
      "current1": 6,
      "current2": 6
    }

  • branch3: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage2: (number)

      Voltage Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage3: (number)

      Voltage Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage4: (number)

      Voltage Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "voltage2": 112,
      "current1": 6,
      "current2": 6
    }

  • branch4: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage2: (number)

      Voltage Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage3: (number)

      Voltage Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • voltage4: (number)

      Voltage Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "voltage2": 112,
      "current1": 6,
      "current2": 6
    }

  Example:

  {
    "timestamp": "2019-07-18T17:45:02+00:00",
    "temperature": 85,
    "format": "F",
    "branch1": {
      "voltage1": 112,
      "voltage2": 117,
      "current1": 0,
      "current2": 0
    },
    "branch2": {
      "voltage1": 0,
      "voltage2": 0,
      "current1": 0,
      "current2": 0
    },
    "branch3": {
      "voltage1": 0,
      "voltage2": 0,
      "current1": 0,
      "current2": 0
    },
    "branch4": {
      "voltage1": 0,
      "voltage2": 0,
      "current1": 0,
      "current2": 0
    }
  }

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Plug matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• timestamp: required(datetime)

  ISO Timestamp of the unit time when Current parameters were read.

  Example:

  2019-07-18T17:45:02+00:00

• powerunit: required(integer)

  If this unit is capable of reporting power and current. 0=Power Unit, 1=Power Unit

  Example:

  1

• outletmetering: (integer)

  If this unit can report Current and Power per a port basis.

  Example:

  1

• ats: (integer)

  ATS capable means if one of the plugs is removed, the other plug distributres power to the other plugs in the removed plugs branch.

  Example:

  1

• branchcount: (integer)

  Total Branches the unit has.

  Example:

  1

• plugcount: (integer)

  Total Plugs that are accessible.

  Example:

  8

• powerfactor: (integer)

  Power Factor, this can be any whole number from 1 through 100.

  Example:

  100

• powereff: (integer)

  Power Efficiency, this can be any whole number from 1 through 100

  Example:

  100

• powerdatacount: (integer)

  Number of Current datapoints that are to follow.

  Example:

  45

• powerdata: required(object)
  • timestamp: required(datetime)

    ISO Timestamp of the WTI unit time when the Power values were recorded.

    Example:

    2019-07-18T17:45:02+00:00

  • branch1: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "current1": 6,
      "current2": 0,
      "current3": 0,
      "current4": 0
    }

  • branch2: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "current1": 6,
      "current2": 0,
      "current3": 0,
      "current4": 0
    }

  • branch3: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "current1": 6,
      "current2": 0,
      "current3": 0,
      "current4": 0
    }

  • branch4: required(object)
    • voltage1: (number)

      Voltage Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      112

    • current1: required(number)

      Current Position 1 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current2: required(number)

      Current Position 2 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current3: (number)

      Current Position 3 of the WTI Unit when the timestamp was recorded

      Example:

      6

    • current4: (number)

      Current Position 4 of the WTI Unit when the timestamp was recorded

      Example:

      6

    Example:

    {
      "voltage1": 112,
      "current1": 6,
      "current2": 0,
      "current3": 0,
      "current4": 0
    }

  Example:

  {
    "timestamp": "2019-07-18T17:45:02+00:00",
    "branch1": {
      "voltage1": 112,
      "current1": 117,
      "current2": 0,
      "current3": 0,
      "current4": 0
    },
    "branch2": {
      "voltage1": 0,
      "current1": 0,
      "current2": 0,
      "current3": 0,
      "current4": 0
    },
    "branch3": {
      "voltage1": 0,
      "current1": 0,
      "current2": 0,
      "current3": 0,
      "current4": 0
    },
    "branch4": {
      "voltage1": 0,
      "current1": 0,
      "current2": 0,
      "current3": 0,
      "current4": 0
    }
  }

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

User matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• users: required(object)
  • username: required(string - minLength: 5 - maxLength: 32)

    Name of the user that is being modified.

    Example:

    super

  • newpasswd: (string - minLength: 5 - maxLength: 32)

    Name of the user password that is being modified.

    Example:

    super

  • accesslevel: (one of 0, 1, 2, 3)

    User's permission level. 0=View Only, 1=User, 2=SuperUser, 3=Administrator.

    Example:

    0

  • portaccess: (string - maxLength: 42)

    Allow or Deny port access. 0=Deny Access, 1=allow access. Starting from Port 1 to the maximum number of ports of the WTI unit.

    Example:

    11111111

  • plugaccess: (string - maxLength: 20)

    Allow or Deny plug access. 0=Deny Access, 1=allow access. Starting from Port 1 to the maximum number of plugs of the WTI unit.

    Example:

    11111111

  • groupaccess: (string - maxLength: 54)

    Allow or Deny group access. 0=Deny Access, 1=allow access. Starting from group 1 to group 54.

    Example:

    11111111

  • accessserial: (one of 0, 1)

    Allow or Deny Login via the serial ports for this user.

    Example:

    0

  • accessssh: (one of 0, 1)

    Allow or Deny Login via SSH and Telnet for this user.

    Example:

    0

  • accessweb: (one of 0, 1)

    Allow or Deny Login via the Web interface for this user.

    Example:

    0

  • accessoutbound: (one of 0, 1)

    Allow or Deny outbound SSH and Telnet capabilities for this user.

    Example:

    0

  • accessmonitor: (one of 0, 1)

    Allow or Deny this user to be able to moniter Power on a WTI Power device.

    Example:

    0

  • callbackphone: (string - maxLength: 32)

    For modem Mode, this number will be dialed to confirm access after a user has dialed into the modem for security.

    Example:

    9495869950

  • tokenkey: (string - minLength: 5 - maxLength: 64)

    If allowing API access via a token, this will be the token created.

    Example:

    thisisarandomtoken

  • tokenminutes: (integer)

    If allowing API access via a token, this is the time length the token is valid. (1 - 1048320)

    Example:

    43200

  • tokendate: (integer)

    If allowing API access via a token, this is the expiration time in seconds from Epoch.

    Example:

    1697144087

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "users": {
    "username": "super",
    "accesslevel": 3,
    "portaccess": "11111111111111111111111111111",
    "plugaccess": "11111111111111111111",
    "groupaccess": "111111111111111111111111111111111111111111111111111111",
    "accessserial": 1,
    "accessssh": 1,
    "accessweb": 1,
    "accessoutbound": 1,
    "accessmonitor": 1,
    "callbackphone": "9495869950",
    "tokenkey": "randomstringofcharacters",
    "tokenminutes": 43200,
    "tokendate": 1697144087
  }
}

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

HTTP status code 409

an existing item does not exist

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• users: required(object)
  • username: required(string - minLength: 5 - maxLength: 32)

    Name of the user that is being modified.

    Example:

    super

  • changes: required(integer)

    "ORd bits describing what has been modified." "UserName: 1, Password: 2, Access Level: 4, Port Access Array: 8, Plug Access Array: 16, " "Plug Group Access: 32, Call back: 64, Serial Access: 128, SSH Access: 256, Web Access: 512," "SNMP Access: 1024, Outbound Access: 2048, Monitor Access: 4096, API Access 8192" "API Token: 16384, API Minutes: 32768, API Rekey: 65536", Got Username: "131072"

    Example:

    8196

  • errorcode: required(integer)

    Status code of this particular user action.

    Example:

    0

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "users": {
    "username": "super",
    "changes": 3,
    "errorcode": 0
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• users: required(object)
  • username: required(string - minLength: 5 - maxLength: 32)

    Name of the user that is being modified.

    Example:

    super

  • changes: required(integer)

    "ORd bits describing what has been modified." "UserName: 1, Password: 2, Access Level: 4, Port Access Array: 8, Plug Access Array: 16, " "Plug Group Access: 32, Call back: 64, Serial Access: 128, SSH Access: 256, Web Access: 512," "SNMP Access: 1024, Outbound Access: 2048, Monitor Access: 4096, API Access 8192" "API Token: 16384, API Minutes: 32768, API Rekey: 65536", Got Username: "131072"

    Example:

    8196

  • errorcode: required(integer)

    Status code of this particular user action.

    Example:

    0

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "users": {
    "username": "super",
    "changes": 3,
    "errorcode": 0
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

HTTP status code 409

an existing item does not exist

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

User matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• users: required(object)
  • username: required(string - minLength: 5 - maxLength: 32)

    Name of the user that is being deleted.

    Example:

    super

  • errorcode: required(integer)

    Status code if this user was deleted.

    Example:

    0

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "users": {
    "username": "super",
    "errorcode": 0
  }
}

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

HTTP status code 409

an existing item does not exist

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Port matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• serialports: required(object)
  • port: required(integer)

    Number of the port that is being displayed.

    Example:

    1

  • portname: (string - minLength: 0 - maxLength: 24)

    Name of the Port that is displayed.

    Example:

    Port1

  • baud: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)

    Port's Baud Rate. 0=300, 1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400, 7=57600, 8=115200, 9=230400, 10=460800.

    Example:

    0

  • parity: (one of 0, 1, 2, 3, 4, 5)

    Port's Data Bits/Parity Setting. 0=7-None, 1=7-Even, 2=7-Odd, 3=8-None, 4=8-Even, 5=8-Odd.

    Example:

    3

  • stopbits: (one of 1, 2)

    Port's Stop Bit Setting. 1=1 Stop Bit, 2=2 Stop Bit.

    Example:

    1

  • handshake: (one of 0, 1, 2, 3)

    Port's Handshaking Method. 0=None, 1=XON/XOFF, 2=RTS/CTS, 3=Both.

    Example:

    3

  • mode: (one of 0, 1, 2, 3, 4)

    Port Mode. 0=Any-to-Any. 1=Passive, 2=Buffer, 3=Modem, 4=ModemPPP.

    Example:

    0

  • cmd: (one of 0, 1)

    Port's Admin Mode. 0=Deny, 1=Permit.

    Example:

    0

  • seq: (one of 1, 2, 3)

    Port's Sequence Disconnect. 1=Three Characters (before and after), 2=One Character Only, 3=Off

    Example:

    1

  • logoff: (string - maxLength: 2)

    Port's Logoff character. If preceded by a ^ character, the sequence will be a control character. Used if seq is set to 0 or 1

    Example:

    ^X

  • tout: (one of 0, 1, 2, 3, 4, 5)

    Port's Inactivity Timeout. 0=Off, 1=5 Min, 2=15 Min, 3=30 Min, 4=90 Min, 5=1 Min.

    Example:

    1

  • echo: (one of 0, 1)

    Port's Command Echo. 0=Off, 1=On

    Example:

    0

  • break: (one of 0, 1)

    If the Port passes a break sequence through. 0=No, 1=Yes

    Example:

    1

  • connstatus: (string - maxLength: 16)

    Port's current connection status. If Free or connected.

    Example:

    Free

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• serialports: required(object)
  • port: required(integer)

    Number of the port that is being displayed.

    Example:

    1

  • portname: (string - minLength: 0 - maxLength: 24)

    Name of the Port that is displayed.

    Example:

    Port1

  • baud: (one of 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)

    Port's Baud Rate. 0=300, 1=1200, 2=2400, 3=4800, 4=9600, 5=19200, 6=38400, 7=57600, 8=115200, 9=230400, 10=460800.

    Example:

    0

  • parity: (one of 0, 1, 2, 3, 4, 5)

    Port's Data Bits/Parity Setting. 0=7-None, 1=7-Even, 2=7-Odd, 3=8-None, 4=8-Even, 5=8-Odd.

    Example:

    3

  • stopbits: (one of 1, 2)

    Port's Stop Bit Setting. 1=1 Stop Bit, 2=2 Stop Bit.

    Example:

    1

  • handshake: (one of 0, 1, 2, 3)

    Port's Handshaking Method. 0=None, 1=XON/XOFF, 2=RTS/CTS, 3=Both.

    Example:

    3

  • mode: (one of 0, 1, 2, 3, 4)

    Port Mode. 0=Any-to-Any. 1=Passive, 2=Buffer, 3=Modem, 4=ModemPPP.

    Example:

    0

  • cmd: (one of 0, 1)

    Port's Admin Mode. 0=Deny, 1=Permit.

    Example:

    0

  • seq: (one of 1, 2, 3)

    Port's Sequence Disconnect. 1=Three Characters (before and after), 2=One Character Only, 3=Off

    Example:

    1

  • logoff: (string - maxLength: 2)

    Port's Logoff character. If preceded by a ^ character, the sequence will be a control character. Used if seq is set to 0 or 1

    Example:

    ^X

  • tout: (one of 0, 1, 2, 3, 4, 5)

    Port's Inactivity Timeout. 0=Off, 1=5 Min, 2=15 Min, 3=30 Min, 4=90 Min, 5=1 Min.

    Example:

    1

  • echo: (one of 0, 1)

    Port's Command Echo. 0=Off, 1=On

    Example:

    0

  • break: (one of 0, 1)

    If the Port passes a break sequence through. 0=No, 1=Yes

    Example:

    1

  • connstatus: (string - maxLength: 16)

    Port's current connection status. If Free or connected.

    Example:

    Free

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "serialports": {
    "port": 4,
    "portname": "RouterLabel",
    "baud": 7,
    "handshake": 1,
    "stopbits": 1,
    "parity": 0,
    "mode": 0,
    "cmd": 0,
    "seq": 1,
    "tout": 1,
    "echo": 0,
    "break": 0,
    "logoff": "^H",
    "connstatus": "Free"
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Port matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• serialports: required(object)
  • port: required(integer)

    Number of the port that is being displayed.

    Example:

    1

  • connstatus: (string - maxLength: 16)

    Port's current connection status. If Free or connected (C-xx).

    Example:

    Free

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• serialports: required(object)
  • port: required(integer)

    Number of the initial port being connected or disconnected.

    Example:

    4

  • action: required(one of 1, 2)

    Action to taken on the ports. 1=Connect, 2=Disconnect.

    Example:

    1

  • portremote: (integer)

    Number of the remote port being connected. Only needed on an action of Connect.

    Example:

    5

  • connstatus: required(string - maxLength: 16)

    For a connection this will be either be the current connection status of the port or 'failed'. For disconnect, will return the current connection status of the port.

    Example:

    ok

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "serialports": {
    "port": 4,
    "action": 1,
    "portremote": 5,
    "connstatus": "ok"
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

AAA server matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• aaaserver: required(object)
  • service: required(one of radius, tacacs)

    Type of AAA Service

    Example:

    radius

  • enable: required(one of 0, 1)

    AAA Service state

    Example:

    0

  • ietf-ipv4: required(object)
    • primary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

    • secondary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

  • ietf-ipv6: required(object)
    • primary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

    • secondary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

  • fallbacktime: required(integer)

    AAA Service fallback timeout

    Example:

    10

  • fallbacklocal: required(one of 0, 1)

    AAA Service fallback to local password if error

    Example:

    0

  • authport: required(integer)

    AAA Service Authorization port

    Example:

    1812

  • acctport: required(integer)

    AAA Service Accounting port (RADIUS only)

    Example:

    1813

  • retries: required(integer)

    AAA Service server transmission retry

    Example:

    0

  • onetimeenable: required(one of 0, 1)

    AAA Service 2FA compatible login (RADIUS only)

    Example:

    0

  • onetimetimer: required(integer)

    AAA Service 2FA login timer (RADIUS only)

    Example:

    10

  • onetimetype: required(one of 0, 1)

    Onetime login storage type 0 - DBM, 1 - Cookies (RADIUS only)

    Example:

    0

  • sessionenable: required(one of 0, 1)

    AAA Service Session requested (RADIUS only)

    Example:

    1

  • req_mess_auth: (one of 0, 1)

    AAA Require Message Authorization (RADIUS only). 0 - Off 1- On

    Example:

    0

  • debug: required(one of 0, 1)

    AAA Service debug messages (RADIUS only)

    Example:

    0

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "aaaserver": {
    "service": "radius",
    "enable": 0,
    "ietf-ipv4": {
      "primary": [
        {
          "ip": "192.168.0.140",
          "secret": "secretpassword"
        }
      ],
      "secondary": [
        {
          "ip": "",
          "secret": ""
        }
      ]
    },
    "ietf-ipv6": {
      "primary": [
        {
          "ip": "",
          "secret": ""
        }
      ],
      "secondary": [
        {
          "ip": "",
          "secret": ""
        }
      ]
    },
    "fallbacktime": 10,
    "fallbacklocal": 1,
    "authport": 1812,
    "acctport": 1813,
    "retries": 33,
    "onetimeenable": 0,
    "onetimetimer": 10,
    "onetimetype": 0,
    "sessionenable": 1,
    "req_mess_auth": 1,
    "debug": 0
  }
}

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

HTTP status code 409

an existing item does not exist

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• aaaserver: required(object)
  • service: required(one of radius, tacacs)

    Type of AAA Service

    Example:

    radius

  • enable: required(one of 0, 1)

    AAA Service state

    Example:

    0

  • ietf-ipv4: required(object)
    • primary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

    • secondary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

  • ietf-ipv6: required(object)
    • primary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

    • secondary: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • secret: required(string - maxLength: 64)

        .

        Example:

        secretpassword

  • fallbacktime: required(integer)

    AAA Service fallback timeout

    Example:

    10

  • fallbacklocal: required(one of 0, 1)

    AAA Service fallback to local password if error

    Example:

    0

  • authport: required(integer)

    AAA Service Authorization port

    Example:

    1812

  • acctport: required(integer)

    AAA Service Accounting port (RADIUS only)

    Example:

    1813

  • retries: required(integer)

    AAA Service server transmission retry

    Example:

    0

  • onetimeenable: required(one of 0, 1)

    AAA Service 2FA compatible login (RADIUS only)

    Example:

    0

  • onetimetimer: required(integer)

    AAA Service 2FA login timer (RADIUS only)

    Example:

    10

  • onetimetype: required(one of 0, 1)

    Onetime login storage type 0 - DBM, 1 - Cookies (RADIUS only)

    Example:

    0

  • sessionenable: required(one of 0, 1)

    AAA Service Session requested (RADIUS only)

    Example:

    1

  • req_mess_auth: (one of 0, 1)

    AAA Require Message Authorization (RADIUS only). 0 - Off 1- On

    Example:

    0

  • debug: required(one of 0, 1)

    AAA Service debug messages (RADIUS only)

    Example:

    0

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "aaaserver": {
    "service": "radius",
    "enable": 0,
    "ietf-ipv4": {
      "primary": [
        {
          "ip": "192.168.0.140",
          "secret": "secretpassword"
        }
      ],
      "secondary": [
        {
          "ip": "",
          "secret": ""
        }
      ]
    },
    "ietf-ipv6": {
      "primary": [
        {
          "ip": "",
          "secret": ""
        }
      ],
      "secondary": [
        {
          "ip": "",
          "secret": ""
        }
      ]
    },
    "fallbacktime": 10,
    "fallbacklocal": 1,
    "authport": 1812,
    "acctport": 1813,
    "retries": 33,
    "onetimeenable": 0,
    "onetimetimer": 10,
    "onetimetype": 0,
    "sessionenable": 1,
    "req_mess_auth": 1,
    "debug": 0
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Network interface matching criteria

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• interface: required(object)
  • name: required(one of eth0, eth1, ppp0)

    Name of network interface

    Example:

    eth0

  • type: required(one of 0, 1, 2, 3)

    0 - Fixed Ethernet, 1 - PPP, 2- PPP/Cellular, 3- USB.

    Example:

    0

  • ietf-ipv4: required(object)
    • address: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • netmask: required(string - maxLength: 64)

        .

        Example:

        255.255.255.0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.1

    • dhcpclient: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP client for the named network interface.

        Example:

        0

      • hostname: required(string - maxLength: 64)

        .

        Example:

        secretpassword

      • lease: required(integer)

        .

        Example:

        -1

      • obdns: required(integer)

        .

        Example:

        0

      • updns: required(integer)

        This option will set 'send fqdn.server-update' to either yes or no in the dhclient configuration file.

        Example:

        0

    • dhcpserver: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP server for the named network interface.

        Example:

        0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.2

      • primarydns: required(string - maxLength: 64)

        .

        Example:

        8.8.8.8

      • seconddns: required(string - maxLength: 64)

        .

        Example:

        4.4.4.4

      • dname: required(string - maxLength: 64)

        .

        Example:

        smith.urlname.com

      • deflease: required(integer)

        Default Lease time associated with the DHCP request.

        Example:

        600

      • maxlease: required(integer)

        Maximum lease time associated with the DHCP request.

        Example:

        7000

      • poolstart: required(integer)

        Starting Pool range forthe IP addresses given to DHCP requests.

        Example:

        2

      • poolend: required(integer)

        Ending Pool range forthe IP addresses given to DHCP requests.

        Example:

        254

  • ietf-ipv6: required(object)
    • address: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • netmask: required(string - maxLength: 64)

        .

        Example:

        255.255.255.0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.1

    • dhcpclient: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP client for the named network interface.

        Example:

        0

      • hostname: required(string - maxLength: 64)

        .

        Example:

        secretpassword

      • lease: required(integer)

        .

        Example:

        -1

      • obdns: required(integer)

        .

        Example:

        0

      • updns: required(integer)

        This option will set 'send fqdn.server-update' to either yes or no in the dhclient configuration file.

        Example:

        0

    • dhcpserver: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP server for the named network interface.

        Example:

        0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.2

      • primarydns: required(string - maxLength: 64)

        .

        Example:

        8.8.8.8

      • seconddns: required(string - maxLength: 64)

        .

        Example:

        4.4.4.4

      • dname: required(string - maxLength: 64)

        .

        Example:

        smith.urlname.com

      • deflease: required(integer)

        Default Lease time associated with the DHCP request.

        Example:

        600

      • maxlease: required(integer)

        Maximum lease time associated with the DHCP request.

        Example:

        7000

      • poolstart: required(integer)

        Starting Pool range forthe IP addresses given to DHCP requests.

        Example:

        2

      • poolend: required(integer)

        Ending Pool range forthe IP addresses given to DHCP requests.

        Example:

        254

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "interface": {
    "name": "eth0",
    "type": 0,
    "ietf-ipv4": {
      "address": [
        {
          "ip": "192.168.0.169",
          "netmask": "255.255.255.0",
          "gateway": "192.168.0.1"
        }
      ],
      "dhcpclient": [
        {
          "enable": 0,
          "hostname": "",
          "lease": -1,
          "obdns": 255,
          "updns": 255
        }
      ]
    },
    "ietf-ipv6": {
      "address": [
        {
          "ip": "",
          "netmask": "",
          "gateway": ""
        }
      ]
    }
  }
}

HTTP status code 400

bad input parameter

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

HTTP status code 409

an existing item does not exist

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• interface: required(object)
  • name: required(one of eth0, eth1, ppp0)

    Name of network interface

    Example:

    eth0

  • type: required(one of 0, 1, 2, 3)

    0 - Fixed Ethernet, 1 - PPP, 2- PPP/Cellular, 3- USB.

    Example:

    0

  • ietf-ipv4: required(object)
    • address: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • netmask: required(string - maxLength: 64)

        .

        Example:

        255.255.255.0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.1

    • dhcpclient: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP client for the named network interface.

        Example:

        0

      • hostname: required(string - maxLength: 64)

        .

        Example:

        secretpassword

      • lease: required(integer)

        .

        Example:

        -1

      • obdns: required(integer)

        .

        Example:

        0

      • updns: required(integer)

        This option will set 'send fqdn.server-update' to either yes or no in the dhclient configuration file.

        Example:

        0

    • dhcpserver: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP server for the named network interface.

        Example:

        0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.2

      • primarydns: required(string - maxLength: 64)

        .

        Example:

        8.8.8.8

      • seconddns: required(string - maxLength: 64)

        .

        Example:

        4.4.4.4

      • dname: required(string - maxLength: 64)

        .

        Example:

        smith.urlname.com

      • deflease: required(integer)

        Default Lease time associated with the DHCP request.

        Example:

        600

      • maxlease: required(integer)

        Maximum lease time associated with the DHCP request.

        Example:

        7000

      • poolstart: required(integer)

        Starting Pool range forthe IP addresses given to DHCP requests.

        Example:

        2

      • poolend: required(integer)

        Ending Pool range forthe IP addresses given to DHCP requests.

        Example:

        254

  • ietf-ipv6: required(object)
    • address: required(array of object)

      Items: items

      • ip: required(string - maxLength: 64)

        .

        Example:

        192.168.0.12

      • netmask: required(string - maxLength: 64)

        .

        Example:

        255.255.255.0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.1

    • dhcpclient: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP client for the named network interface.

        Example:

        0

      • hostname: required(string - maxLength: 64)

        .

        Example:

        secretpassword

      • lease: required(integer)

        .

        Example:

        -1

      • obdns: required(integer)

        .

        Example:

        0

      • updns: required(integer)

        This option will set 'send fqdn.server-update' to either yes or no in the dhclient configuration file.

        Example:

        0

    • dhcpserver: (array of object)

      Items: items

      • enable: required(one of 0, 1)

        Enable the DHCP server for the named network interface.

        Example:

        0

      • gateway: required(string - maxLength: 64)

        .

        Example:

        192.168.0.2

      • primarydns: required(string - maxLength: 64)

        .

        Example:

        8.8.8.8

      • seconddns: required(string - maxLength: 64)

        .

        Example:

        4.4.4.4

      • dname: required(string - maxLength: 64)

        .

        Example:

        smith.urlname.com

      • deflease: required(integer)

        Default Lease time associated with the DHCP request.

        Example:

        600

      • maxlease: required(integer)

        Maximum lease time associated with the DHCP request.

        Example:

        7000

      • poolstart: required(integer)

        Starting Pool range forthe IP addresses given to DHCP requests.

        Example:

        2

      • poolend: required(integer)

        Ending Pool range forthe IP addresses given to DHCP requests.

        Example:

        254

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "interface": {
    "name": "eth0",
    "type": 0,
    "ietf-ipv4": {
      "address": [
        {
          "ip": "192.168.0.169",
          "netmask": "255.255.255.0",
          "gateway": "192.168.0.1"
        }
      ],
      "dhcpclient": [
        {
          "enable": 0,
          "hostname": "",
          "lease": -1,
          "obdns": 255,
          "updns": 255
        }
      ]
    },
    "ietf-ipv6": {
      "address": [
        {
          "ip": "",
          "netmask": "",
          "gateway": ""
        }
      ]
    }
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• unitid: required(object)
  • timestamp: required(datetime)

    ISO Timestamp of the unit time when temperature was read.

    Example:

    2019-07-18T17:45:02+00:00

  • siteid: required(string - maxLength: 64)

    This be displayed in the external reporting logs

    Example:

    DSMLABIRVINE

  • location: required(string - maxLength: 32)

    This be displayed in the external reporting logs

    Example:

    RACK12IRVINE

  • assettag: required(string - maxLength: 32)

    This be displayed in the external reporting logs

    Example:

    1028561

  • hostname: required(string - maxLength: 64)

    This be displayed in the external reporting logs

    Example:

    testhost

  • domain: required(string - maxLength: 64)

    This be displayed in the external reporting logs

    Example:

    test.com

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "unitid": {
    "timestamp": "2019-08-02T07:53:28+00:00",
    "siteid": "DSMLABIRVINE",
    "location": "RACK12IRVINE",
    "assettag": "1028561",
    "hostname": "testhost",
    "domain": "test.com"
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

HTTP status code 200

Body

Media type: application/json

Type: object

• status: required(object)
  • code: required(integer)

    Numeric status code of the completed action.

  • text: required(string)

    Text status code of the completed action.

  Example:

  {
    "code": 0,
    "text": "OK"
  }

• ssh: required(object)
  • enable: required(one of 0, 1)

    0 - disable SSH for unit, 1 - enable SSH for unit

    Example:

    1

  • port: required(integer - minimum: 1 - maximum: 9999)

    Port that SSH will listen for a connection.

    Example:

    22

  • level: required(one of 0, 1)

    0 - Normal, 1 - High

    Example:

    1

  • viewenable: required(one of 0, 1)

    SSH View Enable

    Example:

    1

  • viewbidirect: required(one of 0, 1)

    SSH View Port BiDirection

    Example:

    1

Example:

{
  "status": {
    "code": 0,
    "text": "OK"
  },
  "ssh": {
    "enable": 1,
    "port": 22,
    "level": 1,
    "viewenable": 0,
    "viewbidirect": 0
  }
}

HTTP status code 400

invalid input, object invalid

HTTP status code 401

unauthorized error

HTTP status code 403

Forbidden error, user does not have access to APIs

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.

Secured by basicAuth

Headers

• Authorization: required(string)

  Used to send the Base64-encoded "username:password" credentials

HTTP status code 401

Unauthorized. Either the provided username and password combination is invalid, or the user is not allowed to access the content provided by the requested URL.