Nuix · Schema

ComputerConf

Schema for ComputerConf in Nuix ECC REST API

ForensicseDiscoveryInvestigationsComplianceData ProcessingLegal TechnologyIntelligence

Properties

Name	Type	Description
id	integer	id of the Computer Configuration
name	string	name of the Computer Configuration
description	string	description of the Computer Configuration
keepAliveInterval	integer	frequency (sec) a client sends a keep-alive request to the server
keepAliveTimeout	integer	time (sec) a client will wait for a response from the last keep-alive request
resourceWaitTime	integer	time (sec) a client will wait for a given resource (e.g. network share)
jobWaitTime	integer	frequency (sec) a client polls the server for new jobs (fallback to publish/subscribe)
startJobsWaitTime	integer	time (sec) to delay a job from starting
statusUpdateWaitTime	integer	frequency (sec) which a client to reports status of a running job
systemInfoUpdateWaitTime	integer	frequency (sec) which a client to reports current system info
minPortRange	integer	beginning of the TCP port range used for Deploy or Relocate jobs
maxPortRange	integer	end of the TCP port range used for Deploy or Relocate jobs
enableLogs	boolean	true if diagnostic logging is enabled
throttleOutput	boolean	true if out should be throttled
maxBandwidthMbps	integer	max bandwidth (in Mbps) allowed if output is throttled
altDestination	string	The path to an alternate destination if a primary job destination is unreachable
altDestHasCredentials	boolean	Whether the alternate destination requires credentials to access

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nuix/refs/heads/main/json-schema/nuix-ecc-computerconf.json",
  "title": "ComputerConf",
  "description": "Schema for ComputerConf in Nuix ECC REST API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "id of the Computer Configuration"
    },
    "name": {
      "type": "string",
      "description": "name of the Computer Configuration"
    },
    "description": {
      "type": "string",
      "description": "description of the Computer Configuration"
    },
    "keepAliveInterval": {
      "type": "integer",
      "description": "frequency (sec) a client sends a keep-alive request to the server"
    },
    "keepAliveTimeout": {
      "type": "integer",
      "description": "time (sec) a client will wait for a response from the last keep-alive request"
    },
    "resourceWaitTime": {
      "type": "integer",
      "description": "time (sec) a client will wait for a given resource (e.g. network share)"
    },
    "jobWaitTime": {
      "type": "integer",
      "description": "frequency (sec) a client polls the server for new jobs (fallback to publish/subscribe)"
    },
    "startJobsWaitTime": {
      "type": "integer",
      "description": "time (sec) to delay a job from starting"
    },
    "statusUpdateWaitTime": {
      "type": "integer",
      "description": "frequency (sec) which a client to reports status of a running job"
    },
    "systemInfoUpdateWaitTime": {
      "type": "integer",
      "description": "frequency (sec) which a client to reports current system info"
    },
    "minPortRange": {
      "type": "integer",
      "description": "beginning of the TCP port range used for Deploy or Relocate jobs"
    },
    "maxPortRange": {
      "type": "integer",
      "description": "end of the TCP port range used for Deploy or Relocate jobs"
    },
    "enableLogs": {
      "type": "boolean",
      "description": "true if diagnostic logging is enabled"
    },
    "throttleOutput": {
      "type": "boolean",
      "description": "true if out should be throttled"
    },
    "maxBandwidthMbps": {
      "type": "integer",
      "description": "max bandwidth (in Mbps) allowed if output is throttled"
    },
    "altDestination": {
      "type": "string",
      "description": "The path to an alternate destination if a primary job destination is unreachable"
    },
    "altDestHasCredentials": {
      "type": "boolean",
      "description": "Whether the alternate destination requires credentials to access"
    }
  }
}