# WhatsUp Gold REST API

**Canonical:** https://apis.io/apis/progress-software/progress-software-whatsup-gold/  
**Provider:** Progress Software — https://apis.io/providers/progress-software/  
**Base URL:** https://{whatsupgold-host}:9644/api/v1  
**Documentation:** https://docs.ipswitch.com/NM/WhatsUpGold2026/02_Guides/rest_api/index.html

WhatsUp Gold REST API is one of 5 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 Network Monitoring, Infrastructure, and Observability. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

The WhatsUp Gold REST API is the automation interface of Progress WhatsUp Gold network monitoring, served from the customer's own WhatsUp Gold host on port 9644. It covers device discovery and management, credentials, monitors and monitor assignments, groups, alert centre, reports, polling and product configuration. The published contract is Swagger 2.0 with 168 operations across 121 paths and 299 model definitions, secured with an OAuth 2.0 password grant.

## Operations (60 of 168)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/credentials/{credentialId}` | Return a credential |
| PUT | `/api/v1/credentials/{credentialId}` | Update credential with new values |
| DELETE | `/api/v1/credentials/{credentialId}` | Remove credential from credential library |
| GET | `/api/v1/credentials/{credentialId}/assignments/-` | Return a credential |
| DELETE | `/api/v1/credentials/{credentialId}/assignments/-` | Remove assigned credential from all devices user has access to |
| GET | `/api/v1/credentials/-` | Return page of credentials from credential library |
| POST | `/api/v1/credentials/-` | Add credential to library |
| GET | `/api/v1/credentials/-/helper` | Return information to help creating credential |
| GET | `/api/v1/credentials/-/assignments/-` | Return information about credential assignments |
| GET | `/api/v1/credentials/{credentialId}/config/template` | Return a template for a credential |
| GET | `/api/v1/credentials/-/config/template` | Return set of credential templates |
| PATCH | `/api/v1/credentials/-/config/template` | Apply credential templates |
| 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 |

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

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-whatsup-gold-openapi-original.json
- **APIReference** — https://docs.ipswitch.com/NM/WhatsUpGold2026/02_Guides/rest_api/index.html
- **Documentation** — https://www.whatsupgold.com/rest-api

## Other Progress Software APIs (4)

- [Chef Automate API](https://apis.io/apis/progress-software/progress-software-chef-automate/)
- [MOVEit Transfer REST API](https://apis.io/apis/progress-software/progress-software-moveit-transfer/)
- [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/)

## Tags

Network Monitoring, Infrastructure, Observability

---

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