HTTP status code 200

Body

Media type: application/json

Type: object

• state: required(string)
• session: required(string)
• user: (string)
• last_challenge: (string)

Example:

{
  "state": "authenticated",
  "session": "71dcba707b6c177644ede1b224f69096",
  "user": "root"
}

HTTP status code 303

Redirect to new authentication session

Body

Media type: application/json

Type: any

Example:

{
  "sid": "71dcba707b6c177644ede1b224f69096",
  "message": "Redirecting to new session at {redirect-url}"
}

HTTP status code 400

Failed to initiate session creation due to error in post body.

Body

Media type: application/json

Type: any

Example:

{
  "type": "authError",
  "example": {
    "error": "Invalid request body"
  }
}

HTTP status code 401

Authentication failed due to invalid credentials or session.

Body

Media type: application/json

Type: any

Example:

{
  "error": [
    {
      "type": 7,
      "code": 41,
      "text": "Invalid login credentials",
      "args": {},
      "level": 1
    }
  ]
}

HTTP status code 200

Session exists

Body

Media type: application/json

Type: object

• state: required(string)
• session: required(string)
• user: (string)
• last_challenge: (string)

Example:

{
  "state": "authenticated",
  "session": "71dcba707b6c177644ede1b224f69096",
  "user": "root"
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

No session in data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Response applied. Next challenge in {challenge} if required.

Body

Media type: application/json

Type: object

• session: required(string)
• state: required(object)
• challenge: required(string)

  Next challenge (if any)

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 403

Authentication failed. No more attempts allowed.

HTTP status code 404

Authentication failed.

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Session deleted

Body

Media type: application/json

Type: object

• session: required(string)
• success: required(string)
• state: required(string)
• user: required(string)

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Session did not exist

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Invalid request data."
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Enrollment Deleted

Body

Media type: application/json

Type: object

• message: required(string)

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Error during processing

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Lighthouse connection removed successfully

Body

Media type: application/json

Type: any

Example:

{
  "message": "OK"
}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Parameter 'id' not provided."
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal server error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Server address updated successfully

Body

Media type: application/json

Type: any

Example:

{
  "message": "OK"
}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Parameter 'id' not provided."
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal server error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• auth: required(object)
  • auth_type: required(string)
  • use_remote_groups: required(boolean)
  • radius: required(object)
    • auth_server: required(string)
    • acct_server: (string)
    • password: required(string)
  • tacacs: required(object)
    • auth_server: required(string)
    • auth_method: required(string)
    • service: required(string)
    • password: (string)
  • ldap: required(object)
    • server: required(string)
    • bind_dn: (string)
    • base_dn: (string)
    • bind_password: (string)
    • username_attr: (string)
    • group_membership_attr: (string)
    • protocol: (string)
    • ignore_ssl_errors: (boolean)
    • ca_cert: (string)

Example:

{
  "auth": {
    "radius": {
      "password": "default",
      "auth_server": "192.168.0.1:5555",
      "acct_server": "192.168.0.2:5555"
    },
    "ldap": {
      "username_attr": "member",
      "base_dn": "basedn",
      "group_membership_attr": "grou",
      "bind_dn": "binddn",
      "bind_password": "asdf",
      "server": "1.4.5.6:2345",
      "protocol": "ldaps_only",
      "ignore_ssl_errors": false,
      "ca_cert": "-----BEGIN CERTIFICATE-----\nMIIG ... ikTH/\n-----END CERTIFICATE-----\n"
    },
    "tacacs": {
      "auth_server": "1.2.3.4",
      "auth_method": "pap",
      "service": "raccess"
    },
    "auth_type": "Local",
    "use_remote_groups": true
  }
}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• auth: required(object)
  • auth_type: required(string)
  • use_remote_groups: required(boolean)
  • radius: required(object)
    • auth_server: required(string)
    • acct_server: (string)
    • password: required(string)
  • tacacs: required(object)
    • auth_server: required(string)
    • auth_method: required(string)
    • service: required(string)
    • password: (string)
  • ldap: required(object)
    • server: required(string)
    • bind_dn: (string)
    • base_dn: (string)
    • bind_password: (string)
    • username_attr: (string)
    • group_membership_attr: (string)
    • protocol: (string)
    • ignore_ssl_errors: (boolean)
    • ca_cert: (string)

Example:

{
  "auth": {
    "radius": {
      "password": "default",
      "auth_server": "192.168.0.1:5555",
      "acct_server": "192.168.0.2:5555"
    },
    "ldap": {
      "username_attr": "member",
      "base_dn": "basedn",
      "group_membership_attr": "grou",
      "bind_dn": "binddn",
      "bind_password": "asdf",
      "server": "1.4.5.6:2345",
      "protocol": "ldaps_only",
      "ignore_ssl_errors": false,
      "ca_cert": "-----BEGIN CERTIFICATE-----\nMIIG ... ikTH/\n-----END CERTIFICATE-----\n"
    },
    "tacacs": {
      "auth_server": "1.2.3.4",
      "auth_method": "pap",
      "service": "raccess"
    },
    "auth_type": "Local",
    "use_remote_groups": true
  }
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• groups: required(array of group)

  Items: group

  • name: required(string)

    The name of the group

  • description: (string)

    The description of the group

  • roles: required(array of string)

    The list of roles provided by the group

  • ports: required(array of boolean)

    A list of flags for whether the group has access to each serial port

  • system: required(boolean)

    A flag indicating whether or not this is a system group

• meta: (object)
  • total_pages: (number)

Example:

{
  "meta": {
    "total_pages": 1
  },
  "groups": [
    {
      "name": "root",
      "description": "Default system super user group",
      "roles": [],
      "ports": [
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false
      ],
      "system": true
    },
    {
      "name": "custom_group",
      "description": "A custom group",
      "roles": [
        "admin",
        "operators"
      ],
      "ports": [
        true,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false
      ],
      "system": false
    }
  ]
}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Invalid request data."
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• groups: required(array of group)

  Items: group

  • name: required(string)

    The name of the group

  • description: (string)

    The description of the group

  • roles: required(array of string)

    The list of roles provided by the group

  • ports: required(array of boolean)

    A list of flags for whether the group has access to each serial port

  • system: required(boolean)

    A flag indicating whether or not this is a system group

• meta: (object)
  • total_pages: (number)

Example:

{
  "meta": {
    "total_pages": 1
  },
  "groups": [
    {
      "name": "root",
      "description": "Default system super user group",
      "roles": [],
      "ports": [
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false,
        false
      ],
      "system": true
    }
  ]
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• group: required(object)

  Console Server Group Configuration

  • name: required(string)

    The name of the group

  • description: (string)

    The description of the group

  • roles: required(array of string)

    The list of roles provided by the group

  • ports: required(array of boolean)

    A list of flags for whether the group has access to each serial port

  • system: required(boolean)

    A flag indicating whether or not this is a system group

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Body

Media type: application/json

Type: object

• users: required(array of object)

  Items: userConfiguration

  • id: required(string)
  • description: required(string)

    Must not contain ':'

  • username: required(string)
  • disabled: required(boolean)
  • groups: required(array of string)

    List of group names for which this user is a member

• meta: required(object)
  • total_pages: required(number)

Example:

{
  "meta": {
    "total_pages": 1
  },
  "users": [
    {
      "id": "user1",
      "username": "root",
      "description": "Root User",
      "disabled": false,
      "groups": []
    },
    {
      "id": "user2",
      "username": "coolguy",
      "description": "",
      "disabled": false,
      "groups": [
        "cool"
      ]
    },
    {
      "id": "user3",
      "username": "alice",
      "description": "",
      "disabled": false,
      "groups": [
        "pmadmin"
      ]
    }
  ]
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 201

On success the updated list of user configurations is returned

Body

Media type: application/json

Type: object

• users: required(array of userConfiguration)

  Items: userConfiguration

  • id: required(string)
  • description: required(string)

    Must not contain ':'

  • username: required(string)
  • disabled: required(boolean)
  • groups: required(array of string)

    List of group names for which this user is a member

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Body

Media type: application/json

Type: object

• message: required(string)

Example:

{
  "message": "OK"
}

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Body

Media type: application/json

Type: object

• user: required(object)

  Console server user configuration

  • id: required(string)
  • description: required(string)

    Must not contain ':'

  • username: required(string)
  • disabled: required(boolean)
  • groups: required(array of string)

    List of group names for which this user is a member

Example:

{
  "user": {
    "id": "user1",
    "username": "root",
    "description": "Root User",
    "disabled": false,
    "groups": []
  }
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• execution_id: required(string)
• info: required(string)

Example:

{
  "info": "Script execution started successfully",
  "execution_id": "ASD123"
}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Invalid script metadata"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

Example:

{
  "script_status": "in_progress"
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Invalid request

Body

Media type: application/json

Type: object

Examples:

{
  "error": "Failed to parse request data"
}

{
  "error": "Script execution ID not provided"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Unexpected error

Body

Media type: application/json

Type: object

Examples:

{
  "error": "Failed to open configuration handle"
}

{
  "error": "Script exit code not found"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• serialports: required(array of serialPort)

  Items: serialPort

  • label: required(string)

    The label for the serial port

  • id: required(string)

    The id of the serial port. This ID can be used to fetch individual ports using the /serialPorts/{portid} endpoint

  • attachedDeviceType: required(one of unknown, none, remotePowerControl, uninterruptiblePowerSupply, environmentMonitor, nmeaSource, powerAlert)

    The type of device attached to the serial port. Ports in console server mode will have this property set to 'none'

  • hardwareType: required(one of unknown, builtInUART, builtInUSB, removableUSB)

    The underlying hardware type of the port. This is used to indicate if its a fixed or removable port.

  • mode: required(one of disabled, localConsole, consoleServer, bridge, terminalServer, reserved, powerman, unknown)

    The mode that the port is in

  • hardwareSettings: required(object)

    This group of properties define the hardware level configuration of the port

    • pinout: required(one of X0, X1, X2)

      The physical pinout of the port connector

    • protocol: required(one of RS232, RS422, RS485, RS485e)

      The data protocol the port is using when transmitting and receiving

    • uart: required(object)

      UART configuration settings

      • parity: required(one of none, unknown, even, mark, space)

        The format of the parity byte

      • baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)

        The communication rate of the port

      • stopBits: required(one of 1, 1.5, 2)

        The number of stop bits between characters

      • dataBits: required(one of 5, 6, 7, 8)

        The number of data bits in a character

      • flowControl: required(one of unknown, none, noneUnpowered, hardware, software, softwareUnpowered)

        The algorithm used for flow control.

      • dtrMode: required(one of alwayson, activeuser)

        When to assert DTR

  • ctrlCode: required(object)

    Additional key sequences for pmshell control commands. Each is an integer in the range [0, 255] inclusive.

    • quit: required(number)

      Additional control code for the 'Exit pmshell' control function

    • generateBreak: required(number)

      Additional control code for the 'Generate BREAK' control function

    • chooser: required(number)

      Additional control code for the 'Connect to port menu' control function

    • power: (number)

      Additional control code for the 'Power menu' control function

    • help: required(number)

      Additional control code for the 'Show help message' control function

    • portLog: required(number)

      Additional control code for the 'View History' control function

  • modeSettings: required(union of consoleServer or terminalServer or bridge)

    This object contains mode specific configuration objects. Only the object corresponding to the 'mode' property will be present

  • nagios: required(object)

    This object contains Nagios related configuration settings for this port

    • enabled: required(boolean)

      Indicates if nagios checks are enabled for this port

    • serialStatus: required(boolean)

      Indicates if the nagios serial status check should be configured for this port

    • name: required(string)

      The Nagios name for the port (autogenerated from the hostname and the port name)

    • portLogging: required(boolean)

      Indicates if nagios port logging is enabled

  • logging: required(object)

    This object contains logging related configuration settings for this port

    • level: required(one of unknown, disabled, access, accessInputOutput, accessInput, accessOutput)

      Indicates the logging level for the port

    • priority: required(one of default, warning, notice, info, error, emergency, debug, critical, alert)

      The log priority to assign to log messages from this port when they're sent to a remote syslog server

    • facility: required(one of default, local0, local1, local2, local3, local4, local5, local6, local7, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, user, uucp)

      The log facility to assign to log messages from this port when they're sent to a remote syslog server

  • nmeaStreaming: (object)

    Only valid for predefined GPS serial ports. Will be rejected by PUT/PATCH on non-GPS ports.

    • enabled: required(boolean)

      Enable GPS NMEA data streaming

    • fixFrequency: required(number)

      The GPS fix rate, from 1-255 seconds. If changed, this field will not be applied until the device restarts, or NMEA streaming is disabled and re-enabled

Example:

{
  "serialports": [
    {
      "label": "sv.router",
      "id": "port1",
      "modeSettings": {
        "consoleServer": {
          "ssh": {
            "enabled": true,
            "unauthenticated": false
          },
          "tcp": {
            "enabled": false
          },
          "general": {
            "accumulateMS": 0,
            "replaceBackspace": false,
            "powerMenuEnabled": false,
            "escapeChar": "~",
            "singleConnection": false
          },
          "portShare": {
            "enabled": false,
            "password": "secrets",
            "authentication": false,
            "encryption": false
          },
          "rfc2217": {
            "enabled": false
          },
          "webShell": {
            "enabled": false
          },
          "telnet": {
            "enabled": true,
            "unauthenticated": false
          },
          "ipAlias": {
            "wan": [],
            "oobfo": [],
            "wlan": [],
            "lan": []
          }
        }
      },
      "attachedDeviceType": "none",
      "hardwareSettings": {
        "pinout": "X2",
        "protocol": "RS232",
        "uart": {
          "parity": "none",
          "baud": "9600",
          "stopBits": "1",
          "dataBits": "8",
          "flowControl": "none",
          "dtrMode": "alwayson"
        }
      },
      "ctrlCode": {
        "quit": 4,
        "generateBreak": 6,
        "chooser": 3,
        "help": 5,
        "portLog": 1,
        "power": 0
      },
      "logging": {
        "level": "accessInputOutput",
        "priority": "default",
        "facility": "default"
      },
      "mode": "consoleServer",
      "nagios": {
        "enabled": false,
        "serialStatus": false,
        "name": "",
        "portLogging": false
      },
      "hardwareType": "builtInUART",
      "nmeaStreaming": {
        "enabled": false,
        "fixFrequency": 5
      }
    },
    {
      "label": "sv.fileserver",
      "id": "port2",
      "modeSettings": {
        "consoleServer": {
          "ssh": {
            "enabled": true,
            "unauthenticated": false
          },
          "tcp": {
            "enabled": false
          },
          "general": {
            "accumulateMS": 0,
            "replaceBackspace": false,
            "powerMenuEnabled": false,
            "escapeChar": "~",
            "singleConnection": false
          },
          "portShare": {
            "enabled": false,
            "password": "secrets",
            "authentication": false,
            "encryption": false
          },
          "rfc2217": {
            "enabled": false
          },
          "webShell": {
            "enabled": false
          },
          "telnet": {
            "enabled": true,
            "unauthenticated": false
          },
          "ipAlias": {
            "wan": [],
            "oobfo": [],
            "wlan": [],
            "lan": []
          }
        }
      },
      "attachedDeviceType": "none",
      "hardwareSettings": {
        "pinout": "X2",
        "protocol": "RS232",
        "uart": {
          "parity": "none",
          "baud": "9600",
          "stopBits": "1",
          "dataBits": "8",
          "flowControl": "none",
          "dtrMode": "alwayson"
        }
      },
      "ctrlCode": {
        "quit": 10,
        "generateBreak": 6,
        "chooser": 0,
        "help": 5,
        "portLog": 1,
        "power": 0
      },
      "logging": {
        "level": "accessInputOutput",
        "priority": "default",
        "facility": "default"
      },
      "mode": "consoleServer",
      "nagios": {
        "enabled": false,
        "serialStatus": false,
        "name": "",
        "portLogging": false
      },
      "hardwareType": "builtInUART",
      "nmeaStreaming": {
        "enabled": false,
        "fixFrequency": 5
      }
    }
  ]
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• serialport: required(object)

  Console Server Serial Port Configuration

  • label: required(string)

    The label for the serial port

  • id: required(string)

    The id of the serial port. This ID can be used to fetch individual ports using the /serialPorts/{portid} endpoint

  • attachedDeviceType: required(one of unknown, none, remotePowerControl, uninterruptiblePowerSupply, environmentMonitor, nmeaSource, powerAlert)

    The type of device attached to the serial port. Ports in console server mode will have this property set to 'none'

  • hardwareType: required(one of unknown, builtInUART, builtInUSB, removableUSB)

    The underlying hardware type of the port. This is used to indicate if its a fixed or removable port.

  • mode: required(one of disabled, localConsole, consoleServer, bridge, terminalServer, reserved, powerman, unknown)

    The mode that the port is in

  • hardwareSettings: required(object)

    This group of properties define the hardware level configuration of the port

    • pinout: required(one of X0, X1, X2)

      The physical pinout of the port connector

    • protocol: required(one of RS232, RS422, RS485, RS485e)

      The data protocol the port is using when transmitting and receiving

    • uart: required(object)

      UART configuration settings

      • parity: required(one of none, unknown, even, mark, space)

        The format of the parity byte

      • baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)

        The communication rate of the port

      • stopBits: required(one of 1, 1.5, 2)

        The number of stop bits between characters

      • dataBits: required(one of 5, 6, 7, 8)

        The number of data bits in a character

      • flowControl: required(one of unknown, none, noneUnpowered, hardware, software, softwareUnpowered)

        The algorithm used for flow control.

      • dtrMode: required(one of alwayson, activeuser)

        When to assert DTR

  • ctrlCode: required(object)

    Additional key sequences for pmshell control commands. Each is an integer in the range [0, 255] inclusive.

    • quit: required(number)

      Additional control code for the 'Exit pmshell' control function

    • generateBreak: required(number)

      Additional control code for the 'Generate BREAK' control function

    • chooser: required(number)

      Additional control code for the 'Connect to port menu' control function

    • power: (number)

      Additional control code for the 'Power menu' control function

    • help: required(number)

      Additional control code for the 'Show help message' control function

    • portLog: required(number)

      Additional control code for the 'View History' control function

  • modeSettings: required(union of consoleServer or terminalServer or bridge)

    This object contains mode specific configuration objects. Only the object corresponding to the 'mode' property will be present

  • nagios: required(object)

    This object contains Nagios related configuration settings for this port

    • enabled: required(boolean)

      Indicates if nagios checks are enabled for this port

    • serialStatus: required(boolean)

      Indicates if the nagios serial status check should be configured for this port

    • name: required(string)

      The Nagios name for the port (autogenerated from the hostname and the port name)

    • portLogging: required(boolean)

      Indicates if nagios port logging is enabled

  • logging: required(object)

    This object contains logging related configuration settings for this port

    • level: required(one of unknown, disabled, access, accessInputOutput, accessInput, accessOutput)

      Indicates the logging level for the port

    • priority: required(one of default, warning, notice, info, error, emergency, debug, critical, alert)

      The log priority to assign to log messages from this port when they're sent to a remote syslog server

    • facility: required(one of default, local0, local1, local2, local3, local4, local5, local6, local7, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, user, uucp)

      The log facility to assign to log messages from this port when they're sent to a remote syslog server

  • nmeaStreaming: (object)

    Only valid for predefined GPS serial ports. Will be rejected by PUT/PATCH on non-GPS ports.

    • enabled: required(boolean)

      Enable GPS NMEA data streaming

    • fixFrequency: required(number)

      The GPS fix rate, from 1-255 seconds. If changed, this field will not be applied until the device restarts, or NMEA streaming is disabled and re-enabled

Example:

{
  "serialport": {
    "label": "sv.router",
    "id": "port1",
    "modeSettings": {
      "consoleServer": {
        "ssh": {
          "enabled": true,
          "unauthenticated": false
        },
        "tcp": {
          "enabled": false
        },
        "general": {
          "accumulateMS": 0,
          "replaceBackspace": false,
          "powerMenuEnabled": false,
          "escapeChar": "~",
          "singleConnection": false
        },
        "portShare": {
          "enabled": false,
          "password": "secrets",
          "authentication": false,
          "encryption": false
        },
        "rfc2217": {
          "enabled": false
        },
        "webShell": {
          "enabled": false
        },
        "telnet": {
          "enabled": true,
          "unauthenticated": false
        },
        "ipAlias": {
          "wan": [],
          "oobfo": [],
          "wlan": [],
          "lan": []
        }
      }
    },
    "attachedDeviceType": "none",
    "hardwareSettings": {
      "pinout": "X2",
      "protocol": "RS232",
      "uart": {
        "parity": "none",
        "baud": "9600",
        "stopBits": "1",
        "dataBits": "8",
        "flowControl": "none",
        "dtrMode": "alwayson"
      }
    },
    "ctrlCode": {
      "quit": 0,
      "generateBreak": 6,
      "chooser": 3,
      "power": 2,
      "help": 5,
      "portLog": 1
    },
    "logging": {
      "level": "accessInputOutput",
      "priority": "default",
      "facility": "default"
    },
    "mode": "consoleServer",
    "nagios": {
      "enabled": false,
      "serialStatus": false,
      "name": "",
      "portLogging": false
    },
    "hardwareType": "builtInUART",
    "nmeaStreaming": {
      "enabled": false,
      "fixFrequency": 5
    }
  }
}

HTTP status code 304

Serial Port configuration matches the provided Etag

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Invalid Port ID

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal server error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful update

Body

Media type: application/json

Type: object

• serialport: required(object)

  Console Server Serial Port Configuration

  • label: required(string)

    The label for the serial port

  • id: required(string)

    The id of the serial port. This ID can be used to fetch individual ports using the /serialPorts/{portid} endpoint

  • attachedDeviceType: required(one of unknown, none, remotePowerControl, uninterruptiblePowerSupply, environmentMonitor, nmeaSource, powerAlert)

    The type of device attached to the serial port. Ports in console server mode will have this property set to 'none'

  • hardwareType: required(one of unknown, builtInUART, builtInUSB, removableUSB)

    The underlying hardware type of the port. This is used to indicate if its a fixed or removable port.

  • mode: required(one of disabled, localConsole, consoleServer, bridge, terminalServer, reserved, powerman, unknown)

    The mode that the port is in

  • hardwareSettings: required(object)

    This group of properties define the hardware level configuration of the port

    • pinout: required(one of X0, X1, X2)

      The physical pinout of the port connector

    • protocol: required(one of RS232, RS422, RS485, RS485e)

      The data protocol the port is using when transmitting and receiving

    • uart: required(object)

      UART configuration settings

      • parity: required(one of none, unknown, even, mark, space)

        The format of the parity byte

      • baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)

        The communication rate of the port

      • stopBits: required(one of 1, 1.5, 2)

        The number of stop bits between characters

      • dataBits: required(one of 5, 6, 7, 8)

        The number of data bits in a character

      • flowControl: required(one of unknown, none, noneUnpowered, hardware, software, softwareUnpowered)

        The algorithm used for flow control.

      • dtrMode: required(one of alwayson, activeuser)

        When to assert DTR

  • ctrlCode: required(object)

    Additional key sequences for pmshell control commands. Each is an integer in the range [0, 255] inclusive.

    • quit: required(number)

      Additional control code for the 'Exit pmshell' control function

    • generateBreak: required(number)

      Additional control code for the 'Generate BREAK' control function

    • chooser: required(number)

      Additional control code for the 'Connect to port menu' control function

    • power: required(number)

      Additional control code for the 'Power menu' control function

    • help: required(number)

      Additional control code for the 'Show help message' control function

    • portLog: required(number)

      Additional control code for the 'View History' control function

  • modeSettings: required(union of consoleServer or terminalServer or bridge or consoleServer or terminalServer or bridge or consoleServer or terminalServer or bridge)

    This object contains mode specific configuration objects. Only the object corresponding to the 'mode' property will be present

  • nagios: required(object)

    This object contains Nagios related configuration settings for this port

    • enabled: required(boolean)

      Indicates if nagios checks are enabled for this port

    • serialStatus: required(boolean)

      Indicates if the nagios serial status check should be configured for this port

    • name: required(string)

      The Nagios name for the port (autogenerated from the hostname and the port name)

    • portLogging: required(boolean)

      Indicates if nagios port logging is enabled

  • logging: required(object)

    This object contains logging related configuration settings for this port

    • level: required(one of unknown, disabled, access, accessInputOutput, accessInput, accessOutput)

      Indicates the logging level for the port

    • priority: required(one of default, warning, notice, info, error, emergency, debug, critical, alert)

      The log priority to assign to log messages from this port when they're sent to a remote syslog server

    • facility: required(one of default, local0, local1, local2, local3, local4, local5, local6, local7, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, user, uucp)

      The log facility to assign to log messages from this port when they're sent to a remote syslog server

  • nmeaStreaming: (object)

    Only valid for predefined GPS serial ports. Will be rejected by PUT/PATCH on non-GPS ports.

    • enabled: required(boolean)

      Enable GPS NMEA data streaming

    • fixFrequency: required(number)

      The GPS fix rate, from 1-255 seconds. If changed, this field will not be applied until the device restarts, or NMEA streaming is disabled and re-enabled

HTTP status code 400

Invalid request data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Invalid Port ID

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 412

Etag doesn't match (Indicates serial port config has changed since last get request)

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal server error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful update

Body

Media type: application/json

Type: object

• serialport: required(object)

  Console Server Serial Port Configuration

  • label: required(string)

    The label for the serial port

  • id: required(string)

    The id of the serial port. This ID can be used to fetch individual ports using the /serialPorts/{portid} endpoint

  • attachedDeviceType: required(one of unknown, none, remotePowerControl, uninterruptiblePowerSupply, environmentMonitor, nmeaSource, powerAlert)

    The type of device attached to the serial port. Ports in console server mode will have this property set to 'none'

  • hardwareType: required(one of unknown, builtInUART, builtInUSB, removableUSB)

    The underlying hardware type of the port. This is used to indicate if its a fixed or removable port.

  • mode: required(one of disabled, localConsole, consoleServer, bridge, terminalServer, reserved, powerman, unknown)

    The mode that the port is in

  • hardwareSettings: required(object)

    This group of properties define the hardware level configuration of the port

    • pinout: required(one of X0, X1, X2)

      The physical pinout of the port connector

    • protocol: required(one of RS232, RS422, RS485, RS485e)

      The data protocol the port is using when transmitting and receiving

    • uart: required(object)

      UART configuration settings

      • parity: required(one of none, unknown, even, mark, space)

        The format of the parity byte

      • baud: required(one of 50, 75, 110, 134, 150, 200, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400)

        The communication rate of the port

      • stopBits: required(one of 1, 1.5, 2)

        The number of stop bits between characters

      • dataBits: required(one of 5, 6, 7, 8)

        The number of data bits in a character

      • flowControl: required(one of unknown, none, noneUnpowered, hardware, software, softwareUnpowered)

        The algorithm used for flow control.

      • dtrMode: required(one of alwayson, activeuser)

        When to assert DTR

  • ctrlCode: required(object)

    Additional key sequences for pmshell control commands. Each is an integer in the range [0, 255] inclusive.

    • quit: required(number)

      Additional control code for the 'Exit pmshell' control function

    • generateBreak: required(number)

      Additional control code for the 'Generate BREAK' control function

    • chooser: required(number)

      Additional control code for the 'Connect to port menu' control function

    • power: (number)

      Additional control code for the 'Power menu' control function

    • help: required(number)

      Additional control code for the 'Show help message' control function

    • portLog: required(number)

      Additional control code for the 'View History' control function

  • modeSettings: required(union of consoleServer or terminalServer or bridge)

    This object contains mode specific configuration objects. Only the object corresponding to the 'mode' property will be present

  • nagios: required(object)

    This object contains Nagios related configuration settings for this port

    • enabled: required(boolean)

      Indicates if nagios checks are enabled for this port

    • serialStatus: required(boolean)

      Indicates if the nagios serial status check should be configured for this port

    • name: required(string)

      The Nagios name for the port (autogenerated from the hostname and the port name)

    • portLogging: required(boolean)

      Indicates if nagios port logging is enabled

  • logging: required(object)

    This object contains logging related configuration settings for this port

    • level: required(one of unknown, disabled, access, accessInputOutput, accessInput, accessOutput)

      Indicates the logging level for the port

    • priority: required(one of default, warning, notice, info, error, emergency, debug, critical, alert)

      The log priority to assign to log messages from this port when they're sent to a remote syslog server

    • facility: required(one of default, local0, local1, local2, local3, local4, local5, local6, local7, auth, authpriv, cron, daemon, ftp, kern, lpr, mail, news, user, uucp)

      The log facility to assign to log messages from this port when they're sent to a remote syslog server

  • nmeaStreaming: (object)

    Only valid for predefined GPS serial ports. Will be rejected by PUT/PATCH on non-GPS ports.

    • enabled: required(boolean)

      Enable GPS NMEA data streaming

    • fixFrequency: required(number)

      The GPS fix rate, from 1-255 seconds. If changed, this field will not be applied until the device restarts, or NMEA streaming is disabled and re-enabled

HTTP status code 400

Invalid request data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Invalid Port ID

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 412

Etag doesn't match (Indicates serial port config has changed since last get request)

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal server error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful Request

Body

Media type: application/json

Type: object

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

    The host port that the SSH daemon is listening on

Example:

{
  "ssh": {
    "port": 22
  }
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal Error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful Request

Body

Media type: application/json

Type: object

• keys: required(object)
  • ecdsa: (string)

    The ECDSA SSH host key - base64 encoded

  • ed25519: (string)

    The ED25519 host key - base64 encoded

  • rsa: (string)

    the RSA host key - base64 encoded

Example:

{
  "keys": {
    "ecdsa": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBMhfUnZC8MD+iqxLq7vhvUCoFTzC1+lmieMXj2N6j+SUHYkKipoNkI9kks3PEXIMwShiVJ3ySW5cERFDvRsVT+c=",
    "ed25519": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC59SOqiYAs3DfLEtdW6RE/W2OY1WCEkQi/1AqUkOvs5",
    "rsa": "ssh-rsa  AAAAB3NzaC1yc2EAAAADAQABAAACAQDN+Gd1ul7tCYWiAC3CQ76MM+FfhesjKimeMSeVNUfIvK4rTGfL14LKUB37rJAU5PhO/snRw+xtQRaD5SHzDHzCh1xXzVlb+x77IqeasbeKhWNCCYfgHNx1sAxzwnAUA26UifoAZSv81HLmE9kJnCqTH0o54HKdRtUQGyo0a0F1tTweQKlrCPxQ6YoDfMbFhsYgPPX+66L6ku5xvcc4pbT5caJ1pw6cX5Fej49Bkbl+SHYiMYNFX05nIHSstpfgdWgOv3xm43DjAXLD3d5lGC5aYkqgJO0X5n6KjpoOGHaMZ9dn/t4O14ZX2Jl46SMSr8XQmSZoIijQyUP9AW8oUMTdSvUT/P1TLBlcPuw76MHJkij8TP2/r9ICyzXQSzhlCv0vGWAZsi1SZ8PQFv6iAtTu/2UXdvmBxdkuDx2IPwNtvC+e8GRcEYFY8ziUnWVlf7QjhaDkrcamdoAo7wErEKO1iV/hcgfKemLuIVvqkKS9Qj0rHS5wAnrfFx7WhjRa5BqCA/H4pBozgMBrdR/9lseYNu4vjMaGRYLaUhfZj1S2c7uKd+vEZI3nmCCQmBJ1qR2ih8USeZbIcrf2QMGhdKUIoFxjM9c3NabWmRNPSJIgL8N19+itb4Yz6ycs+wJyegdpJ5TCrSrHo8Tt5e/5PX604NuHtEDXpG+T/HjhccWNQ=="
  }
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal Error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful Request

Body

Media type: application/json

Type: object

• message: required(string)

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal Error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful Request

Body

Media type: application/json

Type: object

• message: required(string)

HTTP status code 400

Incomplete data

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 500

Internal Error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful Request

Body

Media type: application/json

Type: object

• model_number: required(string)

  The model of the Node

• serial_number: required(string)

  The serial number of the Node. In some cases, this may not be programatically retrievable. 'N/A' will be returned in that case

• hostname: required(string)

  The hostname of the node

• mac_address: required(string)

  The MAC address of the NET 1 interface

• firmware_version: required(string)

  The version of firmware that the Node is running

• interfaces: required(array of object)

  An array of the configured interfaces

  Items: items

  • name: required(string)

    The interface name

  • ipv4_addresses: required(array of string)

    All IPv4 addresses assigned to the interface

  • ipv6_addresses: required(array of string)

    All IPv6 addresses assigned to the interface

Example:

{
  "model_number": "ACM7004-2",
  "serial_number": "70000261411598",
  "hostname": "acm7004-2",
  "interfaces": [
    {
      "ipv4_addresses": [
        "192.168.125.102"
      ],
      "name": "Network",
      "ipv6_addresses": [
        "fd07:2218:1350:7d::1:8fcb",
        "fd07:2218:1350:7d:213:c6ff:fe01:d005",
        "fe80::213:c6ff:fe01:d005"
      ]
    },
    {
      "ipv4_addresses": [
        "10.250.100.5"
      ],
      "name": "Management LAN",
      "ipv6_addresses": [
        "fd07:2218:1350:7d::1:78da",
        "fd07:2218:1350:7d:213:c6ff:fe01:d006",
        "fe80::213:c6ff:fe01:d006"
      ]
    }
  ],
  "mac_address": "00:13:c6:01:d0:05",
  "firmware_version": "4.8.0"
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal Error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Successful request

Body

Media type: application/json

Type: object

• system_version: required(object)
  • rest_api_version: required(string)

    The REST API version e.g. v1.1

  • firmware_version: required(string)

    The console server firmware version e.g. 4.3.0

  • etc_version: required(string)

    The contents of /etc/version on console server romfs

Example:

{
  "system_version": {
    "etc_version": "OpenGear/ACM700x Version 4.3.0 host:yavin4 branch:branch1 d732a8c4* -- Wednesday 11 July  23:14:11 UTC 2018",
    "rest_api_version": "v1.1",
    "firmware_version": "4.3.0"
  }
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Succesful request

Body

Media type: application/json

Type: array of object

Items: items

Example:

[
  {
    "href": "/api/v1.3/interfaces/cellmodem",
    "id": "cellmodem",
    "enabled": true,
    "links": [
      {
        "href": "/api/v1.1/interfaces/cellmodem/status",
        "rel": "status"
      },
      {
        "href": "/api/v1.1/interfaces/cellmodem/tests",
        "rel": "tests"
      }
    ]
  }
]

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Succesful request

Body

Media type: application/json

Type: object

• interface: required(string)

  URI for the interface itself

• enabled: required(boolean)

  Is the interface currently enabled

• up: required(boolean)

  Is this link currently connected

• passthrough: (object)

  Details about whether IP Passthrough is enabled for this interface

  • enabled: required(boolean)

    Is IP Passthrough enabled

  • active: required(boolean)

    The current state of IP Passthrough

• ar_controlled: required(boolean)

  Is this interface controlled by the Auto-Response system

• failover: (object)

  Details about whether failover is enabled to this interface

  • enabled: required(boolean)

    Is Failover enabled

  • active: required(boolean)

    Is Failover active

  • dormant: required(boolean)

    Does the interface stay up when not failed-over to

• links: required(array of object)

  The list of physical links

  Items: items

  • wwan: (object)

    Details specifically related to cellmodem connections

    • mdn: required(string)

      Mobile Directory Number (MDN)

    • signalStrength: required(integer)

      Signal quality (%)

    • rssi: required(integer)

      Received Signal Strength Indicator (RSSI)

    • technology: required(string)

      Access technology

    • msid: required(string)

      Mobile station ID (MSID)

    • failure_reason: required(string)

      Failure reason

    • carrier: required(string)

      Carrier name

    • modem_status: required(string)

      Modem status

    • imei: required(string)

      IMEI

    • imsi: required(string)

      IMSI

    • iccid: required(string)

      ICCID

    • current_bands: required(string)

      Current bands

Example:

{
  "interface": "/api/v1.3/interfaces/cellmodem",
  "enabled": true,
  "up": true,
  "passthrough": {
    "enabled": true,
    "active": true
  },
  "ar_controlled": false,
  "failover": {
    "enabled": false,
    "dormant": false,
    "active": false
  },
  "links": [
    {
      "wwan": {
        "mdn": "",
        "signalStrength": 89,
        "technology": "gsm-umts, lte",
        "msid": "",
        "rssi": -67,
        "failure_reason": "none",
        "carrier": "Telstra Corp. Ltd.",
        "modem_status": "connected",
        "imei": "359260080000588",
        "imsi": "403013419552809",
        "iccid": "29310160092730753632",
        "current_bands": "WCDMA 2100 MHz (Class I), WCDMA 3GPP 1800 MHz (Class III), WCDMA 3GPP UMTS 1900 MHz (Class II), WCDMA 3GPP AWS 1700/2100 MHz (Class IV), WCDMA 3GPP UMTS 800 MHz (Class VI), WCDMA 3GPP UMTS 850 MHz (Class V), WCDMA 3GPP UMTS 900 MHz (Class VIII), WCDMA 3GPP UMTS 1700 MHz (Class IX), E-UTRAN band I, E-UTRAN band II, E-UTRAN band III, E-UTRAN band IV, E-UTRAN band V, E-UTRAN band VII, E-UTRAN band VIII, E-UTRAN band IX, E-UTRAN band XII, E-UTRAN band XIII, E-UTRAN band XVIII, E-UTRAN band XIX, E-UTRAN band XX, E-UTRAN band XLI, E-UTRAN band XLI, E-UTRAN band XLIII"
      }
    }
  ]
}

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 200

Succesful request

Body

Media type: application/json

Type: array of object

Items: items

Example:

[
  {
    "rel": "ping",
    "href": "/api/v1.3/interfaces/cellmodem/tests/ping"
  },
  {
    "rel": "http",
    "href": "/api/v1.3/interfaces/cellmodem/tests/http"
  },
  {
    "rel": "dns",
    "href": "/api/v1.3/interfaces/cellmodem/tests/dns"
  }
]

HTTP status code 304

Etag matched If-None-Match header

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Request data error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to parse request data"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid login credentials"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 201

Ping test created

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}

Secured by token

Headers

• Authorization: required(string)

  authorization session token

  Example:

  Token 521a00e57d4a461b3e4bb0c55166f97c

HTTP status code 201

HTTP test created

Body

Media type: application/json

Type: object

Example:

{}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

• error: required(string)

  The authentication error string

Example:

{
  "error": "Invalid Session ID"
}

HTTP status code 404

Resource not found

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Resource not found"
}

HTTP status code 500

Internal error

Body

Media type: application/json

Type: object

• error: required(string)

  An error string

Example:

{
  "error": "Failed to open configuration handle"
}