---
title: "Sets the bandwidth throttle for a device"
method: POST
path: "/v2/backup/bandwidth-throttle"
tags: ["Backup"]
---

# Sets the bandwidth throttle for a device

`POST /v2/backup/bandwidth-throttle`

Sets the bandwidth throttle for a device

## Request body

- object — Request of the Device Bandwidth Throttle setting.
  - `deviceId` integer
  - `bandwidthThrottle` object — Device Backup Bandwidth Throttle
    - `enabled` boolean — Whether bandwidth throttle is enabled/true or disabled/false
    - `workHoursKbps` integer — Bandwidth work hours limit
    - `nonWorkHoursKbps` integer — Bandwidth nonwork hours limit
    - `workHoursUserUnit` string — Bandwidth work hours unit
    - `nonWorkHoursUserUnit` string — Bandwidth nonwork hours unit
    - `workSchedule` object — Bandwidth work schedule
      - `endHour` integer — Work schedule end hour (0 to 23)
      - `endMinute` integer — Work schedule end minute (0 to 59)
      - `startHour` integer — Work schedule start hour (0 to 23)
      - `startMinute` integer — Work schedule start minute (0 to 59)
      - `weekDays` string[] — Work schedule week days list

## Response `200`

Returns SUCCESS if the bandwidth throttle was set, FAILURE otherwise.

---

[API](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0.md) · [All operations](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjarmm/ninjaone-public-api-2-0/versions/753f26d46650/schema)