API Evangelist overlay for NUIX ECC REST API Command Reference Utility API

overlay: 1.0.0
info:
  title: API Evangelist overlay for NUIX ECC REST API Command Reference Utility API
  version: 1.0.0
extends: openapi/nuix-utility-api-openapi.yml
x-generated: '2026-10-21'
x-method: generated
x-source: openapi/nuix-utility-api-openapi.yml
x-rationale: Adds provenance, a link to the provider reference docs, and per-operation agent hints (read_only
  from GET, confirmation for DELETE/cancel/job actions) without editing the captured spec.
actions:
- target: $.info
  description: Record API Evangelist provenance without mutating the original.
  update:
    x-api-evangelist:
      provider: nuix
      generated: '2026-10-21'
      source: openapi/nuix-utility-api-openapi.yml
      deployment: Self-hosted. Nuix ships this API inside customer-installed software (Enterprise Collection
        Center server); there is no public multi-tenant host, so servers[] stays templated/local.
- target: $
  description: Link the provider-published reference documentation.
  update:
    externalDocs:
      description: Nuix developer documentation
      url: https://developer.nuix.com/latest/reference/eccapireference.html
- target: $.paths['/v2/eccInstalled'].get
  description: 'Agent hint for eccInstalled: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/v2/license'].get
  description: 'Agent hint for getServerLicense: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false
- target: $.paths['/v2/systemInfo'].get
  description: 'Agent hint for getServerInfo: derived from the HTTP method.'
  update:
    x-agent-hints:
      read_only: true
      requires_confirmation: false