Lighthouse REST API API documentation version v1

https://{lighthousehost}/api/v1

  • lighthousehost: required (string)

Lighthouse REST API

This API allows control and inspection of an Opengear Lighthouse management instance.

/sessions

The sessions endpoint is used to authenticate the user and create a session token for accessing all other Lighthouse 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

Lighthouse 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

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

Lighthouse 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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

      Lighthouse 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Session did not exist

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /nodes

      Creating/registering and viewing the state of console server nodes.

      get post

      get

      Gets nodes attached to this lighthouse instance.

      Any number of search query parameters can be provided to perform an ANDed search on the nodes. The parameters possible should be retrieved with GET /nodes/fields. The list provided is dynamic.

      The standard ember-data pagination fields {per_page} and {page} apply to this list.

      {per_page} and {page} are optional but both are to be supplied if pages are requested. A node response will also contain a list of tags, which represents the user-editable attributes assigned to this node.

      post

      Enqueue a new node for enrollment. This can either be a direct (Lighthouse-driven) enrollment, or a enrollment request by a new node ("call-home"). The "call-home" parameter in the enrollment request body dictates what style it should be. If true, the request is not authenticated with a sesstion token (ie. from the web UI), but an enrollment request token. The caller should also pass a hostname to be used for the node name, and can optionally pass a bundle identifier to request enrollment against a specific bundle. If the enrollment is not "call-home", but directly driven from the Lighthouse, the request should be in an authenticted session, and provide the node details (name, address, username, password and auto-approve). The address must be a valid IPv4 address.

      Enqueue a new node for enrollment. This can either be a direct (Lighthouse-driven) enrollment, or a enrollment request by a new node ("call-home"). The "call-home" parameter in the enrollment request body dictates what style it should be. If true, the request is not authenticated with a sesstion token (ie. from the web UI), but an enrollment request token. The caller should also pass a hostname to be used for the node name, and can optionally pass a bundle identifier to request enrollment against a specific bundle. If the enrollment is not "call-home", but directly driven from the Lighthouse, the request should be in an authenticted session, and provide the node details (name, address, username, password and auto-approve). The address must be a valid IPv4 address.

      Secured by token

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • enrollment: required (object)
        • product: (string)
        • call_home: (boolean)
        • hostname: (string)
        • bundle: (string)
        • token: (string)
        • name: (string)
        • address: (string)
        • username: (string)
        • password: (string)
        • auto_approve: (boolean)
        • connection_method: (string)
        • base_port: (integer)
        • port_count: (integer)
        • port_labels: (array of items)

      Examples:

      example1:

      {
  "enrollment": {
    "product": "opengear",
    "call_home": true,
    "token": "ABCDEFGHIJKLMNOPQRSTUVWXYZ123456",
    "bundle": "console-servers",
    "hostname": "acm7004-5"
  }
}

      example2:

      {
  "enrollment": {
    "product": "opengear",
    "call_home": false,
    "name": "bne-7004-backup",
    "address": "1.2.3.4",
    "username": "root",
    "password": "default",
    "auto_approve": true
  }
}

      example3:

      {
  "enrollment": {
    "product": "generic",
    "name": "bne-7004-backup",
    "address": "1.2.3.4",
    "connection_method": "ssh",
    "username": "root",
    "password": "default",
    "auto_approve": true,
    "base_port": 2100,
    "port_count": 2,
    "port_labels": [
      "Port 1",
      "Port 2"
    ]
  }
}

      HTTP status code 202

      Enrollment initiated, but not yet complete. Client can poll for registration package using given UUID and enrollment package password.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "Enrollment initiated: new registration package will be available soon",
  "uuid": "{uuid}",
  "package_password": "{package_password}"
}

      HTTP status code 303

      Redirect to new node session

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "Redirecting to new node at {redirect-url}"
}

      HTTP status code 400

      Invalid request, or error with supplied data (eg. incorrect IP address)

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 500

      Unexpected error, including failure to start enrollment due to internal error.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 26,
      "text": "Duplicate 'name' fields with value 'test'",
      "args": {
        "value": "test",
        "uuid": "root-1-@nodes",
        "field": "name"
      },
      "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

      get post

      get

      Retrieve a list of node smart groups

      post

      Create a new node smart group

      Create a new node smart group

      Secured by token

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "smartgroup": {
    "name": "X9",
    "rights": {
      "delete": true,
      "modify": true
    },
    "query": "{\"type\": 2, \"fieldname\": \"config:blah\", \"oper\": 3, \"datatype\": 2}"
  }
}

      HTTP status code 200

      Smartgroup created successfully.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "smartgroup": {
    "id": "smart_groups_nodes_groups-4",
    "rights": {
      "delete": true,
      "modify": true
    },
    "name": "X9",
    "query": "{\"type\": 2, \"fieldname\": \"config:blah\", \"oper\": 3, \"datatype\": 2}"
  }
}

      HTTP status code 303

      Redirect to newly created smartgroup.

      HTTP status code 400

      Invalid request: body is not json or does 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get delete put

      get

      Retrieve the details for a smart group.

      delete

      Delete a smart group.

      put

      Updates the details for a smart group.

      Retrieve the details for a smart group.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • groupId: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Group exists

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "smartgroup": {
    "id": "smart_groups_node_groups-1",
    "name": "X",
    "query": "{\"type\": 2, \"fieldname\": \"config:blah\", \"oper\": 3, \"datatype\": 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      example2:

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

      HTTP status code 404

      Smartgroup does not exist

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Delete a smart group.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • groupId: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The group was deleted succesfully.

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Smartgroup does not exist

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Updates the details for a smart group.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • groupId: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "smartgroup": {
    "name": "X9",
    "query": "{\"type\": 2, \"fieldname\": \"config:blah\", \"oper\": 3, \"datatype\": 2}"
  }
}

      HTTP status code 200

      Succesfully updated

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "smartgroup": {
    "id": "smart_groups_node_groups-1",
    "name": "X",
    "query": "{\"type\": 2, \"fieldname\": \"config:blah\", \"oper\": 3, \"datatype\": 2}"
  }
}

      HTTP status code 400

      Request data was not valid or incomplete

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Smartgroup does not exist

      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

      get

      get

      Download the system manifest file

      get put delete

      get

      Find a node by unique ID

      put

      Update a node

      delete

      Delete (unenroll) a node.

      Find a node by unique ID

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The requested node

      Body

      Media type: application/json

      Type: object

      Properties
      • node: required (object)
        • status: required (one of Enrolled, Registering, Registered, Unknown, Pending)
        • name: required (string)
        • id: required (string)
        • lhvpn_address: required (string)
        • runtime_status: required (object)
          • change_time: required (integer)
          • action_status: required (one of in progress, finished, error, unknown)
          • id: required (string)
          • action_type: required (one of registration, enrollment, none)
          • connection_status: required (one of connected, pending, disconnected, unknown, never seen)
          • action_error_message: required (string)
        • tag_list: required (object)
          • id: required (string)
          • rights: required (object)
            • create: (boolean)
            • delete: required (boolean)
            • modify: required (boolean)
          • tags: required (array of items)

            Items: items

            • id: required (string)
            • name: required (string)
            • value: required (string)
        • rights: required (object)
          • create: (boolean)
          • delete: required (boolean)
          • modify: required (boolean)
        • model: required (string)
        • firmware_version: required (string)
        • mac_address: required (string)
        • serial_number: required (string)
        • enrollment_bundle: required (string)
        • interfaces: required (array of items)

          Items: items

          • name: required (string)
          • ipv4_addr: required (string)
          • ipv6_addr: required (string)

      Example:

      {
  "node": {
    "name": "test1",
    "id": "nodes-1",
    "lhvpn_address": "192.168.128.2",
    "runtime_status": {
      "change_time": 1471950616,
      "action_status": "in progress",
      "id": "nodes-1",
      "action_error_message": "",
      "action_type": "registration",
      "connection_status": "never seen"
    },
    "tag_list": {
      "id": "nodes-1",
      "tags": [
        {
          "id": "nodes_tags-4",
          "name": "Location",
          "value": "Hong Kong"
        }
      ],
      "rights": {
        "create": true,
        "modify": true,
        "delete": true
      }
    },
    "rights": {
      "delete": false,
      "modify": true
    },
    "status": "Registering",
    "enrollment_bundle": "Global",
    "mac_address": "00:13:c6:02:47:99",
    "serial_number": "70000002451668",
    "model": "ACM7004-5-LMR",
    "interfaces": [],
    "firmware_version": "4.0.0"
  }
}

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      example2:

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

      HTTP status code 404

      Node does not exist

      HTTP status code 500

      Unexpected error

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update a node

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • node: required (object)
        • name: required (string)
        • mac_address: required (string)
        • description: required (string)
        • approved: required (integer)
        • tags: required (array of items)

          Items: items

          • id: required (string)
          • name: required (string)
          • value: required (string)

      Example:

      {
  "node": {
    "name": "test1",
    "mac_address": "AA:BB:CC:DD:EE:FF",
    "description": "Test Node",
    "approved": 0,
    "tags": [
      {
        "id": "nodes_tags-4",
        "name": "Location",
        "value": "Hong Kong"
      }
    ]
  }
}

      HTTP status code 200

      The updated node

      Body

      Media type: application/json

      Type: object

      Properties
      • node: required (object)
        • status: required (one of Enrolled, Registering, Registered, Unknown, Pending)
        • name: required (string)
        • id: required (string)
        • lhvpn_address: required (string)
        • runtime_status: required (object)
          • change_time: required (integer)
          • action_status: required (one of in progress, finished, error, unknown)
          • id: required (string)
          • action_type: required (one of registration, enrollment, none)
          • connection_status: required (one of connected, pending, disconnected, unknown, never seen)
          • action_error_message: required (string)
        • tag_list: required (object)
          • id: required (string)
          • rights: required (object)
            • create: (boolean)
            • delete: required (boolean)
            • modify: required (boolean)
          • tags: required (array of items)

            Items: items

            • id: required (string)
            • name: required (string)
            • value: required (string)
        • rights: required (object)
          • create: (boolean)
          • delete: required (boolean)
          • modify: required (boolean)
        • model: required (string)
        • firmware_version: required (string)
        • mac_address: required (string)
        • serial_number: required (string)
        • enrollment_bundle: required (string)
        • interfaces: required (array of items)

          Items: items

          • name: required (string)
          • ipv4_addr: required (string)
          • ipv6_addr: required (string)

      Example:

      {
  "node": {
    "name": "test1",
    "id": "nodes-1",
    "lhvpn_address": "192.168.128.2",
    "runtime_status": {
      "change_time": 1471950616,
      "action_status": "in progress",
      "id": "nodes-1",
      "action_error_message": "",
      "action_type": "registration",
      "connection_status": "never seen"
    },
    "tag_list": {
      "id": "nodes-1",
      "tags": [],
      "rights": {
        "create": true,
        "modify": true,
        "delete": true
      }
    },
    "rights": {
      "delete": false,
      "modify": true
    },
    "status": "Registering",
    "enrollment_bundle": "Global",
    "mac_address": "00:13:c6:02:47:99",
    "serial_number": "70000002451668",
    "model": "ACM7004-5-LMR",
    "interfaces": [],
    "firmware_version": "4.0.0"
  }
}

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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 (unenroll) a node.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 204

      The node was deleted successfully.

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get

      get

      Retrieve the enrollment package for a node.

      Retrieve the enrollment package for a node.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The requested enrollment package

      Body

      Media type: application/json

      Type: object

      Properties
      • cert: required (string)
      • key: required (string)
      • ca: required (string)
      • address: required (string)
      • ignore_date_header: required (boolean)

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      example2:

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

      HTTP status code 404

      Node does not exist

      HTTP status code 500

      Registration package not available for this node

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 45,
      "text": "Registration package is not currently available for this node",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      get post

      Each node can have a list of tags associated with it. These tags are references to a global list of tags, allowing for the grouping of nodes. For example one can group nodes into geographical location by assigning multiple nodes with a tag (tag="Location", value="New York").

      get

      Get the list of all tags associated with this node.

      post

      Create and associate a new tag with the node. If the tag exists update or set the value. If no value is given, or the value is emplty, the value will be set to null.

      Get the list of all tags associated with this node.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The requested enrollment package

      Body

      Media type: application/json

      Type: object

      Properties
      • tags: required (array of items)

        Items: items

        • id: required (string)
        • name: required (string)
        • value: required (string)

      Example:

      {
  "tags": [
    {
      "id": "nodes_tags-1",
      "name": "myTag",
      "value": "my tag value"
    },
    {
      "id": "nodes_tags-2",
      "name": "myTag2",
      "value": ""
    },
    {
      "id": "nodes_tags-3",
      "name": "myTag3",
      "value": "another value"
    }
  ]
}

      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)

      Examples:

      example1:

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

      example2:

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

      HTTP status code 404

      Node does not exist.

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Create and associate a new tag with the node. If the tag exists update or set the value. If no value is given, or the value is emplty, the value will be set to null.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • tag: required (object)
        • name: required (string)
        • value: required (string)

      Example:

      {
  "tag": {
    "name": "Location",
    "value": "New York"
  }
}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • tags: required (array of items)

        Items: items

        • id: required (string)
        • name: required (string)
        • value: required (string)

      Example:

      {
  "tags": [
    {
      "id": "nodes_tags-1",
      "name": "Location",
      "value": "New York"
    }
  ]
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: name item 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      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

      get delete put

      get

      Get a tag's information by ID.

      delete

      Delete a tag value from the node.

      put

      Update tag information for {node_tag_id} in node {id}

      Get a tag's information by ID.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1
      • tag_value_id: required (string)

        Identifier for unique tag within given node

        Example:

        nodes_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Tag information in node with {id} and tag identification {tag_value_id} successfully retrieved.

      Body

      Media type: application/json

      Type: object

      Example:

      example1:

      {
  "tag": {
    "id": "nodes_tags-1",
    "name": "Location",
    "value": "New York"
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: node id, or tag_value_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)

      Examples:

      example1:

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

      example2:

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

      HTTP status code 404

      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 tag value from the node.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1
      • tag_value_id: required (string)

        Identifier for unique tag within given node

        Example:

        nodes_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The {tag_value_id} tag information was deleted.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: node id, or tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      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": 5,
      "code": 29,
      "text": "Could not find element with UUID 'nodes_tags-0'",
      "args": {
        "uuid": "nodes_tags-0"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update tag information for {node_tag_id} in node {id}

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the node.

        Example:

        nodes-1
      • tag_value_id: required (string)

        Identifier for unique tag within given node

        Example:

        nodes_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • tag: required (object)
        • name: required (string)
        • value: required (string)

      Example:

      {
  "tag": {
    "name": "Location",
    "value": "USA.NewYork"
  }
}

      HTTP status code 200

      The {tag_value_id} tag information was updated.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: node id, or tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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)

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'nodes_tags-0'",
      "args": {
        "uuid": "nodes_tags-0"
      },
      "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

      get

      get

      Obtain a list of node ids, for example /nodes/ids?config:name=test.

      Any number of search query parameters can be provided to perform an ANDed search on the nodes. The parameters possible should be retrieved with GET /nodes/fields. The list provided is dynamic.

      The standard ember-data pagination fields {per_page} and {page} apply to this list.

      {per_page} and {page} are optional but both are to be supplied if pages are requested.

      get

      get

      Obtain a list of fields which can be used to perform queries against nodes.

      get

      get

      Retrieve a list of all ports belonging to a node.

      Retrieve a list of all ports belonging to a node.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The list of ports belonging to the node

      Body

      Media type: application/json

      Type: object

      Properties
      • ports: required (array of getPortByIdResponse)

        Items: getPortByIdResponse

        • webshell_enabled: required (boolean)
        • port_csid: required (string)
        • mode: required (one of disabled, localConsole, consoleServer, sdtServer, bridge, terminalServer, reserved, powerman, unknown)
        • proxied_ssh_url: required (string)

          URI to ssh to a port on a Lighthouse-enrolled node

          Example:

          ssh://username:consoleserver:portnumber@lhip
        • runtime_status: required (object)
          • change_time: required (integer)
          • change_delta: required (integer)
          • action_status: required (one of in progress, finished, error, unknown)
          • id: required (string)
          • action_type: required (one of registration, enrollment, none)
          • connection_status: required (one of connected, pending, disconnected, unknown, never seen)
          • action_error_message: (string)
        • ssh_enabled: required (boolean)
        • label: required (string)
        • id: required (string)
        • web_terminal_url: required (string)
        • node_name: required (string)
      • meta: required (object)
        • searchId: (string)
        • total_pages: required (integer)

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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

      /ports

      Used for working with port information.

      get

      get

      Gets ports attached to this lighthouse instance.

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

      The standard ember-data pagination fields {per_page} and {page} apply to this list.

      {per_page} and {page} are optional but both are to be supplied if pages are requested.

      get

      get

      Retrieve a single port by ID.

      Retrieve a single port by ID.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Returns properties for a single port.

      Body

      Media type: application/json

      Type: object

      Properties
      • webshell_enabled: required (boolean)
      • port_csid: required (string)
      • mode: required (one of disabled, localConsole, consoleServer, sdtServer, bridge, terminalServer, reserved, powerman, unknown)
      • proxied_ssh_url: required (string)

        URI to ssh to a port on a Lighthouse-enrolled node

        Example:

        ssh://username:consoleserver:portnumber@lhip
      • runtime_status: required (object)
        • change_time: required (integer)
        • change_delta: required (integer)
        • action_status: required (one of in progress, finished, error, unknown)
        • id: required (string)
        • action_type: required (one of registration, enrollment, none)
        • connection_status: required (one of connected, pending, disconnected, unknown, never seen)
        • action_error_message: (string)
      • ssh_enabled: required (boolean)
      • label: required (string)
      • id: required (string)
      • web_terminal_url: required (string)
      • node_name: required (string)

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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

      Used to perform searches on nodes and ports on the system.

      get

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

      get

      Gets a search ID for searching nodes attached to this lighthouse instance. Any number of search query parameters can be provided to perform an ANDed search on the nodes. The parameters possible should be retrieved with GET /nodes/fields. The list provided is dynamic.

      get

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

      get

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

      /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 put

      get

      Requests config parameters related to the Console Gateway service.

      put

      Update config parameters related to the Console Gateway service.

      /tags

      Tags are a user definable set of name/value pairs which can be assigned to Lighthouse system objects like nodes.

      get post

      Provides the ability to retrieve and manipulate all tags associated with Lighthouse nodes.

      get

      Returns the global tag list and associated values. Each associated name/value pair can be referenced from any node by using nodes/:id/tags/:tag_value_id.

      post

      Create a global node tag

      Create a global node tag

      Secured by token

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • nodeTag: required (object)
        • name: required (string)
        • values: required (array of )

      Example:

      {
  "nodeTag": {
    "name": "Location",
    "values": [
      {
        "value": "USA.NewYork"
      },
      {
        "value": "UK.London"
      }
    ]
  }
}

      HTTP status code 200

      The newly created global tag.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "nodeTag": {
    "id": "tags_node_tags-50",
    "name": "Location",
    "values": [
      {
        "id": "tags_node_tags_values_90",
        "value": "USA.NewYork"
      },
      {
        "id": "tags_node_tags_values_91",
        "value": "UK.London"
      }
    ]
  }
}

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      put delete

      put

      Update tag values for the given id.

      delete

      Delete a tag by id.

      Update tag values for the given id.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • tag_value_id: required (string)

        Identifier for unique tag

        Example:

        nodes_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • nodeTag: required (object)
        • name: required (string)
        • values: required (array of )

      Example:

      {
  "nodeTag": {
    "name": "Location",
    "values": [
      {
        "id": "tags_node_tags_values_90",
        "value": "USA.NewYork"
      },
      {
        "id": "tags_node_tags_values_91",
        "value": "UK.London"
      },
      {
        "value": "France.Paris"
      }
    ]
  }
}

      HTTP status code 200

      The tag information was updated.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: node id, or tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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 tag by id.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • tag_value_id: required (string)

        Identifier for unique tag

        Example:

        nodes_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The {tag_value_id} tag information was deleted.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      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": 5,
      "code": 29,
      "text": "Could not find element with UUID 'nodes_tags-0'",
      "args": {
        "uuid": "nodes_tags-0"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /interfaces

      Read and manipulate the network interfaces on the Lighthouse server.

      get

      get

      Get a list of the network interfaces on the Lighthouse server.

      get put

      get

      Get interface information by id.

      put

      Update settings for interface {id}

      Get interface information by id.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the interface to fetch

        Example:

        system_net_conns-2

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Properties
      • interface: required (object)
        • role: required (string)
        • description: required (string)
        • address: (string)
        • physif: required (string)
        • name: required (string)
        • mode: required (string)
        • gateway: (string)
        • runtime_status: (object)
          • status: required (string)
          • last_status_change: required (number)
          • id: required (string)
        • id: (string)
        • netmask: (string)
        • enabled: required (boolean)
        • media: required (string)

      Example:

      {
  "interface": {
    "enabled": true,
    "description": "Default static network connection",
    "media": "auto",
    "netmask": "255.255.255.0",
    "physif": "net1",
    "role": "lan",
    "name": "default-conn-1",
    "address": "192.168.87.156",
    "gateway": "192.168.87.100",
    "mode": "static",
    "runtime_status": {
      "status": "running",
      "last_status_change": 1471506633,
      "id": "system_net_conns-1"
    },
    "id": "system_net_conns-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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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 interface {id}

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of the interface to fetch

        Example:

        system_net_conns-2

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • interface: required (object)
        • role: required (string)
        • description: required (string)
        • address: (string)
        • physif: required (string)
        • name: required (string)
        • mode: required (string)
        • gateway: (string)
        • runtime_status: (object)
          • status: required (string)
          • last_status_change: required (number)
          • id: required (string)
        • id: (string)
        • netmask: (string)
        • enabled: required (boolean)
        • media: required (string)

      Example:

      {
  "interface": {
    "enabled": true,
    "description": "Default static network connection",
    "media": "auto",
    "netmask": "255.255.255.0",
    "physif": "net1",
    "role": "lan",
    "name": "default-conn-1",
    "address": "192.168.87.156",
    "gateway": "192.168.87.100",
    "mode": "static"
  }
}

      HTTP status code 200

      The interface {id} settings was updated.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: interface 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Interface {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

      /system

      System endpoints are related to configuring and accessing information about the Lighthouse system itself.

      get put

      Retrieve or change the Lighthouse system's hostname.

      get

      Get the Lighthouse hostname.

      put

      Update the Lighthouse hostname.

      get put

      Retrieve or change the Lighthouse session timeout.

      get

      Retrieve the session timeout (in minutes).

      put

      Update the session timeout (in minutes).

      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

      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 Lighthouse system's externally reachable network address.

      get

      Retrieve the Lighthouse external address.

      put

      Update the Lighthouse external address.

      get put

      Retrieve and update the Lighthouse server's time.

      get

      Retrieve the Lighthouse current time.

      put

      Update the Lighthouse current time.

      delete

      delete

      Delete the configuration effectively performing a system reset. The Lighthouse host 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

      Lighthouse 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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 entitlement information for the Lighthouse based on the licenses applied.

      get

      Retrieve a list of entitlements.

      get post

      Create and view licenses applied to the Lighthouse system.

      get

      Retrieve a list of license strings.

      post

      Apply a list of licenses.

      Apply a list of licenses.

      Secured by token

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Properties
      • licenses: required (array of items)

      Example:

      {
  "licenses": [
    {
      "raw": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im1pY2hhZWxmQGZpdHp5c2l0ZS5jb20iLCJzdWIiOiJ..."
    },
    {
      "raw": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im1pY2hhZWxmQGZpdHp5c2l0ZS5jb20iLCJzdWIiOiJ..."
    }
  ]
}

      HTTP status code 201

      A JSON object containing the raw licenses that were just applied.

      Body

      Media type: application/json

      Type: object

      Properties
      • licenses: required (array of items)

      Example:

      {
  "licenses": [
    {
      "id": 1,
      "raw": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im1pY2hhZWxmQGZpdHp5c2l0ZS5jb20iLCJzdWIiOiJ..."
    },
    {
      "id": 2,
      "raw": "eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im1pY2hhZWxmQGZpdHp5c2l0ZS5jb20iLCJzdWIiOiJ..."
    }
  ]
}

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /stats

      Retrieve statistical information about the Lighthouse deployment.

      get

      get

      A summary of connected, pending and disconnected nodes

      /support_report

      Obtain a report which will provide information about the state of the Lighthouse server. 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.

      /bundles

      Creating/registering and viewing the state of console server bundles.

      get post

      get

      Gets bundles attached to this lighthouse instance.

      The standard ember-data pagination fields {per_page} and {page} apply to this list.

      {per_page} and {page} are optional but both are to be supplied if pages are requested. A bundle response will also contain a list of tags, which represents the user-editable attributes assigned to this bundle.

      post

      Add a new Bundle. The automatic_tags values must be valid as obtained using by a GET on endpoint /tags/node_tags.

      Add a new Bundle. The automatic_tags values must be valid as obtained using by a GET on endpoint /tags/node_tags.

      Secured by token

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "bundle": {
    "name": "PrimaryBundle",
    "auto_approve": true,
    "token": "ABCD1234567",
    "automatic_tags": [
      {
        "name": "Location",
        "value": "Brisbane"
      }
    ]
  }
}

      HTTP status code 200

      Bundle added successfully.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "bundle": {
    "name": "Test Bundle 1",
    "auto_approve": 0,
    "id": "enrollment_bundles-1",
    "automatic_tags": [
      {
        "id": "enrollment_bundles_automatic_tags-1",
        "name": "Test Tag Key 1",
        "value": "Test Tag Value 1"
      },
      {
        "id": "enrollment_bundles_automatic_tags-2",
        "name": "Test Tag Key 2",
        "value": "Test Tag Value 2"
      }
    ],
    "nodes": [],
    "token": "abcdefghijklmnop"
  }
}

      HTTP status code 400

      Invalid request, or error with supplied 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)

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      Redirect to new bundle session

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "message": "Redirecting to new bundle at {redirect-url}"
}

      HTTP status code 500

      Unexpected error.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "error": [
    {
      "type": 2,
      "code": 26,
      "text": "Duplicate 'name' fields with value 'test'",
      "args": {
        "value": "test",
        "uuid": "root-1-@bundles",
        "field": "name"
      },
      "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

      get put

      get

      Find a bundle by unique ID

      put

      Update a bundle

      Find a bundle by unique ID

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The requested bundle

      Body

      Media type: application/json

      Type: object

      Properties
      • bundle: required (object)
        • id: required (string)
        • name: required (string)
        • auto_approve: required (boolean)
        • token: required (string)
        • automatic_tags: required (array of items)

          Items: items

          • id: required (string)
          • name: required (string)
          • value: required (string)
        • nodes: required (array of items)
        • manifest_link: required (string)

      Example:

      {
  "bundle": {
    "name": "Test Bundle 1",
    "auto_approve": false,
    "id": "enrollment_bundles-1",
    "automatic_tags": [
      {
        "id": "enrollment_bundles_automatic_tags-1",
        "name": "Test Tag Key 1",
        "value": "Test Tag Value 1"
      },
      {
        "id": "enrollment_bundles_automatic_tags-2",
        "name": "Test Tag Key 2",
        "value": "Test Tag Value 2"
      }
    ],
    "nodes": [],
    "token": "abcdefghijklmnop",
    "manifest_link": "/api/v1/bundles/enrollment_bundles-1/manifest"
  }
}

      HTTP status code 400

      Invalid request, or error with supplied 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)

      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)

      Examples:

      example1:

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

      example2:

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

      HTTP status code 404

      Bundle does not exist

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update a bundle

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "bundle": {
    "name": "PrimaryBundle",
    "auto_approve": true,
    "token": "BCDEFGHIJKLMNOPQRSTUVWXYZ123456",
    "automatic_tags": [
      {
        "name": "Location",
        "value": "Brisbane"
      }
    ]
  }
}

      HTTP status code 200

      The updated bundle

      Body

      Media type: application/json

      Type: object

      Properties
      • bundle: required (object)
        • id: required (string)
        • name: required (string)
        • auto_approve: required (boolean)
        • token: required (string)
        • automatic_tags: required (array of items)

          Items: items

          • id: required (string)
          • name: required (string)
          • value: required (string)
        • nodes: required (array of items)
        • manifest_link: required (string)

      Example:

      {
  "bundle": {
    "name": "PrimaryBundle",
    "auto_approve": true,
    "id": "enrollment_bundles-3",
    "automatic_tags": [
      {
        "id": "enrollment_bundles_automatic_tags-4",
        "name": "Location",
        "value": "Brisbane"
      }
    ],
    "nodes": [],
    "token": "BCDEFGHIJKLMNOPQRSTUVWXYZ123456",
    "manifest_link": ""
  }
}

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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

      get post

      Each bundle can have a list of tags associated with it. These tags are references to a global list of tags. Any node that enrolls against a specific bundle will automatically be assigned these tags and specified values at time of enrollment.

      get

      Get the list of all automatic tags for this bundle.

      post

      Create and associate a new tag with the bundle. If the tag exists update or set the value. If no value is given, or the value is empty, the value will be set to null.

      Get the list of all automatic tags for this bundle.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The list of automatic tags for the bundle

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "tags": [
    {
      "id": "bundle_tags-1",
      "name": "myTag",
      "value": "my tag value"
    },
    {
      "id": "bundle_tags-2",
      "name": "myTag2",
      "value": ""
    },
    {
      "id": "bundle_tags-3",
      "name": "myTag3",
      "value": "another value"
    }
  ]
}

      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)

      Examples:

      example1:

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

      example2:

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

      HTTP status code 404

      Bundle does not exist.

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Create and associate a new tag with the bundle. If the tag exists update or set the value. If no value is given, or the value is empty, the value will be set to null.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "tag": {
    "name:\"Location\"": null,
    "value": "New York"
  }
}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "automatic_tag": {
    "id": "bundle_tags-1",
    "name": "Location",
    "value": "New York"
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: name item 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      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

      get delete put

      get

      Retrieves a bundle's tag by id.

      delete

      Delete a bundle's tag by id.

      put

      Update tag information for {bundle_tag_id} in bundle {id}

      Retrieves a bundle's tag by id.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1
      • tag_value_id: required (string)

        Identifier for unique tag within given bundle

        Example:

        bundles_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      Tag information in bundle with {id} and tag identification {tag_value_id} successfully retrieved.

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "automatic_tag": {
    "id": "bundle_tags-1",
    "name": "Location",
    "value": "New York"
  }
}

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: bundle id, or tag_value_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)

      Examples:

      example1:

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

      example2:

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

      HTTP status code 404

      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 bundle's tag by id.

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1
      • tag_value_id: required (string)

        Identifier for unique tag within given bundle

        Example:

        bundles_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The {tag_value_id} tag information was deleted.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: bundle id, or tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      HTTP status code 404

      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": 5,
      "code": 29,
      "text": "Could not find element with UUID 'bundles_tags-0'",
      "args": {
        "uuid": "bundles_tags-0"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      Update tag information for {bundle_tag_id} in bundle {id}

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1
      • tag_value_id: required (string)

        Identifier for unique tag within given bundle

        Example:

        bundles_tags-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "automatic_tag": {
    "name": "Location",
    "value": "USA.NewYork"
  }
}

      HTTP status code 200

      The {tag_value_id} tag information was updated.

      HTTP status code 400

      Invalid request: body is not json or does not conform to required json schema. Incomplete data: bundle id, or tag_value_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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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)

      Example:

      {
  "error": [
    {
      "type": 5,
      "code": 29,
      "text": "Could not find element with UUID 'bundles_tags-0'",
      "args": {
        "uuid": "bundles_tags-0"
      },
      "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

      get

      get

      Download the bundle specific manifest file

      Download the bundle specific manifest file

      Secured by token

      Lighthouse base authentication scheme

      URI Parameters

      • id: required (string)

        ID of bundle to fetch

        Example:

        enrollment_bundles-1

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      HTTP status code 200

      The manifest file

      Body

      Media type: text/plain

      Type: object

      Example:

      address=192.168.0.1 bundle=bundle1 password=bundle1Token

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      example2:

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

      HTTP status code 404

      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": 5,
      "code": 29,
      "text": "Could not find element with UUID 'enrollment_bundles-1'",
      "args": {
        "uuid": "enrollment_bundles-1"
      },
      "level": 1
    }
  ]
}

      Secured by token

      Headers

      • Authorization: required (string)

        authorization session token

        Example:

        Token 521a00e57d4a461b3e4bb0c55166f97c

      /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

      Lighthouse base authentication scheme

      Headers

      • Authorization: required (string)

        Example:

        Token {{sessionUid}}

      Body

      Media type: application/json

      Type: object

      Example:

      {
  "user": {
    "username": "usernamenew",
    "password": "testPassword",
    "description": "desc",
    "enabled": true,
    "groups": [
      "groups-1"
    ]
  }
}

      HTTP status code 200

      Body

      Media type: application/json

      Type: object

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

      Example:

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

      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

      Lighthouse 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)
        • id: required (string)
        • username: required (string)
        • description: required (string)
        • enabled: required (boolean)
        • rights: required (object)
          • create: (boolean)
          • delete: required (boolean)
          • modify: required (boolean)
        • groups: required (array of )

      Example:

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

      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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

      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

      Lighthouse 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)

        Example:

        {
  "user": {
    "username": "usernamenew",
    "password": "UpdatedPassword",
    "description": "Updated description",
    "groups": [
      "groups-1",
      "groups-2"
    ],
    "enabled": true
  }
}

        HTTP status code 200

        User has been Updated.

        Body

        Media type: application/json

        Type: object

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

        Example:

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

        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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

        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

        Lighthouse base authentication scheme

        URI Parameters

        • id: required (string)

        Headers

        • Authorization: required (string)

          Example:

          Token {{sessionUid}}

        HTTP status code 200

        User deleted

        Body

        Media type: application/json

        Type: object

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

        Example:

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

        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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

        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

        Lighthouse base authentication scheme

        Headers

        • Authorization: required (string)

          Example:

          Token {{sessionUid}}

        Body

        Media type: application/json

        Example:

        {
  "group": {
    "groupname": "my_node_group",
    "description": "to hold the node admin users",
    "mode": "smart_group",
    "smart_group_roles": "NodeAdmin",
    "smart_group": "nodes_groups_1"
  }
}

        HTTP status code 201

        Body

        Media type: application/json

        Example:

        {
  "group": {
    "id": "groups-4",
    "groupname": "netgrp",
    "mode": "smart_group",
    "members": [],
    "smart_group_roles": "NodeAdmin",
    "smart_group": "my_smartgroup",
    "rights": {
      "modify": true,
      "delete": true
    }
  }
}

        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,
      "text": "Duplicate 'groupname' fields with value 'netgrp'",
      "args": {
        "value": "netgrp",
        "uuid": "root-1-@groups",
        "field": "groupname"
      },
      "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 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

        Lighthouse 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

        Example:

        {
  "group": {
    "groupname": "netgrp2",
    "id": "groups-6",
    "mode": "global",
    "members": [],
    "global_roles": "NodeUser",
    "rights": {
      "delete": false,
      "modify": true
    }
  }
}

        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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

        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

        Lighthouse base authentication scheme

        URI Parameters

        • id: required (string)

        Headers

        • Authorization: required (string)

          Example:

          Token {{sessionUid}}

        Body

        Media type: application/json

        Example:

        {
  "group": {
    "groupname": "netgrp2",
    "description": "my new description",
    "mode": "global",
    "global_roles": "NodeUser"
  }
}

        HTTP status code 200

        Group has been updated.

        Body

        Media type: application/json

        Example:

        {
  "group": {
    "groupname": "netgrp2",
    "description": "my new description",
    "id": "groups-6",
    "mode": "global",
    "members": [],
    "global_roles": "NodeUser",
    "rights": {
      "delete": false,
      "modify": true
    }
  }
}

        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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

        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

        Lighthouse 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,
      "text": "Invalid session ID",
      "args": {},
      "level": 1
    }
  ]
}

        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