> 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/configure-descrambling-keys/create-descrambling-keys/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Create Descrambling Keys

POST https://device.example.com:443/cluster1/vos-api/configure/v1/descrambling-keys
Content-Type: application/json

Create a new set of descrambling keys

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/configure-descrambling-keys/create-descrambling-keys

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.configure.model.DescramblingKeys.

- `mode` (enum, required) — Descrambling mode
  - Allowed values: `BISS2_MODE_1`, `BISS2_MODE_E`
- `id` (string, optional) — Id
- `injectedId` (string, optional) — Injected Id. Used to decrypt the SW when mode is BISS2 mode E. 32 hexadecimal characters long. If null, the global injected Id is used. On PUT, special value "******" means the value is not modified. GET will return this same special value.
- `swEven` (string, optional) — Session word used to descramble TS packets with transport_scrambling_control set to 10. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "******" means the value is not modified. GET will return this same special value.
- `swOdd` (string, optional) — Session word used to descramble TS packets with transport_scrambling_control set to 11. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "******" means the value is not modified. GET will return this same special value.

## Response

### 200

Success

- `mode` (enum, required) — Descrambling mode
  - Allowed values: `BISS2_MODE_1`, `BISS2_MODE_E`
- `id` (string, optional) — Id
- `injectedId` (string, optional) — Injected Id. Used to decrypt the SW when mode is BISS2 mode E. 32 hexadecimal characters long. If null, the global injected Id is used. On PUT, special value "******" means the value is not modified. GET will return this same special value.
- `swEven` (string, optional) — Session word used to descramble TS packets with transport_scrambling_control set to 10. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "******" means the value is not modified. GET will return this same special value.
- `swOdd` (string, optional) — Session word used to descramble TS packets with transport_scrambling_control set to 11. Clear if mode is BISS2 mode 1, encrypted if mode is BISS2 mode E. 32 hexadecimal characters long. On PUT, special value "******" means the value is not modified. GET will return this same special value.

### 201

Created

## Errors

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Bad Request

- `any`

### 409 Conflict Error

Conflict

- `any`

## Examples

### Example 1

**Request**

```json
{
  "mode": "BISS2_MODE_1"
}
```

**Response**

```json
{
  "mode": "BISS2_MODE_1",
  "id": "string",
  "injectedId": "00112233445566778899aabbccddeeff",
  "swEven": "00112233445566778899aabbccddeeff",
  "swOdd": "00112233445566778899aabbccddeeff"
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys"

payload = { "mode": "BISS2_MODE_1" }
headers = {
    "Authorization": "Bearer <token>",
    "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/configure/v1/descrambling-keys';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"mode":"BISS2_MODE_1"}'
};

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/configure/v1/descrambling-keys"

	payload := strings.NewReader("{\n  \"mode\": \"BISS2_MODE_1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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/configure/v1/descrambling-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"BISS2_MODE_1\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"BISS2_MODE_1\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys', [
  'body' => '{
  "mode": "BISS2_MODE_1"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"mode\": \"BISS2_MODE_1\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["mode": "BISS2_MODE_1"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys")! 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
{
  "mode": "BISS2_MODE_1"
}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys"

payload = { "mode": "BISS2_MODE_1" }
headers = {
    "Authorization": "Bearer <token>",
    "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/configure/v1/descrambling-keys';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"mode":"BISS2_MODE_1"}'
};

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/configure/v1/descrambling-keys"

	payload := strings.NewReader("{\n  \"mode\": \"BISS2_MODE_1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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/configure/v1/descrambling-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"BISS2_MODE_1\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"BISS2_MODE_1\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys', [
  'body' => '{
  "mode": "BISS2_MODE_1"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"mode\": \"BISS2_MODE_1\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["mode": "BISS2_MODE_1"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/descrambling-keys")! 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()
```