Checking Server Status

Verify if your instance of Nuix RESTful Service is running.

  less than a minute  

Before you make any calls to the Nuix RESTful Service API, you should verify 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-server",
 "startupTime" : null,
 "nuixRestfulVersion" : null,
 "engineVersion" : null
}

If the service is available, you should expect to see response similar to this example.