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 Case API

The Case API from Nuix — 3 operation(s) for case.

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

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

This API exposes 5 operations across 3 paths, and defines 5 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.

5 operations 3 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

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 Case API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Case 5
GET
/v2/cases
Lists all cases
listCasesAll → 200
POST
/v2/cases
Create a new case
createCase body → 200
GET
/v2/cases/{caseId}
Lists the specified case
listCases 1 param → 200
PUT
/v2/cases/{id}
Rename a case and-or change case status
modifyCase 1 param body → 200400504
DELETE
/v2/cases/{id}
Delete a case
deleteCase 1 param → 200400500504

Schemas 5

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

standardResponse
object
3 properties
Case
object
3 properties
createCaseRequest
object
2 properties
modifyCaseRequest
object
2 properties
listCasesResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuix-case-api-openapi.yml Raw ↑

Other APIs Nuix publishes across the network.

Nuix Core Engine REST API
Nuix Discover Connect 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
Nuix Utility API