> This page is for Harmonic. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Update the status of Uplink POST https://device.example.com:443/cluster1/vos-api/uplink-hub/v1/uplinks/{id}/uplinkStatus Content-Type: application/json Update the status of Uplink. Reference: https://mediakind.ferndocs.com/harmonic/api/vos/uplink-hub/update-status-uplink ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `id` (string, required) — Unique identifier of a uplink ### Body (application/json) This endpoint expects a com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatus. - `id` (string, required) — Id of the uplink - `lastActivityTime` (java.time.LocalDateTime, required) - `upgradeStatus` (enum, required) — Upgrade status of uplink - Allowed values: `IDLE`, `UPGRADING`, `ROLLBACK`, `AVAILABLE_UPGRADE` - `uplinkChannelStatusList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkChannelStatus, required) — List of UplinkChannelStatus - `uplinkEventReportingList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting, required) — Event reports of uplink - `uplinkState` (enum, required) — Auto generated. if lost communication with up more than 5 minutes, it will become loss. - Allowed values: `UP`, `LOST` - `uplinkStatistic` (com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatistic, required) ## Response ### 200 Uplink Status updated ### 201 Created ## Errors ### 400 Bad Request Error Update Failed - `any` ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Forbidden - `any` ### 404 Not Found Error Not Found - `any` ## Types ### 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) ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkChannelStatus - `id` (string, required) — Id of the uplinkChannel - `uplinkEventReportingList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting, required) — Event reports of uplink channel - `uplinkInputStatusList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatus, required) — Status of the uplink input. - `downlinkOutputStatusList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatus, optional) — Status of the downlink output. ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting - `eventMessage` (string, required) — The event message happened - `eventType` (string, required) — Type of the event report - `reportId` (string, required) — Id of the event report - `time` (datetime, required) — The time information for statistic e.g. 2015-11-04T09:11:33Z - `notificationPropertiesMap` (map from string to string, optional) — The collection which contains notification properties ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkStatistic - `downlinkInputStatisticList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkInputStatisticEntry, required) — The event description of the Downlink input - `uplinkOutputStatisticList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkOutputStatisticEntry, required) — The event description of the Uplink output ### java.time.chrono.Chronology - `calendarType` (string, optional) - `id` (string, optional) ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatus - `id` (string, required) — Unique identifier of a UplinkInput in UUID format - `pidStatisticsList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.PidStatistics, required) — Cloudlink Pid Statistic - `uplinkEventReportingList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting, required) — Event reports of uplink input - `uplinkInputStatistic` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatisticEntry, required) — The event description of of the input - `uplinkStreamingStatus` (enum, required) — The status of the output of uplink, ERROR means no stream output which is not expected. - Allowed values: `ACTIVE`, `ERROR` - `activeInputIndex` (integer, optional) — Index of active ip input - `fecStatistics` (com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.FecStatistic, optional) - `rtpStatistics` (com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.RtpStatistics, optional) ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatus - `downlinkEventReportingList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkEventReporting, required) — Event reports of uplink output - `downlinkOutputStatistic` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatisticEntry, required) — The event description of of the input - `downlinkStreamingStatus` (enum, required) — The status of the output of uplink, ERROR means no stream output which is not expected. - Allowed values: `ACTIVE`, `ERROR` - `id` (string, required) — Unique identifier of a DownlinkOutput in UUID format - `pidStatisticsList` (list of com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.PidStatistics, required) — Cloudlink Pid Statistic - `activeInputIndex` (integer, optional) — Index of active ip input ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkInputStatisticEntry - `inputBitrate` (integer, required) — The bitrate (bps) of input - `time` (datetime, required) — The time information for statistic, e.g. 2015-11-04T09:11:33Z ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkOutputStatisticEntry - `outputBitrate` (integer, required) — The bitrate (bps) of output - `time` (datetime, required) — The time information for statistic, e.g. 2015-11-04T09:11:33Z ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.PidStatistics - `carryPCR` (boolean, required) — Carry PCR - `ccErrorCount` (integer, required) — CCError count - `packetCount` (integer, required) — Count of packets - `pid` (integer, required) — TS Pid - `pidType` (enum, required) — Pid Type - Allowed values: `PIDTYPE_UNKNOWN`, `PIDTYPE_PSI`, `PIDTYPE_VIDEO`, `PIDTYPE_AUDIO`, `PIDTYPE_SCTE35`, `PIDTYPE_SUBTITLE`, `PIDTYPE_PAT`, `PIDTYPE_PMT`, `PIDTYPE_CAT` ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.UplinkInputStatisticEntry - `inputBitrate` (integer, required) — The ingest bitrate (bps) of input - `time` (datetime, required) — The time information for statistic, e.g. 2015-11-04T09:11:33Z ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.FecStatistic - `dropped` (integer, optional) - `recovered` (integer, optional) ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.RtpStatistics - `inputRtpPacketsDropped` (long, optional) ### com.harmonicinc.vos.app.uplink.hub.rest.model.uplink.DownlinkOutputStatisticEntry - `outputBitrate` (integer, required) — The ingest bitrate (bps) of output - `time` (datetime, required) — The time information for statistic, e.g. 2015-11-04T09:11:33Z ## Examples ### Example 1 **Request** ```json { "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus" payload = { "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": True, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"id":"string","upgradeStatus":"IDLE","uplinkChannelStatusList":[{"id":"string","uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkInputStatusList":[{"id":"string","pidStatisticsList":[{"carryPCR":true,"ccErrorCount":1,"packetCount":1,"pid":1,"pidType":"PIDTYPE_UNKNOWN"}],"uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkInputStatistic":[{"inputBitrate":1,"time":"2024-01-15T09:30:00Z"}],"uplinkStreamingStatus":"ACTIVE"}]}],"uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkState":"UP","uplinkStatistic":{"downlinkInputStatisticList":[{"inputBitrate":1,"time":"2024-01-15T09:30:00Z"}],"uplinkOutputStatisticList":[{"outputBitrate":1,"time":"2024-01-15T09:30:00Z"}]}}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus" payload := strings.NewReader("{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/uplink-hub/v1/uplinks/id/uplinkStatus") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus', [ 'body' => '{ "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ [ "id": "string", "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkInputStatusList": [ [ "id": "string", "pidStatisticsList": [ [ "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" ] ], "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkInputStatistic": [ [ "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ], "uplinkStreamingStatus": "ACTIVE" ] ] ] ], "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkState": "UP", "uplinkStatistic": [ "downlinkInputStatisticList": [ [ "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ], "uplinkOutputStatisticList": [ [ "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ``` ### Example 2 **Request** ```json { "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus" payload = { "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": True, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"id":"string","upgradeStatus":"IDLE","uplinkChannelStatusList":[{"id":"string","uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkInputStatusList":[{"id":"string","pidStatisticsList":[{"carryPCR":true,"ccErrorCount":1,"packetCount":1,"pid":1,"pidType":"PIDTYPE_UNKNOWN"}],"uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkInputStatistic":[{"inputBitrate":1,"time":"2024-01-15T09:30:00Z"}],"uplinkStreamingStatus":"ACTIVE"}]}],"uplinkEventReportingList":[{"eventMessage":"string","eventType":"string","reportId":"string","time":"2024-01-15T09:30:00Z"}],"uplinkState":"UP","uplinkStatistic":{"downlinkInputStatisticList":[{"inputBitrate":1,"time":"2024-01-15T09:30:00Z"}],"uplinkOutputStatisticList":[{"outputBitrate":1,"time":"2024-01-15T09:30:00Z"}]}}' }; 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" "strings" "net/http" "io" ) func main() { url := "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus" payload := strings.NewReader("{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") 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/uplink-hub/v1/uplinks/id/uplinkStatus") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus', [ 'body' => '{ "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ { "id": "string", "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatusList": [ { "id": "string", "pidStatisticsList": [ { "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkInputStatistic": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkStreamingStatus": "ACTIVE" } ] } ], "uplinkEventReportingList": [ { "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" } ], "uplinkState": "UP", "uplinkStatistic": { "downlinkInputStatisticList": [ { "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ], "uplinkOutputStatisticList": [ { "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" } ] } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"id\": \"string\",\n \"upgradeStatus\": \"IDLE\",\n \"uplinkChannelStatusList\": [\n {\n \"id\": \"string\",\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatusList\": [\n {\n \"id\": \"string\",\n \"pidStatisticsList\": [\n {\n \"carryPCR\": true,\n \"ccErrorCount\": 1,\n \"packetCount\": 1,\n \"pid\": 1,\n \"pidType\": \"PIDTYPE_UNKNOWN\"\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkInputStatistic\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkStreamingStatus\": \"ACTIVE\"\n }\n ]\n }\n ],\n \"uplinkEventReportingList\": [\n {\n \"eventMessage\": \"string\",\n \"eventType\": \"string\",\n \"reportId\": \"string\",\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkState\": \"UP\",\n \"uplinkStatistic\": {\n \"downlinkInputStatisticList\": [\n {\n \"inputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ],\n \"uplinkOutputStatisticList\": [\n {\n \"outputBitrate\": 1,\n \"time\": \"2024-01-15T09:30:00Z\"\n }\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "id": "string", "upgradeStatus": "IDLE", "uplinkChannelStatusList": [ [ "id": "string", "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkInputStatusList": [ [ "id": "string", "pidStatisticsList": [ [ "carryPCR": true, "ccErrorCount": 1, "packetCount": 1, "pid": 1, "pidType": "PIDTYPE_UNKNOWN" ] ], "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkInputStatistic": [ [ "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ], "uplinkStreamingStatus": "ACTIVE" ] ] ] ], "uplinkEventReportingList": [ [ "eventMessage": "string", "eventType": "string", "reportId": "string", "time": "2024-01-15T09:30:00Z" ] ], "uplinkState": "UP", "uplinkStatistic": [ "downlinkInputStatisticList": [ [ "inputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ], "uplinkOutputStatisticList": [ [ "outputBitrate": 1, "time": "2024-01-15T09:30:00Z" ] ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/uplink-hub/v1/uplinks/id/uplinkStatus")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data 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() ```