> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/harmonic/api/vos/monitor-service/get-service-status/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Get activated service's status by service Id GET https://device.example.com:443/cluster1/vos-api/monitor/v1/services-status/{id} Get service status in the system by service Id. Reference: https://mediakind.ferndocs.com/harmonic/api/vos/monitor-service/get-service-status ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `id` (string, required) — id ## Response ### 200 Success - `audioOnlyService` (boolean, required) — Indication of an audio-only service - `cloudlinkGroupIds` (list of string, required) — List of CloudlinkGroups used in service. - `configureServiceType` (enum, required) — The type of the service from service configure - Allowed values: `LIVE`, `LIVE_EVENT` - `controlState` (enum, required) — The service's control state - Allowed values: `ACTIVATED`, `TEST`, `OFF` - `id` (string, required) — Unique identifier of a service in UUID format - `labels` (list of string, required) — List of labels. - `name` (string, required) — Display name of a service - `priority` (enum, required) — The service's priority - Allowed values: `LOW`, `NORMAL`, `HIGH` - `serviceType` (enum, required) — Display type of the service - Allowed values: `OTT`, `IPTV`, `OTT_PLAYOUT`, `MPTS` - `liveEventStatus` (com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventData, optional) - `muteOperationData` (com.harmonicinc.vos.app.monitor.model.MuteOperationData, optional) - `operationalState` (enum, optional) — The state of operation - Allowed values: `OFFLINE`, `INITIALIZING`, `RUNNING` - `serviceStartTime` (datetime, optional) — The last start/restart time of the RmpWorker datapath. Null when the service is stopped. ## Errors ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Forbidden - `any` ### 404 Not Found Error Service not found - `any` ## Types ### com.harmonicinc.vos.app.monitor.liveevent.model.LiveEventData - `confidenceMonitoring` (boolean, optional) — Live Event confidence monitoring status (enable/disable) - `endTimeInUtc` (string, optional) — Live Event end time in UTC - `esamPoisOobPosted` (boolean, optional) — Live Event esam pois oob message posted status (true/false) - `playlistEndSignaled` (boolean, optional) — Live Event playlist end signaled status (true/false) - `prepared` (boolean, optional) — Live Event prepared status (true/false) - `prerollDuration` (long, optional) — Live Event preroll duration in seconds - `prerollSlate` (string, optional) — Live Event preroll slate image ID - `recording` (boolean, optional) — Live Event recording - `signalProcessingNotification` (com.harmonicinc.vos.app.monitor.liveevent.service.esam_pois_oob.EsamPoisOobSignalProcessingNotification, optional) - `slateEnabled` (boolean, optional) — Live Event slate enabled status (true/false) - `startTimeInUtc` (string, optional) — Live Event start time in UTC - `state` (enum, optional) — Live Event state - Allowed values: `OFFLINE`, `ALLOCATING`, `PREPARING`, `PREVIEW`, `LIVE_PREROLL`, `LIVE`, `STOPPING`, `FINISHED`, `INTERRUPTED` - `uoeNotified` (boolean, optional) — Live Event UOE asset configuration update notification status (true/false) ### com.harmonicinc.vos.app.monitor.model.MuteOperationData - `enabled` (boolean, optional) — is mute operation enabled - `endTime` (string, optional) — Mute operation end time in UTC - `startTime` (string, optional) — Mute operation start time in UTC ### com.harmonicinc.vos.app.monitor.liveevent.service.esam_pois_oob.EsamPoisOobSignalProcessingNotification - `slateOff` (com.harmonicinc.vos.app.monitor.liveevent.service.esam_pois_oob.EsamPoisOobResponseSignal, optional) - `slateOn` (com.harmonicinc.vos.app.monitor.liveevent.service.esam_pois_oob.EsamPoisOobResponseSignal, optional) ### com.harmonicinc.vos.app.monitor.liveevent.service.esam_pois_oob.EsamPoisOobResponseSignal - `acquisitionPointId` (string, optional) - `acquisitionSignalId` (string, optional) - `action` (string, optional) - `altContentIdentity` (string, optional) - `utcPoint` (java.time.LocalDateTime, optional) - `zoneIdentity` (string, optional) ### java.time.LocalDateTime - `chronology` (java.time.chrono.Chronology, optional) - `dayOfMonth` (integer, optional) - `dayOfWeek` (enum, optional) - Allowed values: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY` - `dayOfYear` (integer, optional) - `hour` (integer, optional) - `minute` (integer, optional) - `month` (enum, optional) - Allowed values: `JANUARY`, `FEBRUARY`, `MARCH`, `APRIL`, `MAY`, `JUNE`, `JULY`, `AUGUST`, `SEPTEMBER`, `OCTOBER`, `NOVEMBER`, `DECEMBER` - `monthValue` (integer, optional) - `nano` (integer, optional) - `second` (integer, optional) - `year` (integer, optional) ### java.time.chrono.Chronology - `calendarType` (string, optional) - `id` (string, optional) ## Examples **Response** ```json { "audioOnlyService": true, "cloudlinkGroupIds": [ "string" ], "configureServiceType": "LIVE", "controlState": "ACTIVATED", "id": "string", "labels": [ "string" ], "name": "string", "priority": "LOW", "serviceType": "OTT", "liveEventStatus": { "confidenceMonitoring": true, "endTimeInUtc": "string", "esamPoisOobPosted": true, "playlistEndSignaled": true, "prepared": true, "prerollDuration": 1, "prerollSlate": "string", "recording": true, "signalProcessingNotification": { "slateOff": { "acquisitionPointId": "string", "acquisitionSignalId": "string", "action": "string", "altContentIdentity": "string", "utcPoint": { "chronology": { "calendarType": "string", "id": "string" }, "dayOfMonth": 1, "dayOfWeek": "MONDAY", "dayOfYear": 1, "hour": 1, "minute": 1, "month": "JANUARY", "monthValue": 1, "nano": 1, "second": 1, "year": 1 }, "zoneIdentity": "string" }, "slateOn": { "acquisitionPointId": "string", "acquisitionSignalId": "string", "action": "string", "altContentIdentity": "string", "utcPoint": { "chronology": { "calendarType": "string", "id": "string" }, "dayOfMonth": 1, "dayOfWeek": "MONDAY", "dayOfYear": 1, "hour": 1, "minute": 1, "month": "JANUARY", "monthValue": 1, "nano": 1, "second": 1, "year": 1 }, "zoneIdentity": "string" } }, "slateEnabled": true, "startTimeInUtc": "string", "state": "OFFLINE", "uoeNotified": true }, "muteOperationData": { "enabled": true, "endTime": "string", "startTime": "string" }, "operationalState": "OFFLINE", "serviceStartTime": "2024-01-15T09:30:00Z" } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/monitor/v1/services-status/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```