Operations Manager REST API documentation version v2

https://{appliancehost}/api/v2

  • appliancehost: required (string)

Operations Manager REST API

This API allows control and inspection of an Opengear Operations Manager appliance.

/sessions

The sessions endpoint is used to authenticate the user and create a session token for accessing all other Operations Manager endpoints.

post

post

Create a new authenticated session.

Create a new authenticated session.

Body

Media type: application/json

Type: object

Properties
  • username: required (string)
  • password: required (string)

Example:

{
  "username": "root",
  "password": "default"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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: object

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: object

Example:

{
  "error": [
    {
      "type": 4,
      "code": 40,
      "text": "Required field 'username' was not provided in the request",
      "args": {
        "param": "username"
      },
      "level": 1
    },
    {
      "type": 4,
      "code": 40,
      "text": "Required field 'password' was not provided in the request",
      "args": {
        "param": "password"
      },
      "level": 1
    }
  ]
}

HTTP status code 401

Authentication failed due to invalid credentials or session.

Body

Media type: application/json

Type: object

Example:

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

get put delete

get

Retrieve the state of an authentication session by ID. A session ID may be valid for some period after the user logs out.

put

Apply a challenge response to a session

delete

Log out of and delete a session

Retrieve the state of an authentication session by ID. A session ID may be valid for some period after the user logs out.

Secured by token

Operations Manager base authentication scheme

URI Parameters

  • sessionUid: required (string)

Headers

  • Authorization: required (string)

    Example:

    Token {{sessionUid}}

HTTP status code 200

Session exists

Body

Media type: application/json

Type: object

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

Example:

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

HTTP status code 400

Session does not exist

Body

Media type: application/json

Type: object

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

Example:

{
  "state": "unknown",
  "session": "4cf7ff89791062c2eddcbb7778d532a"
}

HTTP status code 401

Authentication failure

Body

Media type: application/json

Type: object

Properties
  • error: required (array of items)

    A list of errors

    Items: items

    • type: required (integer)
    • code: required (integer)
    • level: required (integer)
    • text: required (string)
    • args: required (object)

Examples:

example1:

{
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

example2:

{
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

HTTP status code 404

Session does not exist

Body

Media type: application/json

Type: object

Example:

{
  "state": "unknown",
  "session": "4cf7ff89791062c2eddcbb7778d532a"
}

Secured by token

Headers

  • Authorization: required (string)

    authorization session token

    Example:

    Token 521a00e57d4a461b3e4bb0c55166f97c

Apply a challenge response to a session

Secured by token

Operations Manager base authentication scheme

URI Parameters

  • sessionUid: required (string)

Headers

  • Authorization: required (string)

    Example:

    Token {{sessionUid}}

Body

Media type: application/json

Type: object

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

      Next challenge (if any)

    HTTP status code 200

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

    Body

    Media type: application/json

    Type: object

    Properties
    • 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

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 39,
      "text": "Invalid request body",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 403

      Authentication failed. No more attempts allowed.

      HTTP status code 404

      Authentication failed.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Log out of and delete a session

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • sessionUid: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Session deleted

      Body

      Media type: application/json

      Type: object

      Properties
      • 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

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Session did not exist

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /ports

      Configuring and viewing ports information

      get

      get

      Gets ports attached to this appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports.

      get put

      get

      Retrieve a single port by ID. For example, GET ports/ports-1

      put

      Update properties for a single port. For example, PUT ports/port-1

      Retrieve a single port by ID. For example, GET ports/ports-1

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Port has been updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • port: required (object)
        • parity: required (string)
        • label: required (string)
        • id: required (string)
        • stopbits: required (string)
        • pinout: required (one of X1, X2)
        • ip_alias: (array of getPortIpAliasListSingle)

          Items: getPortIpAliasListSingle

          • id: required (string)
          • port: required (string)
          • ipaddress: required (string)
          • interface: required (string)
        • baudrate: required (string)
        • mode: required (one of disabled, consoleServer)
        • logging_level: required (one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
        • databits: required (string)

      Examples:

      port_with_ipaliases:

      {
  "port": {
    "parity": "none",
    "label": "Port-1",
    "id": "ports-1",
    "stopbits": "1",
    "pinout": "X2",
    "ip_alias": [
      {
        "id": "ipalias-1",
        "port": "ports-1",
        "ipaddress": "192.168.33.201/24",
        "interface": "system_net_physifs-1"
      },
      {
        "id": "ipalias-2",
        "port": "ports-1",
        "ipaddress": "192.168.33.9/24",
        "interface": "system_net_physifs-1"
      }
    ],
    "baudrate": "9600",
    "mode": "consoleServer",
    "logging_level": "disabled",
    "databits": "8"
  }
}

      port_without_ipaliases:

      {
  "port": {
    "parity": "none",
    "label": "Port-3",
    "id": "ports-3",
    "stopbits": "1",
    "pinout": "X2",
    "ip_alias": [],
    "baudrate": "9600",
    "mode": "consoleServer",
    "logging_level": "disabled",
    "databits": "8"
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update properties for a single port. For example, PUT ports/port-1

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • port: required (object)
        • parity: required (string)
        • label: required (string)
        • stopbits: required (string)
        • pinout: required (one of X1, X2)
        • ip_alias: (array of putPortIpAliasListSingle)

          Items: putPortIpAliasListSingle

          • ipaddress: required (string)
          • interface: required (string)
        • baudrate: required (string)
        • mode: required (one of disabled, consoleServer)
        • logging_level: required (one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
        • databits: required (string)

      Examples:

      port_with_ipaliases:

      {
  "port": {
    "parity": "none",
    "label": "Port-1",
    "stopbits": "1",
    "pinout": "X2",
    "ip_alias": [
      {
        "ipaddress": "192.168.33.201/24",
        "interface": "system_net_physifs-1"
      },
      {
        "ipaddress": "192.168.33.9/24",
        "interface": "system_net_physifs-1"
      }
    ],
    "baudrate": "9600",
    "mode": "consoleServer",
    "logging_level": "disabled",
    "databits": "8"
  }
}

      port_without_ipaliases:

      {
  "port": {
    "parity": "none",
    "label": "Port-1",
    "stopbits": "1",
    "pinout": "X2",
    "ip_alias": [],
    "baudrate": "9600",
    "mode": "consoleServer",
    "logging_level": "disabled",
    "databits": "8"
  }
}

      HTTP status code 200

      Port has been updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • port: required (object)
        • parity: required (string)
        • label: required (string)
        • id: required (string)
        • stopbits: required (string)
        • pinout: required (one of X1, X2)
        • ip_alias: (array of getPortIpAliasListSingle)

          Items: getPortIpAliasListSingle

          • id: required (string)
          • port: required (string)
          • ipaddress: required (string)
          • interface: required (string)
        • baudrate: required (string)
        • mode: required (one of disabled, consoleServer)
        • logging_level: required (one of disabled, eventsOnly, eventsAndReceivedCharacters, eventsAndAllCharacters)
        • databits: required (string)

      Example:

      {
  "port": {
    "parity": "none",
    "label": "Port-1",
    "id": "ports-1",
    "stopbits": "1",
    "pinout": "X2",
    "ip_alias": [
      {
        "id": "ipalias-1",
        "port": "ports-1",
        "ipaddress": "192.168.33.201/24",
        "interface": "system_net_physifs-1"
      },
      {
        "id": "ipalias-2",
        "port": "ports-1",
        "ipaddress": "192.168.33.9/24",
        "interface": "system_net_physifs-1"
      }
    ],
    "baudrate": "9600",
    "mode": "consoleServer",
    "logging_level": "disabled",
    "databits": "8"
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /managementports

      Used for working with local management console information.

      get

      get

      Gets the local management console ports attached to this appliance. Any number of search query parameters can be provided to perform an ANDed search on the management ports.

      get put

      get

      Retrieve a single local management console port by ID. For example, GET managementports/mgmtPorts-1

      put

      Update properties for a single local management colsole port. For example, PUT managementports/mgmtPorts-1

      Retrieve a single local management console port by ID. For example, GET managementports/mgmtPorts-1

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      management port has been updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • managementport: required (object)
        • parity: required (string)
        • baud: required (string)
        • kerneldebug: required (boolean)
        • stopbits: required (string)
        • id: required (string)
        • device: required (string)
        • termemulation: required (one of vt100, vt102, vt220, linux, ansi)
        • databits: required (string)
        • enabled: required (boolean)

      Example:

      {
  "managementport": {
    "id": "mgmtPorts-1",
    "device": "ttyS0",
    "enabled": true,
    "kerneldebug": false,
    "termemulation": "vt100",
    "baud": "115200",
    "databits": "8",
    "parity": "none",
    "stopbits": "1"
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update properties for a single local management colsole port. For example, PUT managementports/mgmtPorts-1

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • managementport: required (object)
        • device: required (string)
        • enabled: required (boolean)
        • kerneldebug: required (boolean)
        • termemulation: required (one of vt100, vt102, vt220, linux, ansi)
        • baud: required (string)
        • databits: required (string)
        • parity: required (string)
        • stopbits: required (string)

      Example:

      {
  "managementport": {
    "device": "ttyS0",
    "enabled": true,
    "kerneldebug": false,
    "termemulation": "vt100",
    "baud": "115200",
    "databits": "8",
    "parity": "none",
    "stopbits": "1"
  }
}

      HTTP status code 200

      Management Port has been updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • managementport: required (object)
        • parity: required (string)
        • baud: required (string)
        • kerneldebug: required (boolean)
        • stopbits: required (string)
        • id: required (string)
        • device: required (string)
        • termemulation: required (one of vt100, vt102, vt220, linux, ansi)
        • databits: required (string)
        • enabled: required (boolean)

      Example:

      {
  "managementport": {
    "id": "mgmtPorts-1",
    "device": "ttyS0",
    "enabled": true,
    "kerneldebug": false,
    "termemulation": "vt100",
    "baud": "115200",
    "databits": "8",
    "parity": "none",
    "stopbits": "1"
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Used to perform searches on ports on the system.

      get

      Creating a search ID for ports from the given query parameters.

      get

      Gets a search ID for searching ports attached to this Operations Manager appliance. Any number of search query parameters can be provided to perform an ANDed search on the ports. The list provided is dynamic.

      /logs

      Used for working with the logs on the system.

      get

      get

      Fetch last n log lines in syslog. For example, GET logs/syslog/?logLines=10

      get

      get

      Fetch last n log lines in portlog. For example, GET logs/portlog/ports-1?logLines=20

      Fetch last n log lines in portlog. For example, GET logs/portlog/ports-1?logLines=20

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Query Parameters

      • logLines: (integer - default: 100 - minimum: 10 - maximum: 1000)

        The number of lines to fetch - max 1000, min 10.

      HTTP status code 200

      Returns the last n lines in the portlog

      Body

      Media type: application/json

      Type: object

      Properties
      • portlog: required (object)
        • id: required (string)
        • no_of_log_lines: required (integer)
        • log_lines: required (array of )

      Example:

      {
  "portlog": {
    "id": "portlogports-1771bed6129488a69764d064ed7e6086d",
    "log_lines": [
      "2018-04-19T21:59:42.475157+00:00 TXDATA ",
      "2018-04-19T21:59:43.720286+00:00 TXDATA ^C",
      "2018-04-19T21:59:44.004623+00:00 TXDATA ^C",
      "2018-04-19T21:59:49.053138+00:00 TXDATA ^C",
      "2018-04-19T21:59:49.739765+00:00 TXDATA ^C",
      "2018-04-19T21:59:50.349753+00:00 LOGOUT root",
      "2018-04-19T21:59:50.373627+00:00 RXDATA ",
      "2018-04-19T21:59:50.402295+00:00 RXDATA asdfasdf",
      "2018-04-19T22:00:18.216623+00:00 LOGIN root",
      "2018-04-19T22:00:21.386050+00:00 TXDATA rootrootakjdfaksjdf",
      "2018-04-19T22:00:25.145561+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf",
      "2018-04-19T22:00:26.473879+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ",
      "2018-04-19T22:00:42.660939+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C",
      "2018-04-19T22:00:45.472921+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~",
      "2018-04-19T22:00:46.456493+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
      "2018-04-19T22:00:46.887685+00:00 TXDATA rootrootakjdfaksjdfkjasdkjfakdjf ^C~.",
      "2018-04-19T22:00:47.057797+00:00 TXDATA ",
      "2018-04-19T22:00:47.236891+00:00 TXDATA ",
      "2018-04-19T22:00:47.413115+00:00 TXDATA ",
      "2018-04-19T22:00:48.328447+00:00 LOGOUT root"
    ],
    "no_of_log_lines": 20
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /services

      Used for working with the properties of the various services running on the system.

      get put

      Provides access to the SSL certificate used by web services on the device.

      get

      Fetch HTTPS certificate details, or a CSR file if the zip flag is set.

      put

      Update HTTPS details. A certificate matching the CSR can be uploaded by setting the https.cert field, a CSR can be cancelled by sending through no https.csr body, and a new csr can be created by sending through a https.csr body with a csr value of "new".

      get put

      Provides access to the NTP client configuration on the system.

      get

      Fetch NTP client configuration.

      put

      Update NTP client configuration, including enabling/disabling the NTP service.

      get post

      Provides access to the remote syslog server configuration.

      get

      Fetch remote syslog server configuration list.

      post

      Create a new syslog server data in the configuration.

      Create a new syslog server data in the configuration.

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • syslogServer: required (object)
        • port: (integer)
        • protocol: (string)
        • address: required (string)

      Example:

      {
  "syslogServer": {
    "port": 1000,
    "protocol": "UDP",
    "address": "192.168.33.199"
  }
}

      HTTP status code 200

      Created syslog server configuration

      Body

      Media type: application/json

      Type: object

      Properties
      • syslogServer: required (object)
        • id: required (string)
        • port: required (integer)
        • protocol: required (string)
        • address: required (string)

      Example:

      {
  "syslogServer": {
    "id": "{services_syslog_servers-2}",
    "port": 1000,
    "protocol": "UDP",
    "address": "192.168.33.199"
  }
}

      HTTP status code 400

      Failed to initiate syslog server creation due to error in post body.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 22,
      "text": "Element [protocol] is of the wrong type",
      "args": {
        "uuid": "protocol"
      },
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failed due to invalid session.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get put delete

      get

      Fetch a configured syslog server by id such as GET services_syslog_servers-1

      put

      Update syslog server configuration

      delete

      Delete a syslog server; e.g. DELETE /services/syslog/{syslog_server_id}

      Fetch a configured syslog server by id such as GET services_syslog_servers-1

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • syslog_server_id: required (string)

        unique identifier for syslog servers

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Returns the requested syslog server configuration.

      Body

      Media type: application/json

      Type: object

      Properties
      • syslogServer: required (object)
        • id: required (string)
        • port: required (integer)
        • protocol: required (string)
        • address: required (string)

      Example:

      {
  "syslogServer": {
    "id": "services_syslog_servers-1",
    "port": 705,
    "protocol": "UDP",
    "address": "192.168.33.200"
  }
}

      HTTP status code 400

      Returns an error after the operation failed due to invalid request.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 40,
      "text": "Required field 'services_syslog-1' was not provided in the request",
      "args": {
        "param": "server-1"
      },
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 500

      Error saving syslog configuration.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 25,
      "text": "'' is not a valid hostname",
      "args": {
        "address": "",
        "uuid": "services_syslog_servers-1"
      },
      "level": 1
    },
    {
      "type": 1,
      "code": 33,
      "text": "Push command failed",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update syslog server configuration

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • syslog_server_id: required (string)

        unique identifier for syslog servers

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • syslogServer: required (object)
        • port: (integer)
        • protocol: (string)
        • address: required (string)

      Example:

      {
  "syslogServer": {
    "address": "192.168.33.199",
    "port": 1000,
    "protocol": "UDP"
  }
}

      HTTP status code 200

      Returns the updated syslog server configuration.

      Body

      Media type: application/json

      Type: object

      Properties
      • syslogServer: required (object)
        • id: required (string)
        • port: required (integer)
        • protocol: required (string)
        • address: required (string)

      Example:

      {
  "syslogServer": {
    "id": "services_syslog_servers-1",
    "port": 705,
    "protocol": "UDP",
    "address": "192.168.33.200"
  }
}

      HTTP status code 400

      Returns an error after the operation failed due to invalid request.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 40,
      "text": "Required field 'services_syslog-1' was not provided in the request",
      "args": {
        "param": "server-1"
      },
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Error saving syslog configuration.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 25,
      "text": "'' is not a valid hostname",
      "args": {
        "address": "",
        "uuid": "services_syslog_servers-1"
      },
      "level": 1
    },
    {
      "type": 1,
      "code": 33,
      "text": "Push command failed",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete a syslog server; e.g. DELETE /services/syslog/{syslog_server_id}

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • syslog_server_id: required (string)

        unique identifier for syslog servers

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      syslog server deleted

      HTTP status code 400

      Returns an error after the operation failed due to invalid request.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 40,
      "text": "Required field 'services_syslog-1' was not provided in the request",
      "args": {
        "param": "server-1"
      },
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      syslog server does not exist

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'services_syslog_servers-2'",
      "args": {
        "uuid": "services_syslog_servers-2"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get put

      get

      Fetch the current ssh delimiter. For example, GET services/ssh

      put

      Update config parameters related to the SSH service.

      /physifs

      Read and manipulate the network physical interfaces on the Operations Manager appliance.

      get

      get

      Get a list of the network interfaces on the Operations Manager appliance: GET physifs

      get put

      get

      Get a network interface on the Operations Manager appliance, by id: GET physifs/id

      put

      Update settings for a network interface on the Operations Manager appliance, by id: PUT physifs/id

      Get a network interface on the Operations Manager appliance, by id: GET physifs/id

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • physif: required (object)
        • enabled: required (boolean)
        • description: required (string)
        • media: required (string)
        • id: required (string)
        • ethernet_setting: required (object)
          • link_speed: required (string)
          • id: required (string)
        • runtime_status: required (object)
          • status: required (string)
          • id: required (string)

      Example:

      {
  "physif": {
    "enabled": true,
    "description": "Auto-detected ethernet device",
    "media": "ethernet",
    "id": "system_net_physifs-1",
    "ethernet_setting": {
      "id": "system_net_physifs-1",
      "link_speed": "auto"
    },
    "runtime_status": {
      "status": "running",
      "id": "system_net_physifs-1"
    }
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update settings for a network interface on the Operations Manager appliance, by id: PUT physifs/id

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • physif: required (object)
        • enabled: required (boolean)
        • description: (string)
        • media: required (string)
        • ethernet_setting: required (object)
          • link_speed: required (string)

      Example:

      {
  "physif": {
    "enabled": true,
    "description": "NET1 - 1G Copper/SFP",
    "media": "ethernet",
    "ethernet_setting": {
      "link_speed": "auto"
    }
  }
}

      HTTP status code 200

      The physif {id} settings was updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • physif: required (object)
        • enabled: required (boolean)
        • description: required (string)
        • media: required (string)
        • id: required (string)
        • ethernet_setting: required (object)
          • link_speed: required (string)
          • id: required (string)
        • runtime_status: required (object)
          • status: required (string)
          • id: required (string)

      Example:

      {
  "physif": {
    "enabled": true,
    "description": "NET1 - 1G Copper/SFP",
    "media": "ethernet",
    "id": "system_net_physifs-1",
    "ethernet_setting": {
      "id": "system_net_physifs-1",
      "link_speed": "auto"
    },
    "runtime_status": {
      "status": "running",
      "id": "system_net_physifs-1"
    }
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: physif id parameter missing.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      physif {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /conns

      Read and manipulate the network connections on the Operations Manager appliance.

      get post

      get

      Get a list of the network connections on the server.

      post

      Add a new network connection to the Operations Manager appliance.

      Add a new network connection to the Operations Manager appliance.

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • conn: required (object)
        • id: (string)
        • description: (string)
        • name: (string)
        • mode: required (string)
        • physif: required (string)
        • ipv4_static_settings: (object)
          • netmask: required (string)
          • address: required (string)
          • broadcast: (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • ipv6_static_settings: (object)
          • prefix_length: required (string)
          • address: required (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)

      Example:

      {
  "conn": {
    "ipv4_static_settings": {
      "netmask": "255.255.255.0",
      "address": "192.168.87.156",
      "gateway": "192.168.87.100",
      "broadcast": "192.168.87.255",
      "dns1": "192.168.87.100",
      "dns2": "192.168.87.100"
    },
    "mode": "static",
    "physif": "system_net_physifs-1"
  }
}

      HTTP status code 200

      The conn {id} settings was updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • conn: required (object)
        • name: (string)
        • ipv4_static_settings: (object)
          • id: (string)
          • netmask: required (string)
          • address: required (string)
          • broadcast: (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • ipv6_static_settings: (object)
          • id: required (string)
          • prefix_length: required (number)
          • address: required (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • id: (string)
        • mode: required (string)
        • description: (string)
        • physif: required (string)
        • runtime_status: (object)
          • status: required (string)
          • addresses: required (array of (conn_return_status_ipv4_address | conn_return_status_ipv6_address))
          • last_status_change: required (number)
          • id: required (string)

      Example:

      {
  "conn": {
    "name": "conn-2",
    "ipv4_static_settings": {
      "netmask": "255.255.255.0",
      "address": "192.168.87.156",
      "gateway": "192.168.87.100",
      "broadcast": "192.168.87.255",
      "dns1": "192.168.87.100",
      "dns2": "192.168.87.100"
    },
    "id": "system_net_conns-9",
    "mode": "static",
    "physif": "system_net_physifs-1",
    "runtime_status": {
      "status": "reloading",
      "addresses": [
        {
          "id": "system_net_conns-9"
        }
      ],
      "last_status_change": 1536209633,
      "id": "system_net_conns-9"
    }
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get put delete

      get

      Get the configuration of a network connection on the Operations Manager appliance: GET /conns/{id}

      put

      Update settings for a network connection on the Operations Manager appliance: PUT /conns/{id}

      delete

      Delete a network connection on the Operations Manager appliance: DELETE /conns/{id}

      Get the configuration of a network connection on the Operations Manager appliance: GET /conns/{id}

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • conn: required (object)
        • name: (string)
        • ipv4_static_settings: (object)
          • id: (string)
          • netmask: required (string)
          • address: required (string)
          • broadcast: (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • ipv6_static_settings: (object)
          • id: required (string)
          • prefix_length: required (number)
          • address: required (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • id: (string)
        • mode: required (string)
        • description: (string)
        • physif: required (string)
        • runtime_status: (object)
          • status: required (string)
          • addresses: required (array of (conn_return_status_ipv4_address | conn_return_status_ipv6_address))
          • last_status_change: required (number)
          • id: required (string)

      Example:

      {
  "conn": {
    "name": "default-conn-1",
    "ipv4_static_settings": {
      "id": "system_net_conns-1",
      "netmask": "255.255.255.0",
      "address": "192.168.87.156",
      "gateway": "192.168.87.100",
      "broadcast": "192.168.87.255",
      "dns1": "192.168.87.100",
      "dns2": "192.168.87.100"
    },
    "id": "system_net_conns-1",
    "mode": "static",
    "description": "Default static network connection",
    "physif": "system_net_physifs-1",
    "runtime_status": {
      "status": "reloading",
      "addresses": [
        {
          "id": "system_net_conns-1"
        }
      ],
      "last_status_change": 1536210047,
      "id": "system_net_conns-2"
    }
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update settings for a network connection on the Operations Manager appliance: PUT /conns/{id}

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • conn: required (object)
        • id: (string)
        • description: (string)
        • name: (string)
        • mode: required (string)
        • physif: required (string)
        • ipv4_static_settings: (object)
          • netmask: required (string)
          • address: required (string)
          • broadcast: (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • ipv6_static_settings: (object)
          • prefix_length: required (string)
          • address: required (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)

      Example:

      {
  "conn": {
    "ipv4_static_settings": {
      "netmask": "255.255.255.0",
      "address": "192.168.87.156",
      "gateway": "192.168.87.100",
      "broadcast": "192.168.87.255",
      "dns1": "192.168.87.100",
      "dns2": "192.168.87.100"
    },
    "mode": "static",
    "physif": "system_net_physifs-1"
  }
}

      HTTP status code 200

      The conn settings were updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • conn: required (object)
        • name: (string)
        • ipv4_static_settings: (object)
          • id: (string)
          • netmask: required (string)
          • address: required (string)
          • broadcast: (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • ipv6_static_settings: (object)
          • id: required (string)
          • prefix_length: required (number)
          • address: required (string)
          • gateway: (string)
          • dns1: (string)
          • dns2: (string)
        • id: (string)
        • mode: required (string)
        • description: (string)
        • physif: required (string)
        • runtime_status: (object)
          • status: required (string)
          • addresses: required (array of (conn_return_status_ipv4_address | conn_return_status_ipv6_address))
          • last_status_change: required (number)
          • id: required (string)

      Example:

      {
  "conn": {
    "name": "conn-2",
    "ipv4_static_settings": {
      "broadcast": "192.168.87.255",
      "gateway": "192.168.87.100",
      "address": "192.168.87.156",
      "id": "system_net_conns-2",
      "dns2": "192.168.87.100",
      "dns1": "192.168.87.100",
      "netmask": "255.255.255.0"
    },
    "id": "system_net_conns-2",
    "mode": "static",
    "physif": "system_net_physifs-1",
    "runtime_status": {
      "status": "reloading",
      "addresses": [
        {
          "id": "system_net_conns-2"
        }
      ],
      "last_status_change": 1536210052,
      "id": "system_net_conns-2"
    }
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: conn id parameter missing.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Conn {id} does not exist. Attempted to change read only fields. Attempted to change unknown fields.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete a network connection on the Operations Manager appliance: DELETE /conns/{id}

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Conn deleted

      HTTP status code 400

      Incomplete data

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      User did not exist

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'system_net_conns-1'",
      "args": {
        "uuid": "system_net_conns-1"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /lighthouse_enrollments

      View and control enrollment to a lighthouse

      get post

      get

      Get the information about the lighthouse enrollments

      post

      Create a new lighthouse enrollment

      Create a new lighthouse enrollment

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • lighthouse_enrollment: required (object)
        • address: required (string)
        • port: (integer)
        • bundle: (string)
        • token: required (string)

      Example:

      {
  "lighthouse_enrollment": {
    "address": "192.168.0.1",
    "token": "password",
    "bundle": "bundle-1",
    "port": 8443
  }
}

      HTTP status code 201

      The new lighthouse enrollment was successfully created and callhome enrollment was started.

      Body

      Media type: application/json

      Type: object

      Properties
      • lighthouse_enrollment: required (object)
        • port: (integer)
        • address: required (string)
        • id: required (string)
        • bundle: (string)
        • status: required (string)

      Example:

      {
  "lighthouse_enrollment": {
    "id": "lighthouse_enrollments-1",
    "port": 8443,
    "status": "Enrolling",
    "address": "192.168.0.1"
  }
}

      HTTP status code 400

      Invalid request: body is not json or doesn not conform to required json schema.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get delete

      get

      Get lighthouse-enrollment information by id.

      delete

      Delete lighthouse enrollment object and begin unenrollment

      Get lighthouse-enrollment information by id.

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the lighthouse-enrollment to fetch

        Example:

        lighthouse_enrollment-2

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • lighthouse_enrollment: required (object)
        • port: (integer)
        • address: required (string)
        • id: required (string)
        • bundle: (string)
        • status: required (string)

      Example:

      {
  "lighthouse_enrollment": {
    "id": "lighthouse_enrollments-2",
    "port": 443,
    "status": "Connected",
    "address": "192.168.0.1"
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      The lighthouse-enrollment doesn't exist.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'lighthouse_enrollments-6'",
      "args": {
        "uuid": "lighthouse_enrollments-6"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete lighthouse enrollment object and begin unenrollment

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the lighthouse-enrollment to fetch

        Example:

        lighthouse_enrollment-2

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "OK"
}

      HTTP status code 400

      Incomplete data

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'lighthouse_enrollments-20'",
      "args": {
        "uuid": "lighthouse_enrollments-20"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /registration

      Registration endpoint accessed by a Lighthouse to start Lighthouse driven enrollment

      post delete

      post

      Initial contact from Lighthouse to start the Enrollment process

      delete

      Delete all lhvpn_tunnels.

      Initial contact from Lighthouse to start the Enrollment process

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • id: required (string)
      • package_password: required (string)
      • server: required (string)
      • server_api_port: (integer)
      • lh_ext_eps: (array of items)

        Items: items

        • server: required (string)
        • server_api_port: (integer)
        • server_vpn_port: (integer)

      Example:

      {
  "id": "nodes-1",
  "server": "192.168.0.1",
  "server_api_port": 8443,
  "package_password": "password",
  "lh_ext_eps": [
    {
      "server": "162.168.0.1",
      "server_api_port": 8443,
      "server_vpn_port": 1121
    },
    {
      "server": "162.168.0.2",
      "server_api_port": 601,
      "server_vpn_port": 1121
    }
  ]
}

      HTTP status code 201

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "OK"
}

      HTTP status code 400

      Invalid request: body is not json or doesn not conform to required json schema.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": [
    {
      "type": 4,
      "code": 39,
      "text": "Invalid request body",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      put

      Update the lhvpn_tunnel server address

      put
      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

        The ID of the node as seen by the lighthouse

        Example:

        lighthouse_enrollment-2

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • address: required (string)

      Example:

      {
  "address": "192.168.0.1"
}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "OK"
}

      HTTP status code 400

      Invalid request: body is not json or doesn not conform to required json schema.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": [
    {
      "type": 4,
      "code": 39,
      "text": "Invalid request body",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'nodes-1'",
      "args": {
        "uuid": "nodes-1"
      },
      "level": 1
    }
  ]
}

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /system

      System endpoints are related to configuring and accessing information about the Operations Manager appliance itself.

      get put

      Retrieve or change the Operations Manager appliance system's hostname.

      get

      Get the Operations Manager appliance hostname.

      put

      Update the Operations Manager appliance hostname.

      get put

      Retrieve or update the Lighthouse server's global enrollment token.

      get

      Retrieve the Lighthouse's global enrollment token.

      put

      Update the Lighthouse's global enrollment token.

      get put

      Retrieve or change the Operations Manager appliance WebUI session timeout.

      get

      Retrieve the WebUI session timeout (in minutes).

      put

      Update the WebUI session timeout (in minutes).

      get put

      Retrieve or change the Operations Manager appliance CLI

      get

      Retrieve the CLI session timeout (in minutes).

      put

      Update the CLI session timeout (in minutes).

      get put

      The SSH port used in Direct SSH links.

      get

      Retrieve the system SSH port.

      put

      Update the system SSH port.

      get put

      Retrieve and update the system's timezone.

      get

      Retrieves the system timezone.

      put

      Update the system timezone.

      get put

      Retrieve and update the Operations Manager's time.

      get

      Retrieve the Operations Manager current time.

      put

      Update the Operations Manager current time.

      delete

      delete

      Delete the configuration effectively performing a system reset. The will reset to factory settings and reboot. The user will need to access the device via the console to set the root password before the network will be available.

      post

      post

      Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.

      Upgrade the system firmware either by uploading a file or providing a url to download the file from. This endpoint will always return success if the firmware upgrade job was started - it occurs in the background and the state of which should be retrieved from the GET /system/firmware_upgrade_status endpoint. At least 'file' or 'firmware_url' are required.

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: multipart/form-data

      Type: object

      Properties
      • file: (file)

        The file to be uploaded.

      • firmware_url: (string)

        A url for the file to download.

      • firmware_options: (string)

        Options for the firmware upgrade tool.

      HTTP status code 200

      The firmware upgrade process was started.

      Body

      Media type: application/json

      Type: object

      Properties
      • system_firmware_upgrade_status: required (object)
        • state: required (one of pending, running, error, finished)
        • error_message: (one of format_error, download_error, version_error, runtime_error)

      Example:

      {
  "system_firmware_upgrade_status":
    {
      "state": "running"
    }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get

      get

      Retrieve the status of the most recent firmware upgrade job.

      get

      Retrieve the Operations Manager's most recent firmware and REST API version.

      get

      Get the version information.

      get

      Retrieve the Operations Manager appliance's Serial Number.

      get

      Get the Serial Number information.

      /support_report

      A report which will provide information about the state of the Operations Manager appliance. This information can be used to help analyse and understand the state of the system. The report is large and may take in the order of a minute to obtain.

      get

      get

      Retrieve the support report data.

      /auth

      Configure remote authentication, authorization, accounting (AAA) servers.

      get put

      get

      Retrieve information on AAA servers.

      put

      Update the AAA config.

      /users

      Retrieve and update user information.

      get post

      get

      Retrieve a list of users.

      post

      Create a new User data in the config.

      Create a new User data in the config.

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • user: required (object)
        • username: required (string)
        • description: (string)
        • enabled: required (boolean)
        • no_password: required (boolean)
        • groups: required (array of )

          A list of groups

      Example:

      {
  "user": {
    "username": "tu1",
    "description": "testupdated",
    "enabled": true,
    "no_password": true,
    "groups": [
      "groups-2"
    ]
  }
}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • user: required (object)
        • username: required (string)
        • description: (string)
        • enabled: required (boolean)
        • id: required (string)
        • no_password: required (boolean)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)
        • groups: required (array of )

          A list of groups

      Example:

      {
  "user": {
    "username": "tu1",
    "description": "testupdated",
    "enabled": true,
    "id": "users-5",
    "no_password": true,
    "rights": {
      "delete": true,
      "modify": true
    },
    "groups": [
      "groups-2"
    ]
  }
}

      HTTP status code 400

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

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 12,
      "text": "Element is below the minimum allowed length of 1 character(s)",
      "args": {
        "min": "1",
        "uuid": "{60e2b0a-aafa-11e6-aca7-cb7fd0646002"
      },
      "level": 1
    },
    {
      "type": 1,
      "code": 33,
      "text": "Push command failed",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failed due to invalid session.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get put delete

      get

      Retrieve the User information by ID.

      put

      Update a User data in the config.

      delete

      Delete a User

      Retrieve the User information by ID.

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      User exists

      Body

      Media type: application/json

      Type: object

      Properties
      • user: required (object)
        • username: required (string)
        • description: (string)
        • enabled: required (boolean)
        • id: required (string)
        • no_password: required (boolean)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)
        • groups: required (array of )

          A list of groups

      Example:

      {
  "user": {
    "username": "tu0",
    "description": "",
    "enabled": true,
    "id": "users-2",
    "no_password": false,
    "rights": {
      "delete": true,
      "modify": true
    },
    "groups": [
      "groups-1"
    ]
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failed due to invalid session.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}
      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      User does not exist. User Not Found.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'users-2'",
      "args": {
        "uuid": "users-2"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update a User data in the config.

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • user: required (object)
        • username: required (string)
        • description: (string)
        • enabled: required (boolean)
        • no_password: required (boolean)
        • groups: required (array of )

          A list of groups

      Example:

      {
  "user": {
    "username": "tu1",
    "description": "testupdated",
    "enabled": true,
    "no_password": true,
    "groups": [
      "groups-2"
    ]
  }
}

      HTTP status code 200

      User has been Updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • user: required (object)
        • username: required (string)
        • description: (string)
        • enabled: required (boolean)
        • id: required (string)
        • no_password: required (boolean)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)
        • groups: required (array of )

          A list of groups

      Example:

      {
  "user": {
    "username": "tu1",
    "description": "testupdated",
    "enabled": true,
    "no_password": true,
    "id": "users-5",
    "rights": {
      "delete": true,
      "modify": true
    },
    "groups": [
      "groups-2"
    ]
  }
}

      HTTP status code 400

      Invalid request

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 39,
      "text": "Invalid request body",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete a User

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      User deleted

      HTTP status code 400

      Incomplete data

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      User did not exist

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'users-2'",
      "args": {
        "uuid": "users-2"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /groups

      Retrieve or update group information.

      get post

      get

      Retrieve a list of groups.

      post

      Create a new Group in the config.

      Create a new Group in the config.

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • group: required (object)
        • groupname: required (string)
        • enabled: required (boolean)
        • mode: required (string)
        • role: required (string)
        • description: (string)
        • ports: (array of items)

      Examples:

      group_for_admin:

      {
  "group": {
    "groupname": "local_admin",
    "enabled": true,
    "mode": "global",
    "role": "Administrator"
  }
}

      group_for_users:

      {
  "group": {
    "groupname": "my_group",
    "enabled": true,
    "mode": "scoped",
    "role": "ConsoleUser",
    "ports": [
      "ports-1",
      "ports-2",
      "ports-3"
    ]
  }
}

      HTTP status code 201

      Body

      Media type: application/json

      Type: object

      Properties
      • group: required (object)
        • id: required (string)
        • enabled: required (boolean)
        • groupname: required (string)
        • mode: required (string)
        • role: required (string)
        • description: (string)
        • members: required (array of items)
        • ports: required (array of items)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)

      Examples:

      admin_group:

      {
  "group": {
    "id": "groups-1",
    "enabled": true,
    "groupname": "local-admin",
    "mode": "global",
    "role": "Administrator",
    "members": [],
    "ports": [],
    "rights": {
      "delete": true,
      "modify": true
    }
  }
}

      ConsoleUser_group:

      {
  "group": {
    "id": "groups-3",
    "enabled": true,
    "groupname": "my_group",
    "mode": "scoped",
    "role": "ConsoleUser",
    "description": "Group for ConsoleUser",
    "members": [],
    "ports": [
      "ports-1",
      "ports-2",
      "ports-3"
    ],
    "rights": {
      "delete": true,
      "modify": false
    }
  }
}

      HTTP status code 400

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

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 26,
      "level": 1,
      "text": "Duplicate 'groupname' fields with value 'netgrp'",
      "args": {
        "value": "netgrp",
        "uuid": "root-1-@groups",
        "field": "groupname"
      }
    },
    {
      "type": 1,
      "code": 33,
      "level": 1,
      "text": "Push command failed",
      "args": {}
    }
  ]
}

      HTTP status code 401

      Authentication failed due to invalid session.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get put delete

      get

      Retrieve the Group information by ID.

      put

      Update a Group data in the config.

      delete

      Delete a Group

      Retrieve the Group information by ID.

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Group exists

      Body

      Media type: application/json

      Type: object

      Properties
      • group: required (object)
        • id: required (string)
        • enabled: required (boolean)
        • groupname: required (string)
        • mode: required (string)
        • role: required (string)
        • description: (string)
        • members: required (array of items)
        • ports: required (array of items)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)

      Example:

      {
  "group": {
    "id": "groups-6",
    "enabled": true,
    "groupname": "netgrp2",
    "mode": "scoped",
    "role": "ConsoleUser",
    "members": [
      "users-1",
      "users-2"
    ],
    "ports": [
      "ports-1",
      "ports-2",
      "ports-3"
    ],
    "rights": {
      "delete": true,
      "modify": false
    }
  }
}

      HTTP status code 400

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failed due to invalid session.

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Examples:

      example1:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      example2:

      {
  "error": [
    {
      "type": 7,
      "code": 46,
      "text": "Permission denied",
      "args": {},
      "level": 1
    }
  ]
}
      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Group does not exist. Group Not Found.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'groups-59'",
      "args": {
        "uuid": "groups-59"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update a Group data in the config.

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • group: required (object)
        • enabled: required (boolean)
        • groupname: required (string)
        • mode: required (string)
        • role: required (string)
        • description: (string)
        • members: required (array of items)
        • ports: (array of items)

      Example:

      {
  "group": {
    "enabled": true,
    "groupname": "netgrp2",
    "mode": "scoped",
    "role": "ConsoleUser",
    "description": "Group for ConsoleUser role",
    "members": [
      "users-1",
      "users-2"
    ],
    "ports": [
      "ports-1",
      "ports-2",
      "ports-3"
    ]
  }
}

      HTTP status code 200

      Group has been updated.

      Body

      Media type: application/json

      Type: object

      Properties
      • group: required (object)
        • id: required (string)
        • enabled: required (boolean)
        • groupname: required (string)
        • mode: required (string)
        • role: required (string)
        • description: (string)
        • members: required (array of items)
        • ports: required (array of items)
        • rights: required (object)
          • delete: required (boolean)
          • modify: required (boolean)

      Example:

      {
  "group": {
    "id": "groups-6",
    "enabled": true,
    "groupname": "netgrp2",
    "mode": "scoped",
    "role": "ConsoleUser",
    "description": "Group for ConsoleUser role",
    "members": [
      "users-1",
      "users-2"
    ],
    "ports": [
      "ports-1",
      "ports-2",
      "ports-3"
    ],
    "rights": {
      "delete": true,
      "modify": false
    }
  }
}

      HTTP status code 400

      Invalid request

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 4,
      "code": 39,
      "text": "Invalid request body",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Not found

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 500

      Internal error

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete a Group

      Secured by token

      Operations Manager base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 204

      Group deleted

      HTTP status code 400

      Incomplete data

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      HTTP status code 404

      Group did not exist

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'groups-6'",
      "args": {
        "uuid": "groups-6"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /scripts

      The scripts endpoint is used to upload and execute custom user scripts on the appliance and to retrieve the status of currently executing scripts

      post get

      post

      Upload a shell script to be executed on the node

      get

      Retrieve the status of a script executing on the node, as in GET /scripts?execution_id={id}, where id is the value for execution_id returned in the 200 response to the POST /scripts request.

      Upload a shell script to be executed on the node

      Secured by token

      Operations Manager base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: multipart/form-data

      Type: object

      Properties
      • script_metadata: required (object)

        JSON object containing script_timeout in minutes and the script_checksum (SHA1).

        • script_timeout: required (integer)

          The number of minutes that the script is allowed to run

        • script_checksum: required (string)

          The SHA1 checksum of the script

      • file: required (file)

        The file to be uploaded.

      HTTP status code 200

      Successful request

      Body

      Media type: application/json

      Type: object

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

      Example:

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

      HTTP status code 400

      Invalid request

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": "Invalid script metadata"
}

      HTTP status code 401

      Authentication failure

      Body

      Media type: application/json

      Type: object

      Properties
      • error: required (array of items)

        A list of errors

        Items: items

        • type: required (integer)
        • code: required (integer)
        • level: required (integer)
        • text: required (string)
        • args: required (object)

      Example:

      {
  "error": [
    {
      "type": 7,
      "code": 42,
      "level": 1,
      "text": "Invalid session ID",
      "args": {}
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c