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 Collection and Survey API

The Collection and Survey API from Nuix — 4 operation(s) for collection and survey.

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

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

This API exposes 5 operations across 4 paths, and defines 12 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 4 paths 12 schemas 1 GET4 POST

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 Collection and Survey 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 4 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Collection and Survey 5
GET
/v2/collections
Lists all collections for the specified case
listCaseCollection 1 param → 200400
POST
/v2/collections
Launch a new collection by Custodian
launchCaseCollection body → 200400504
POST
/v2/collectionsByPath
Launch a new collection explicitly defining folders and files with no custodian.
launchCollectionsByPath body → 200400504
POST
/v2/collectionsByTarget
Launch a new collection specifying only target and collection configuration
launchCollectionsByTarget body → 200400504
POST
/v2/collectionsByConfiguration
Launch a new collection for a specific computer and Collection Configuration
launchCollectionsByConfiguration body → 200400504

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are launchCaseCollectionByPathRequest (10 properties), launchCaseCollectionByTargetRequest (5 properties), launchCaseCollectionRequest (5 properties), launchCaseCollectionByConfigurationRequest (5 properties). Each schema is shown below with its type and property counts.

standardResponse
object
3 properties
launchCaseCollectionResponse
object
2 properties
CollectionDetail
object
4 properties
launchCaseCollectionByConfigurationRequest
object
5 properties
launchCaseCollectionByPathRequest
object
10 properties
listCaseCollectionResponse
object
1 property
FolderSpec
object
4 properties
launchCaseCollectionRequest
object
5 properties
ComputerJobs
object
3 properties
JobCreated
object
4 properties
launchCaseCollectionByTargetRequest
object
5 properties
launchCaseCollectionByConfigurationResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuix-collection-and-survey-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 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