# Progress Software Device API

**Canonical:** https://apis.io/apis/progress-software/progress-software-device-api/  
**Provider:** Progress Software — https://apis.io/providers/progress-software/  
**Base URL:** https://automate.chef.io  
**Documentation:** https://docs.chef.io/automate/api/

Progress Software Device API is one of 66 APIs that [Progress Software](https://apis.io/providers/progress-software/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Device. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

The Device API from Progress Software — 39 operation(s) for device.

## Operations (60 of 63)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/devices/{deviceId}/attributes/{attributeId}` | Return individual attribute |
| PUT | `/api/v1/devices/{deviceId}/attributes/{attributeId}` | Update individual attribute |
| DELETE | `/api/v1/devices/{deviceId}/attributes/{attributeId}` | Delete individual attribute |
| GET | `/api/v1/devices/{deviceId}/attributes/-` | Return list of attributes for device |
| POST | `/api/v1/devices/{deviceId}/attributes/-` | Add attribute to device |
| DELETE | `/api/v1/devices/{deviceId}/attributes/-` | Delete all attributes from device |
| PATCH | `/api/v1/devices/{deviceId}/attributes/-` | Batch attribute operations (remove, add, modify) for given device |
| DELETE | `/api/v1/devices/{deviceId}/group/{groupId}` | Remove a group assignment for device |
| GET | `/api/v1/devices/{deviceId}/group/-` | Return device group assignments for a device |
| PUT | `/api/v1/devices/{deviceId}/group/-` | Assign group to a device |
| PATCH | `/api/v1/devices/{deviceId}/group/-` | Batch attribute operations (remove, add) for given device |
| GET | `/api/v1/devices/{deviceId}/group/{groupId}/is-member` | Return sucessful if a device is assigned to a group |
| GET | `/api/v1/devices/{deviceId}/interfaces/default` | Return device's default network interface |
| GET | `/api/v1/devices/{deviceId}/interfaces/{interfaceId}` | Return individual network interface |
| PUT | `/api/v1/devices/{deviceId}/interfaces/{interfaceId}` | Update individual interface |
| DELETE | `/api/v1/devices/{deviceId}/interfaces/{interfaceId}` | Delete individual interface |
| GET | `/api/v1/devices/{deviceId}/interfaces/-` | Return list of network interfaces for device |
| POST | `/api/v1/devices/{deviceId}/interfaces/-` | Add a network interface to device |
| DELETE | `/api/v1/devices/{deviceId}/interfaces/-` | Delete from device, all network interfaces except default interface |
| PATCH | `/api/v1/devices/{deviceId}/interfaces/-` | Batch network interface operations (remove, add, modify) for a given device |
| DELETE | `/api/v1/devices/{deviceId}/credentials/{credentialId}` | Remove an assigned credential from a device |
| GET | `/api/v1/devices/{deviceId}/credentials/-` | Return assigned credentials for a device |
| PUT | `/api/v1/devices/{deviceId}/credentials/-` | Assign a credential to a device |
| DELETE | `/api/v1/devices/{deviceId}/credentials/-` | Remove assigned credentials from a device by type |
| GET | `/api/v1/devices/{deviceId}/monitors/{assignmentId}` | Return monitor assignment for given device |
| PUT | `/api/v1/devices/{deviceId}/monitors/{assignmentId}` | Update a monitor assignment on a device |
| DELETE | `/api/v1/devices/{deviceId}/monitors/{assignmentId}` | Remove an assigned monitor from a device |
| GET | `/api/v1/devices/{deviceId}/monitors/-` | Return assigned monitors for a device |
| POST | `/api/v1/devices/{deviceId}/monitors/-` | Assign monitor to a device |
| DELETE | `/api/v1/devices/{deviceId}/monitors/-` | Remove assigned monitors from device |
| PATCH | `/api/v1/devices/{deviceId}/monitors/-` | Batch modify monitor assignments for given device |
| GET | `/api/v1/devices/{deviceId}/config/polling` | Return the device general polling configuration summary |
| PUT | `/api/v1/devices/{deviceId}/config/polling` | Update device general polling configuration |
| PUT | `/api/v1/devices/{deviceId}/config/maintenance` | Update maintenance mode settings for a given device |
| PUT | `/api/v1/devices/{deviceId}/config/maintenance/schedule` | Update maintenance mode settings for a given device (scheduled) |
| PUT | `/api/v1/devices/{deviceId}/poll-now` | Request the polling service to poll this device immediately |
| PATCH | `/api/v1/devices/-/config/maintenance` | Update maintenance mode settings for batch of devices |
| PATCH | `/api/v1/devices/-/config/maintenance/schedule` | Update maintenance mode settings for a set of devices (scheduled) |
| PATCH | `/api/v1/devices/-/config/polling` | Update a set of devices with general polling configuration |
| PATCH | `/api/v1/devices/-/poll-now` | Request polling service to poll multiple devices immediately |
| GET | `/api/v1/devices/{deviceId}/properties` | Returns device properties |
| PUT | `/api/v1/devices/{deviceId}/properties` | Updates the properties on the device |
| PATCH | `/api/v1/devices/-/properties` | Updates the properties on the device |
| PUT | `/api/v1/devices/{deviceId}/refresh` | Request a device to refresh configuration based on the phyiscal device |
| PATCH | `/api/v1/devices/-/refresh` | Request a set of devices to refresh configuration based on the phyiscal device |
| DELETE | `/api/v1/devices/{deviceId}/roles/{roleId}` | Remove assigned role from a device |
| GET | `/api/v1/devices/{deviceId}/roles/-` | Return roles assignment for a given device |
| PUT | `/api/v1/devices/{deviceId}/roles/-` | Assign a role to a device |
| DELETE | `/api/v1/devices/{deviceId}/roles/-` | Remove device role assignment by role type |
| PUT | `/api/v1/devices/{deviceId}/roles/brand` | Assign a brand to a device |
| PATCH | `/api/v1/devices/-/roles/brand` | Assign a brand to multiple devices |
| PUT | `/api/v1/devices/{deviceId}/roles/os` | Assign operating system to a device |
| PATCH | `/api/v1/devices/-/roles/os` | Assign a operating system to multiple devices |
| PUT | `/api/v1/devices/{deviceId}/roles/primary` | Assign primary role to a device |
| PATCH | `/api/v1/devices/-/roles/primary` | Assign a primary role to multiple devices |
| PUT | `/api/v1/devices/{deviceId}/roles/sub-role` | Sub role operations on a device |
| PATCH | `/api/v1/devices/-/roles/sub-role` | Perform a sub role operation on multiple devices |
| GET | `/api/v1/devices/{deviceId}/config/template` | Returns a template for the device |
| PATCH | `/api/v1/devices/-/config/template` | Apply a set of device templates |
| GET | `/api/v1/devices/{deviceId}` | Return device overview for a given device |

…and 3 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-device-api-openapi.yml
- **Documentation** — https://docs.chef.io/automate/
- **APIReference** — https://docs.chef.io/automate/api/
- **APIReference** — https://docs.ipswitch.com/MOVEit/Transfer2025/Api/Rest/
- **Documentation** — https://docs.progress.com/category/moveit
- **APIReference** — https://docs.ipswitch.com/NM/WhatsUpGold2026/02_Guides/rest_api/index.html
- **Documentation** — https://www.whatsupgold.com/rest-api

## Other Progress Software APIs (12)

- [ShareFile API v3](https://apis.io/apis/progress-software/progress-software-sharefile/)
- [Sitefinity CMS Headless OData Services](https://apis.io/apis/progress-software/progress-software-sitefinity-odata/)
- [Progress Software Ad Hoc Transfer Settings API](https://apis.io/apis/progress-software/progress-software-adhoctransfersettings-api/)
- [Progress Software Appearance Settings API](https://apis.io/apis/progress-software/progress-software-appearancesettings-api/)
- [Progress Software Applications Service API](https://apis.io/apis/progress-software/progress-software-applicationsservice-api/)
- [Progress Software Authentication API](https://apis.io/apis/progress-software/progress-software-authentication-api/)
- [Progress Software Authorization API](https://apis.io/apis/progress-software/progress-software-authorization-api/)
- [Progress Software Cds API](https://apis.io/apis/progress-software/progress-software-cds-api/)
- [Progress Software Chef Ingester API](https://apis.io/apis/progress-software/progress-software-chefingester-api/)
- [Progress Software Comp Assets API](https://apis.io/apis/progress-software/progress-software-comp-assets-api/)
- [Progress Software Config Mgmt API](https://apis.io/apis/progress-software/progress-software-configmgmt-api/)
- [Progress Software Contacts API](https://apis.io/apis/progress-software/progress-software-contacts-api/)

## Tags

Device

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/progress-software/progress-software-device-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/progress-software/.