> 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/turn-onoff-slate/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Turn ON/OFF slate POST https://device.example.com:443/cluster1/vos-api/monitor/v1/services/{id}/slate Content-Type: application/json Turn ON/OFF slate with \{id}. Reference: https://mediakind.ferndocs.com/harmonic/api/vos/monitor-service/turn-onoff-slate ## 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 ### Body (application/json) This endpoint expects a com.harmonicinc.vos.app.monitor.model.SlateRequestConfig. - `slateState` (enum, required) — Slate Status - Allowed values: `ON`, `OFF` - `time` (string, optional) — Slate request time in UTC (Format: 2011-12-03T10:15:30Z), must be no later than 1 minute from current time ## Response ### 200 OK - `errorMsg` (string, required) — Error Message - `recommendation` (string, required) — Recommendation - `serviceId` (string, required) — Service Id - `slateState` (enum, required) — Slate Status - Allowed values: `ON`, `OFF`, `ERROR` ### 201 Created ## Errors ### 401 Unauthorized Error Unauthorized - `any` ### 403 Forbidden Error Forbidden - `any` ### 404 Not Found Error Service not found - `any` ### 500 Internal Server Error Internal error - `any` ## Examples ### Example 1 **Request** ```json { "slateState": "ON" } ``` **Response** ```json { "errorMsg": "string", "recommendation": "string", "serviceId": "string", "slateState": "ON" } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate" payload = { "slateState": "ON" } 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/monitor/v1/services/id/slate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"slateState":"ON"}' }; 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/monitor/v1/services/id/slate" payload := strings.NewReader("{\n \"slateState\": \"ON\"\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/monitor/v1/services/id/slate") 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 \"slateState\": \"ON\"\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/monitor/v1/services/id/slate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"slateState\": \"ON\"\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate', [ 'body' => '{ "slateState": "ON" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"slateState\": \"ON\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["slateState": "ON"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate")! 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 { "slateState": "ON" } ``` **Response** ```json { "errorMsg": "string", "recommendation": "string", "serviceId": "string", "slateState": "ON" } ``` **SDK Code** ```python import requests url = "https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate" payload = { "slateState": "ON" } 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/monitor/v1/services/id/slate'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"slateState":"ON"}' }; 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/monitor/v1/services/id/slate" payload := strings.NewReader("{\n \"slateState\": \"ON\"\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/monitor/v1/services/id/slate") 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 \"slateState\": \"ON\"\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/monitor/v1/services/id/slate") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"slateState\": \"ON\"\n}") .asString(); ``` ```php request('POST', 'https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate', [ 'body' => '{ "slateState": "ON" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"slateState\": \"ON\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["slateState": "ON"] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/monitor/v1/services/id/slate")! 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() ```