Nuix SDK – Nuix REST SDK

Getting Started: Installing Nuix RESTful Service

Thu, 18 Jun 2020 00:00:00 +0000

Use the details and instructions in the following topics to download and install Nuix RESTful Service. The installer itself is a wizard-based program that provides on screen guidance to help you through the installation steps.

The key topics covered in this guide are:

System Requirements
Installing Nuix RESTful Service
Configuration setup
Locating API documentation

For any concerns regarding installation, use, or licensing of the Nuix RESTful Service, or if you require further information, contact the Nuix support team at https://nuix.service-now.com/support.

System Requirements

Before you begin using Nuix RESTful Service, it is important to properly install and configure any additional required software. System requirements as well as detailed instructions for installing and configuring Nuix RESTful Service are included within this guide.

Hardware Requirements

The hardware configurations described in the following table are recommended for Nuix RESTful Service.

Size	System Requirements	Tomcat + JVM memory	Workers	OS Memory
Small	Laptop with 16 GB RAM, Dual Core processor SSD	6 GB	2, each with 3 GB memory	4 GB
Medium	Workstation with 32 GB RAM, Quad Core processor, 15 K RPM or SSD drives	8 GB	4, each with 5 GB memory	4 GB
Large	Server with 96-256 GB RAM, Quad core processor, 15 K RPM or SSD drives	20-60 GB	8, each with 8-16 GB memory	4 GB

Software Requirements

The following software is required:

Licensing:
- Nuix Management Server (NMS) 9.4.0 or above for server-based licensing.
  - Download here: https://download.nuix.com/releases/server
  - Refer to the Installing Management Server section of the Nuix Management Server User Guide for installation instructions.
- Nuix Cloud License Server (CLS) https://my.nuix.com
Optional: Nuix OCR Add-on using ABBYY to enable Optical Character Recognition.
- Available for download at https://download.nuix.com/releases/addons
- Note: If Installing on Windows, the Microsoft Visual C++ 2010 Redistributable Package (x64) must be installed prior to installing the Nuix OCR Add-on.
Optional: Microsoft Office 2007/2010 to enable image rendering if you prefer not to use the Nuix internal rendering engine.

Operating System Support

Nuix RESTful Service supports the latest versions of each of the following operating systems.

Operating System	Version
Microsoft Windows 64-bit	Windows 10
	Windows Server 2019
	Windows Server 2016 R2
Debian	9
Ubuntu	18.04 LTS
	16.04 LTS

Authentication prerequisites

Nuix RESTful Service only supports Basic authentication. Refer to the following prerequisites when configuring NMS.

Note

NTLM authentication is not supported.

Nuix Management Server:
- Install Nuix Management Server (NMS) version 9.4.0 or later.
- Ensure that the Authentication mode is set to Basic built-in form authentication.
- Ensure that the NMS instance is broadcasting on the same address from which clients, including Nuix RESTful Service, will access it.
- Create an admin user in NMS for basic authentication.
- Ensure that licenses are enabled for users and groups that request licenses through Nuix RESTful services.

To purchase a license, contact sales@nuix.com for more information.

Getting Started: Configuring Nuix RESTful Service

Thu, 29 Jul 2021 00:00:00 +0000

Getting Started: Quick Start Guides

Thu, 22 Apr 2021 00:00:00 +0000

The topics in this section provide instructions, guidance, and examples for accessing and using the core features of the Nuix RESTful API. For each endpoint described within this guide, instructions are provided using simple cURL commands. Any tool capable of making HTTP calls, such as Postman, can be used to achieve the same results.

Use the API reference documentation embedded in your instance of Nuix RESTful Service, localhost:8080/nuix-restful-service/svc/docs, to supplement the instructions in these guides.

Getting Started: Introduction to Nuix RESTful Service

Tue, 09 Feb 2021 00:00:00 +0000

Complete API documentation is available at https://nuix.github.io/REST-API-Docs/index.html.

The documentation is also availabe on your local installation at: http://localhost:8080/nuix-restful-service/svc/docs

For any concerns regarding use, licensing, or if you require further information, contact the Nuix support team at https://nuix.service-now.com/support.

Getting Started: User Scripts

Mon, 11 Jan 2021 00:00:00 +0000

Getting Started: Ingesting from Microsoft Office 365

Tue, 21 Jul 2020 00:00:00 +0000

Nuix provides a connector to support the ingestion of Microsoft Office 365 data into a Nuix case. Using the Nuix connector endpoint in conjunction with your Microsoft tenant and the Microsoft Graph API, you can now access data from the following Office 365 applications:

Teams
- Threaded channel and private messages
- Attachments
- Calendars
Exchange
- Email
- Contacts
SharePoint
- Sites
- Subsites
- Lists (Retrieval of list attachments is not supported.)

Before you Begin

Before you get started, ensure that the following prerequisites are met:

A Microsoft Azure account
- Note: Initial tenant configuration must be performed by an Azure user with Global Administrator privileges.
Access to a Microsoft Office 365 instance within the Azure tenant.
Nuix RESTful Service
- Version 9.4 or later
Valid Nuix licensing with data processing capabilities.
- For example: eDiscovery Workstation or Investigation and Response license types

About this Guide

This guide includes the following topics which outline the requirements and steps necessary to connect to and ingest from Microsoft Office 365.

Getting Started: Release Notes

Tue, 27 Jul 2021 00:00:00 +0000