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

The Collection Configuration API from Nuix — 2 operation(s) for collection configuration.

Nuix Collection Configuration 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 Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 16 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 2 paths 16 schemas 1 DELETE1 GET1 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 Configuration 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 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Collection Configuration 3
GET
/v2/configurations
Lists all Collection Configurations
listConfigurations 2 params → 200400504
POST
/v2/configurations
Creates a new Collection Configuration based on an existing Collection Configuration
createConfiguration body → 200400
DELETE
/v2/configurations/{id}
Delete the Configuration
deleteConfiguration 1 param → 200400504

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are TaskToCreate (13 properties), Task (12 properties), Configuration (9 properties), Evidence (9 properties). Each schema is shown below with its type and property counts.

standardResponse
object
3 properties
Hash
object
3 properties
createConfigurationResponse
object
8 properties
Configuration
object
9 properties
FileType
object
describes the file type filters used in the collection (this object is optional)
3 properties
Evidence
object
9 properties
TaskCreated
object
4 properties
Task
object
12 properties
TargetInputs
object
3 properties
TaskToCreate
object
13 properties
Target
object
7 properties
Extension
object
Describes a File Extension
2 properties
Keyword
object
4 properties
listConfigurationsResponse
object
1 property
createConfigurationRequest
object
5 properties
DateCriteria
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuix-collection-configuration-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 Computer API
Nuix Computer Configuration API
Nuix Custodian API
Nuix Group API
Nuix Job API
Nuix Log API
Nuix Target API
Nuix Utility API