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

The Job API from Nuix — 3 operation(s) for job.

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

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

This API exposes 3 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.

3 operations 3 paths 5 schemas 1 GET2 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 Job 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 — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Job 3
GET
/v2/jobs/{id}
Display details of the specified job
jobDetails 1 param → 200400
POST
/v2/jobs
Lists all jobs that match the specified filter
listJobsByFilter 3 params body → 200
POST
/v2/jobAction/{id}
Modifies the state of the specified job
jobAction 1 param body → 200400

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are jobListDetail (22 properties), jobDetail (18 properties), listJobRequest (6 properties), standardResponse (3 properties). Each schema is shown below with its type and property counts.

standardResponse
object
3 properties
jobDetail
object
18 properties
jobListDetail
object
22 properties
jobActionRequest
object
1 property
listJobRequest
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuix-job-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 Log API
Nuix Target API
Nuix Utility API