# Get system status

Returns a full snapshot of the VIF system: host information (WSE/VIF versions, CPU, NVIDIA GPU type and utilization) and an array of every stream currently registered with the VI service.

Endpoint: GET /v1/{server}/plugin/vif/status
Security: basicAuth

## Path parameters:

  - `server` (string, required)
    WSE server name. Any value is accepted; commonly _defaultServer_.

## Response 200 fields (application/json):

  - `host` (object, required)
    Host-level information and hardware utilization.

  - `host.wse_version` (string)

  - `host.vif_module_version` (string)

  - `host.cpu_avg` (number)
    Average CPU utilization (%).

  - `host.nvidia_gpu_type` (string)

  - `host.nvidia_driver_version` (string)

  - `host.cuda_version` (string)

  - `host.gpu_avg` (object)
    A measured value with its unit.

  - `host.gpu_avg.value` (number, required)

  - `host.gpu_avg.unit` (string, required)

  - `host.gpu_memory_avg` (object)
    A measured value with its unit.

  - `host.gpu_encode_avg` (object)
    A measured value with its unit.

  - `host.gpu_decode_avg` (object)
    A measured value with its unit.

  - `streams` (array, required)

  - `streams.api_version` (string)

  - `streams.vi_service_url` (string)

  - `streams.vi_service_version` (string)

  - `streams.vhost_name` (string)

  - `streams.app_name` (string)

  - `streams.instance_name` (string)

  - `streams.stream_name` (string)

  - `streams.active` (boolean)

  - `streams.model_name` (string)

  - `streams.width` (integer)

  - `streams.height` (integer)

  - `streams.frame_rate` (number)

  - `streams.skip_frames` (integer)

  - `streams.duration` (integer)

  - `streams.resize_output` (boolean)

  - `streams.grayscaled` (boolean)

  - `streams.detector_type` (string)
    Enum: "object", "scene"

  - `streams.status` (string)

  - `streams.reason` (string)
    Diagnostic detail when status is not running.

  - `streams.vif_event_listeners` (object)
    Configured event listeners grouped by built-in type.

  - `streams.vif_event_listeners.Id3Tags` (array)

  - `streams.vif_event_listeners.Webhooks` (array)

  - `streams.vif_event_listeners.LogFiles` (array)

  - `streams.vif_event_listeners.Overlays` (array)

  - `streams.performance` (object)
    Per-stream processing performance metrics (all times in milliseconds).

  - `streams.performance.ping_rtt_avg` (number)

  - `streams.performance.ping_pong_rtt_avg` (number)

  - `streams.performance.preprocess_time_avg` (number)

  - `streams.performance.inference_time_avg` (number)

  - `streams.performance.postprocess_time_avg` (number)

  - `streams.performance.total_processing_time_avg` (number)

  - `streams.performance.frame_detect_time_avg` (number)

  - `streams.performance.video_frames_ttl` (integer)

  - `streams.performance.object_frames_detected` (integer)

  - `streams.performance.behind_live_ms` (number)
    How far behind the live edge the analyzed frame currently is.

## Response 401 fields (application/json):

  - `status` (string)

  - `code` (integer)

  - `message` (string, required)