> 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.

# Set ATM Setting.

PUT https://device.example.com:443/cluster1/vos-api/atm/v1/settings
Content-Type: application/json

Set ATM Setting.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/atm-setting/set-atm-setting

## 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.atm.rest.model.AtmSettingConfig.

- `atmContainerResourceConfig` (com.harmonicinc.vos.app.atm.rest.model.AtmContainerResourceConfig, required)
- `atmScalingConfig` (com.harmonicinc.vos.app.atm.rest.model.AtmScalingConfig, required)
- `enableGzip` (boolean, optional) — Boolean to determine if enable gzip response or not

## Response

### 200

OK

- `atmContainerResourceConfig` (com.harmonicinc.vos.app.atm.rest.model.AtmContainerResourceConfig, required)
- `atmScalingConfig` (com.harmonicinc.vos.app.atm.rest.model.AtmScalingConfig, required)
- `enableGzip` (boolean, optional) — Boolean to determine if enable gzip response or not

### 201

Created

## Errors

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Types

### com.harmonicinc.vos.app.atm.rest.model.AtmContainerResourceConfig

- `atmRequestUOEBlockingReloadTimeoutInMs` (integer, optional)
- `atmRequestUOELiveTimeoutInMs` (integer, optional)
- `atmRequestUOETimeshiftTimeoutInMs` (integer, optional)
- `cpu` (double, optional) — Number of CPU cores or units of virtual CPU
- `memInMB` (double, optional) — Memory in MiB

### com.harmonicinc.vos.app.atm.rest.model.AtmScalingConfig

- `atmAutoScalingConfig` (com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig, optional)
- `replicas` (integer, optional) — Number of ATM pod replicas

### com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig

- `cronTriggers` (list of com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig_CronTrigger, optional) — Cron Triggers (KEDA Mode Only)
- `enabled` (boolean, optional) — Whether auto-scaling is enabled
- `maxNumInstances` (integer, optional) — Maximum number of instances to launch, unset numOfInstances field before using
- `minNumInstances` (integer, optional) — Minimum number of instances to launch, unset numOfInstances field before using
- `mode` (enum, optional) — Use KEDA for autoscaling
  - Allowed values: `KEDA`
- `responseTimeThresholdForFullScaleUp` (double, optional) — Target response time for scaling to max number of instances when exceeded
- `scaleDownPolicy` (com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig_ScaleDownPolicy, optional)
- `scaleDownStabilizationWindowSeconds` (integer, optional) — Duration of the time window that the autoscaler uses to calculate the high-water-mark of replicas, such that it never scales below the marking
- `scaleUpOnly` (boolean, optional) — Whether or not auto-scaling is limited to scale-up only
- `targetCpuPercent` (integer, optional) — Target CPU utilization percentage for calculating desired number of instances
- `targetRequestRate` (integer, optional) — Target request rate for scaling the number of instances linearly

### com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig_CronTrigger

- `desiredReplicas` (integer, optional) — Number of replicas to which the resource has to be scaled between the start and end of the cron schedule.
- `end` (string, optional) — Cron expression indicating the end of the cron schedule.
- `start` (string, optional) — Cron expression indicating the start of the cron schedule.
- `timezone` (string, optional) — The acceptable values would be a value from the IANA Time Zone Database.

### com.harmonicinc.vos.app.atm.rest.model.AtmAutoScalingConfig_ScaleDownPolicy

- `periodSeconds` (integer, required) — The time in seconds for which the policy should hold true.
- `value` (integer, required) — The value for the policy.
- `type` (enum, optional) — Allowed change in either number of pods or percentage of current replicas.
  - Allowed values: `Pods`, `Percent`

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
{
  "atmContainerResourceConfig": {
    "atmRequestUOEBlockingReloadTimeoutInMs": 1,
    "atmRequestUOELiveTimeoutInMs": 1,
    "atmRequestUOETimeshiftTimeoutInMs": 1,
    "cpu": 1.1,
    "memInMB": 1.1
  },
  "atmScalingConfig": {
    "atmAutoScalingConfig": {
      "cronTriggers": [
        {
          "desiredReplicas": 1,
          "end": "string",
          "start": "string",
          "timezone": "string"
        }
      ],
      "enabled": true,
      "maxNumInstances": 1,
      "minNumInstances": 1,
      "mode": "KEDA",
      "responseTimeThresholdForFullScaleUp": 1.1,
      "scaleDownPolicy": {
        "periodSeconds": 1,
        "value": 1,
        "type": "Pods"
      },
      "scaleDownStabilizationWindowSeconds": 1,
      "scaleUpOnly": true,
      "targetCpuPercent": 1,
      "targetRequestRate": 1
    },
    "replicas": 1
  },
  "enableGzip": true
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/atm/v1/settings"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/atm/v1/settings';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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/atm/v1/settings"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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/atm/v1/settings")

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

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

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.put("https://device.example.com/cluster1/vos-api/atm/v1/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://device.example.com/cluster1/vos-api/atm/v1/settings', [
  'body' => '{}',
  '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/atm/v1/settings");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/atm/v1/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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
{}
```

**Response**

```json
{
  "atmContainerResourceConfig": {
    "atmRequestUOEBlockingReloadTimeoutInMs": 1,
    "atmRequestUOELiveTimeoutInMs": 1,
    "atmRequestUOETimeshiftTimeoutInMs": 1,
    "cpu": 1.1,
    "memInMB": 1.1
  },
  "atmScalingConfig": {
    "atmAutoScalingConfig": {
      "cronTriggers": [
        {
          "desiredReplicas": 1,
          "end": "string",
          "start": "string",
          "timezone": "string"
        }
      ],
      "enabled": true,
      "maxNumInstances": 1,
      "minNumInstances": 1,
      "mode": "KEDA",
      "responseTimeThresholdForFullScaleUp": 1.1,
      "scaleDownPolicy": {
        "periodSeconds": 1,
        "value": 1,
        "type": "Pods"
      },
      "scaleDownStabilizationWindowSeconds": 1,
      "scaleUpOnly": true,
      "targetCpuPercent": 1,
      "targetRequestRate": 1
    },
    "replicas": 1
  },
  "enableGzip": true
}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/atm/v1/settings"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/atm/v1/settings';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

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/atm/v1/settings"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", 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/atm/v1/settings")

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

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

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.put("https://device.example.com/cluster1/vos-api/atm/v1/settings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://device.example.com/cluster1/vos-api/atm/v1/settings', [
  'body' => '{}',
  '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/atm/v1/settings");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/atm/v1/settings")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```