Progress Software

Progress Software Device Role API

The DeviceRole API from Progress Software — 14 operation(s) for devicerole.

GitHub OpenAPI

Operations 16

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-role/{roleId} Get a device role · Return device role information #
Ask an LLM
“What does a specific device role in WhatsUp Gold contain?”
“Can I view one device role's summary information?”
Tell an agent
Show device role {roleId}.
Get role {roleId} with the {view} view.
DELETE /api/v1/device-role/{roleId} Delete a device role from the library · Delete a role from the library #
Ask an LLM
“How do I remove a custom device role from the library?”
“Is deleting a device role permanent?”
Tell an agent destructive · confirm first
Delete device role {roleId} from the library.
Remove role {roleId}.
GET /api/v1/device-role/{roleId}/config/template Get the config template of a device role · Return template for a device role #
Ask an LLM
“Can I export one device role's configuration template for copying to another system?”
“What template options control how much of a single role is included?”
Tell an agent
Get the config template for role {roleId} with options {options}.
Export the transfer template of device role {roleId}.
PUT /api/v1/device-role/{roleId}/enable Enable a device role · Enable a device role for use #
Ask an LLM
“How do I turn a disabled device role back on?”
“Can I make a role available for use again?”
Tell an agent
Enable device role {roleId}.
Turn on role {roleId} so it can be used.
PUT /api/v1/device-role/{roleId}/disable Disable a device role · Disable a role from being used #
Ask an LLM
“Can I stop a device role from being used without deleting it?”
“What happens when I disable a role?”
Tell an agent
Disable device role {roleId}.
Stop role {roleId} from being used.
PUT /api/v1/device-role/{roleId}/restore Restore a system role to defaults · Restore system role to shipped defaults #
Ask an LLM
“How do I reset a built-in device role to its shipped defaults?”
“Can I undo my customizations to a system role?”
Tell an agent
Restore system role {roleId} to shipped defaults.
Reset the built-in role {roleId}.
GET /api/v1/device-role/{roleId}/assignments/- List devices assigned a role · Returns role assignments to devices #
Ask an LLM
“Which devices is a particular role assigned to?”
“Can I filter the devices for one role's assignments?”
Tell an agent
List devices assigned role {roleId}.
Show assignments of role {roleId} for devices matching {deviceFilter}.
GET /api/v1/device-role/-/assignments/- List all device role assignments · Returns all role assignments to devices #
Ask an LLM
“What roles are assigned to every device across the system?”
“Can I include roles that aren't assigned to any device?”
Tell an agent
List all role assignments for {kind} roles.
List every device role assignment, including unassigned roles.
GET /api/v1/device-role/- List device roles · Return set of device roles #
Ask an LLM
“Which device roles exist in my library?”
“Can I list only enabled roles of a certain kind?”
Tell an agent
List device roles named {name}.
Search device roles for {search}, enabled only.
GET /api/v1/device-role/-/config/template Get templates for many device roles · Return set of device role templates #
Ask an LLM
“Can I pull configuration templates for a whole set of roles at once?”
“What bulk template export options exist for roles of a given source?”
Tell an agent
Get role templates for all {kind} roles.
Fetch templates for roles from source {source} with options {options}.
PATCH /api/v1/device-role/-/config/template Apply multiple device role templates · Apply multiple device role templates #
Ask an LLM
“How do I apply a batch of role templates to this system?”
“Can several device role templates be applied in one call?”
Tell an agent
Apply these role templates: {templates}.
Apply templates {templates} with options {options}.
POST /api/v1/device-role/-/config/export/content Preview the contents of an export package · Inventory of a package based on options #
Ask an LLM
“Before exporting, can I see what roles, monitors and icons a package would contain?”
“What would end up inventoried in an export package with my chosen options?”
Tell an agent
Inventory the export package {pkg} before generating it.
Preview package {pkg} contents for roles {roles}.
POST /api/v1/device-role/-/config/export Export roles as a package for another system · Generate a package for delivery to another WhatsUp Gold System #
Ask an LLM
“How do I move device roles to another WhatsUp Gold system?”
“Can I sign the exported role package with keys?”
Tell an agent
Generate export package {pkg} with roles {roles}.
Build a delivery package {pkg} including monitors {monitors}.
POST /api/v1/device-role/-/config/import/verify Verify a role package before import · Inventory/Verify the contents of the a package #
Ask an LLM
“Can I check an incoming role package before importing it?”
“What's inside a package someone sent me?”
Tell an agent
Verify package {pkg} without applying it.
Inventory the contents of import package {pkg}.
POST /api/v1/device-role/-/config/import Import and apply a role package · Apply a package #
Ask an LLM
“How do I import a device role package exported from another system?”
“Can I choose which parts of a package get applied on import?”
Tell an agent
Import and apply package {pkg}.
Apply package {pkg} using apply settings {apply}.
GET /api/v1/device-role/-/percentVariables List percent variables by type · Return a list of percent variables by type #
Ask an LLM
“What percent variables are available for device roles?”
“Can I list percent variables of only one type?”
Tell an agent
List percent variables of type {choice}.
Show all available percent variables.

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://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-devicerole-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-devicerole-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-devicerole-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v1
  title: WhatsUp Gold Device Role 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 (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/progress-software/refs/heads/main/openapi/progress-software-devicerole-api-openapi.yml