Checking Server Status

Verify if your instance of Nuix RESTful Service is running.

Before making any calls to the Nuix RESTful Service API, it is best practice to first ensure that the service is running and available.

The Nuix RESTful Service server status can be checked using the following GET request to the /about endpoint.

curl -X GET "http://127.0.0.1:8080/nuix-restful-service/svc/about" -H "accept: application/vnd.nuix.v2+json"

{
 "server" : "http://localhost:8080/nuix-restful-service/svc",
 "serverId" : "rest-oem-server",
 "startupTime" : null,
 "nuixRestfulVersion" : null,
 "engineVersion" : null
}

If the service is available, a response similar to this example will be returned.

Note: In this example, some of the response values have returned null values. These values are intentionally not returned because the request was submitted without an authentication token.