REST API: Introduction

Document created by RSA Information Design and Development on Apr 10, 2019Last modified by RSA Information Design and Development on Aug 7, 2019
Version 3Show Document
  • View in full screen mode
 

The RESTful API that ships with NetWitness Platform is a way to programmatically communicate with the NEXTGEN architecture. It must be enabled by setting /rest/config/enabled to on, which is the default. The default port for communication is the default port + 100 (for example, on a Concentrator, the default port is 50005, and the REST API is on port 50105), but that can be changed by setting the /rest/config/port parameter. SSL is controled by the setting in /sys/config/ssl. For information about how to perform these tasks, see Access the RESTful API in NetWitness Platform.

The API is based on HTTP and is quite easy to use. The acceptable output formats are:

  • text/plain
  • text/xml
  • text/html
  • application/json

The content type that is returned can be controlled through the HTTP Accept header. It is possible to set the parameter force-content-type to one of the previous values.

The easiest way to begin is to point a browser to the REST port (for details about how to perform these tasks, see Access the RESTful API in NetWitness Platform):

PATH: http://<hostname or IP>:<REST port>

This command performs the default operation of ls, and returns a listing for the root node tree used by NEXTGEN:

The user interface that is shown above is enabled by default in all Version 10 and 11 deployments. The user interface with the dark background (shown below) is available in Version 11.3.1 and later, and must be enabled if you want to use it.

To enable the user interface with the dark background, set /rest/config/Enable WebSockets Interface (allow.websockets) to true and restart the service. You can change the user interface back to the light background by setting this parameter to false and restarting the service.

Next Topic:Usage
You are here
Table of Contents > Introduction

Attachments

    Outcomes