Progress Software

Progress Software Device Group API

The Device Group API from Progress Software — 18 operation(s) for device group.

GitHub OpenAPI
Business capability
IT Operations Management BC-600.40

Operations 23

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/device-groups/- List device groups · Return a list of groups #
Ask an LLM
“What device groups are set up in my network monitoring?”
“Can I search device groups by display name and filter by group type?”
Tell an agent
List all my device groups.
Find device groups whose name contains {search}.
GET /api/v1/device-groups/{groupId} Get a device group's summary · Returns the summary data for a given device group #
Ask an LLM
“How do I look up the summary details of one device group?”
“Can I get a device group's summary in a different view?”
Tell an agent
Show me the summary for device group {groupId}.
Get device group {groupId} using the {view} view.
DELETE /api/v1/device-groups/{groupId} Delete a device group · Delete a group. Group must have no child groups or devices #
Ask an LLM
“How do I delete a device group I no longer need?”
“Why can't I delete a group that still has child groups or devices in it?”
Tell an agent destructive · confirm first
Delete the empty device group {groupId}.
Remove device group {groupId} now that it has no devices or subgroups.
GET /api/v1/device-groups/{groupId}/definition Get a device group's definition · Retrieve a device group definition #
Ask an LLM
“Where can I see how a device group is defined, including its dynamic or layer 2 rules?”
“What parent group and membership definition does this device group use?”
Tell an agent
Show me the definition of device group {groupId}.
Get the dynamic and layer 2 definition rules for group {groupId}.
PUT /api/v1/device-groups/{groupId}/definition Update a device group's definition · Update the device group definition #
Ask an LLM
“How do I rename a device group or change its description?”
“Can I move a device group under a different parent group?”
Tell an agent
Rename device group {groupId} to {name}.
Move device group {groupId} under parent group {parentGroupId}.
POST /api/v1/device-groups/{groupId}/child Create a child device group · Add a new child device group to a parent group #
Ask an LLM
“How do I create a new subgroup under an existing device group?”
“Can I create a dynamic child group instead of a static one?”
Tell an agent
Create a child group named {name} under device group {groupId}.
Add a {groupType} subgroup called {name} beneath parent group {groupId}.
GET /api/v1/device-groups/{groupId}/children List a device group's child groups · Return the child groups given a device group #
Ask an LLM
“Which subgroups sit underneath a given device group?”
“Can I get the whole nested hierarchy of child groups, not just the first level?”
Tell an agent
List the child groups of device group {groupId}.
Search the subgroups of {groupId} for names matching {search}.
PUT /api/v1/device-groups/{groupId}/poll-now Poll every device in a group immediately · Request the polling service to poll all devices in a group immediately #
Ask an LLM
“How do I force all devices in a group to be polled right now instead of waiting for the interval?”
“Can I poll only the immediate children of a group rather than every nested device?”
Tell an agent
Poll all devices in group {groupId} immediately.
Poll now only the devices in group {groupId} matching {search}.
PUT /api/v1/device-groups/{groupId}/refresh Rediscover all devices in a group · Request the discovery service to refresh all devices in a group immediately #
Ask an LLM
“How do I make discovery rescan every device in a group to pick up hardware changes?”
“Can a group refresh drop discovered data older than a certain number of hours?”
Tell an agent
Refresh discovery for all devices in group {groupId}.
Rescan group {groupId} and drop discovered data older than {dropDataOlderThanHours} hours.
PUT /api/v1/device-groups/{groupId}/newDevice Add a single device to monitoring · Add a new device to be monitored #
Ask an LLM
“How do I start monitoring a new device by its IP address or hostname?”
“Can I add one device and force it to take a specific role?”
Tell an agent
Add device {ipOrName} to group {groupId} for monitoring.
Add {ipOrName} to group {groupId} using SNMP port {snmpPortToUse}.
PATCH /api/v1/device-groups/{groupId}/newDevice Bulk add many devices to monitoring · Bulk add of new devices to be monitored #
Ask an LLM
“Can I add a whole list of IP addresses to monitoring in one request?”
“What's the way to onboard dozens of hosts into a device group at once?”
Tell an agent
Bulk add these hosts {ipOrNames} to group {groupId}.
Add the devices {ipOrNames} to group {groupId} and expand virtual environments: {expandVirtualEnvironment}.
GET /api/v1/device-groups/{groupId}/status Get the overall status of a device group · Returns the overall status summary across all devices in a group #
Ask an LLM
“How healthy are the devices in this group overall?”
“Is there a rolled-up up/down status summary for an entire group?”
Tell an agent
Show the overall status summary for group {groupId}.
Tell me how many devices in group {groupId} are up or down.
GET /api/v1/device-groups/{groupId}/devices List devices in a group · Returns the summary data for a given device group #
Ask an LLM
“Which devices belong to a given group, including its nested subgroups?”
“Can I list group devices that are in a particular state, like down?”
Tell an agent
List the devices in group {groupId}.
Show devices in group {groupId} whose state is {state}.
GET /api/v1/device-groups/{groupId}/devices/- Search devices in a group (dash collection path) · Returns the summary data for a given device group #
Ask an LLM
“Can I search a group's device collection by hostname or network address?”
“What does the devices/- collection endpoint of a group return for paging?”
Tell an agent
Search the device collection of group {groupId} for {search}.
Page through group {groupId}'s device collection starting at page {pageId}.
POST /api/v1/device-groups/{groupId}/devices/- Add existing devices to a group · Add a set of devices to a group #
Ask an LLM
“How do I put devices I already monitor into another group?”
“Can a device be a member of more than one group?”
Tell an agent
Add devices {devices} to group {groupId}.
Make the already-monitored devices {devices} members of group {groupId}.
DELETE /api/v1/device-groups/{groupId}/devices/- Remove several devices from a group · Remove a set of devices from a group #
Ask an LLM
“How do I take a batch of devices out of a group in one call?”
“Can I remove multiple devices from a group's membership at once?”
Tell an agent destructive · confirm first
Remove devices {devices} from group {groupId}.
Take this set of devices {devices} out of group {groupId}'s membership.
DELETE /api/v1/device-groups/{groupId}/devices/{deviceId} Remove one device from a group · Remove a device from group #
Ask an LLM
“How do I remove just one device from a group?”
“What happens if I pull a single device out of a group membership?”
Tell an agent destructive · confirm first
Remove device {deviceId} from group {groupId}.
Drop the single device {deviceId} from group {groupId}'s members.
GET /api/v1/device-groups/{groupId}/devices/-/config/template Export device templates for a group · Returns the device templates for the devices in a group #
Ask an LLM
“Can I export the configuration of every device in a group as templates?”
“Which template options exist, like including layer 2 data or active monitors?”
Tell an agent
Export device templates for group {groupId}.
Get device templates for group {groupId} with options {options}, including nested groups.
GET /api/v1/device-groups/{groupId}/devices/-/credentials List credentials assigned to a group's devices · Return the child groups given a device group #
Ask an LLM
“Which credentials are assigned to the devices in a group?”
“Can I narrow the group's credential assignments to one credential type for a group's devices?”
Tell an agent
Show the credentials assigned to devices in group {groupId}.
List {type} credential assignments for devices in group {groupId}.
PUT /api/v1/device-groups/{groupId}/roles/brand Assign a brand to a group's devices · Assign a brand to a device #
Ask an LLM
“How do I set the hardware brand on every device in a group?”
“Can I apply a brand to devices in subgroups too?”
Tell an agent
Set the brand of all devices in group {groupId} to {brand}.
Assign brand {brand} to group {groupId}, includeHierarchy {includeHierarchy}.
PUT /api/v1/device-groups/{groupId}/roles/os Assign an operating system to a group's devices · Assign operating system to a device #
Ask an LLM
“How do I mark all devices in a group as running a specific operating system?”
“Can the OS assignment cascade to nested groups?”
Tell an agent
Set the operating system of devices in group {groupId} to {osName}.
Assign OS {osName} to every device under group {groupId}.
PUT /api/v1/device-groups/{groupId}/roles/primary Assign a primary role to a group's devices · Assign primary role to a device #
Ask an LLM
“How do I change the primary device role, like router or switch, for a whole group?”
“Can I give every device in a group the same primary role?”
Tell an agent
Set the primary role of devices in group {groupId} to {primary}.
Assign primary role {primary} across group {groupId} and its subgroups.
PUT /api/v1/device-groups/{groupId}/roles/sub-role Add, remove or clear sub-roles on a group's devices · Sub role operations on a device #
Ask an LLM
“Can I add sub-roles to every device in a group at once?”
“How do I clear all sub-roles from the devices in a group?”
Tell an agent
Add sub-roles {subroles} to devices in group {groupId}.
Run sub-role operation {operation} on group {groupId}.

Documentation

📖
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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/progress-software/openapi/progress-software-device-group-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/progress-software:progress-software-device-group-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

progress-software-device-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: WhatsUp Gold Device Group API
  x-logo:
    url: images/wug_logo.svg
  description: '**Version 2026.0**


    *Use WhatsUp Gold REST API to deploy network and device monitoring and management scripts.*


    !'
servers:
- url: https://10.40.67.158:9644
tags:


# --- truncated at 32 KB (75 KB total) ---
# Full source: https://artifacts.apis.io/progress-software/openapi/progress-software-device-group-api-openapi.yml