Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuix Utility API

The Utility API from Nuix — 3 operation(s) for utility.

Nuix Utility API is one of 13 APIs that Nuix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Utility. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version ${customer.version}.

Requests are made against a single base URL, {protocol}://{address}:{port}/api/ecc.

3 operations 3 paths 3 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
${customer.version}
Base URL
https://localhost:4444
Authentication
HTTP Basic
Contact
License
Resource Areas
1

Authentication & Security 1

Nuix Utility API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Utility 3
GET
/v2/eccInstalled
Verify whether ECC Client or ECC Admin Console is installed on the specified computer.
eccInstalled 1 param → 200400
GET
/v2/license
Get ECC Server license information
getServerLicense → 200
GET
/v2/systemInfo
Get ECC Server system information
getServerInfo → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are systemInfoResponse (7 properties), licenseResponse (3 properties), standardResponse (3 properties). Each schema is shown below with its type and property counts.

standardResponse
object
3 properties
systemInfoResponse
object
7 properties
licenseResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuix-utility-api-openapi.yml Raw ↑

Other APIs Nuix publishes across the network.

Nuix Core Engine REST API
Nuix Discover Connect API
Nuix Case API
Nuix Collection and Survey API
Nuix Collection Configuration API
Nuix Computer API
Nuix Computer Configuration API
Nuix Custodian API
Nuix Group API
Nuix Job API
Nuix Log API
Nuix Target API