---
title: "Get system status"
method: GET
path: "/v1/{server}/plugin/vif/status"
tags: ["Status & Health"]
---

# Get system status

`GET /v1/{server}/plugin/vif/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.

## Response `200`

System status returned successfully.

- SystemStatus — Full system snapshot returned by the status endpoint.
  - `host` HostInfo, required — Host-level information and hardware utilization.
    - `wse_version` string
    - `vif_module_version` string
    - `cpu_avg` number — Average CPU utilization (%).
    - `nvidia_gpu_type` string
    - `nvidia_driver_version` string
    - `cuda_version` string
    - `gpu_avg` Measurement — A measured value with its unit.
      - `value` number, required
      - `unit` string, required
    - `gpu_memory_avg` Measurement — A measured value with its unit.
      - `value` number, required
      - `unit` string, required
    - `gpu_encode_avg` Measurement — A measured value with its unit.
      - `value` number, required
      - `unit` string, required
    - `gpu_decode_avg` Measurement — A measured value with its unit.
      - `value` number, required
      - `unit` string, required
  - `streams` StreamStatus[], required
    - `api_version` string
    - `wse_version` string
    - `vif_module_version` string
    - `vi_service_url` string, uri
    - `vi_service_version` string
    - `vhost_name` string
    - `app_name` string
    - `instance_name` string
    - `stream_name` string
    - `active` boolean
    - `model_name` string
    - `width` integer
    - `height` integer
    - `frame_rate` number
    - `skip_frames` integer
    - `duration` integer
    - `resize_output` boolean
    - `grayscaled` boolean
    - `detector_type` 'object' | 'scene'
    - `status` string
    - `reason` string — Diagnostic detail when status is not `running`.
    - `vif_event_listeners` EventListenerStatus — Configured event listeners grouped by built-in type.
      - `Id3Tags` string[]
      - `Webhooks` string[]
      - `LogFiles` string[]
      - `Overlays` string[]
    - `performance` Performance — Per-stream processing performance metrics (all times in milliseconds).
      - `ping_rtt_avg` number
      - `ping_pong_rtt_avg` number
      - `preprocess_time_avg` number
      - `inference_time_avg` number
      - `postprocess_time_avg` number
      - `total_processing_time_avg` number
      - `frame_detect_time_avg` number
      - `video_frames_ttl` integer
      - `object_frames_detected` integer
      - `behind_live_ms` number — How far behind the live edge the analyzed frame currently is.

## Other responses

- `401` — Authentication failed. Check the WSE Manager username and password.

---

[API](https://skmtc.net/wowza/apis/wowza-video-intelligence-framework-vif-rest-api.md) · [All operations](https://skmtc.net/wowza/apis/wowza-video-intelligence-framework-vif-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wowza/wowza-video-intelligence-framework-vif-rest-api/revisions/7128019ae2c5/schema)