The CloudRadial AutomationAI Addigy extension lets a workflow or agent work with the Apple devices you manage in Addigy: search Macs, iPhones, iPads, and Apple TVs and read their facts, review policies, configuration profiles, installed software, and monitoring alerts, and, with approval, run a shell command, restart a device, create a maintenance item, or create a policy. This article covers what the extension can do, the API token and secrets it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API Token
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Addigy Data
What the Extension Covers
The extension calls the Addigy API v2 and provides 15 tools across these areas:
| Area | What you can automate |
| Devices | Search devices by policy, by a free-text term such as a serial number, or by device facts; read facts such as OS version, serial number, model, and disk; read one device's MDM details, including its enrollment profile, APN certificate, and last MDM response; and list the software installed on one or more devices |
| Policies and profiles | List policies, list your MDM configuration profiles, list the profiles attached to a policy, and create a policy, optionally under a parent policy |
| Organizations | List the child organizations of an organization |
| Device actions | Run a shell command on one or more devices and read back its output, and send an MDM restart to a device |
| Maintenance | List maintenance items and create one. A maintenance item is a reusable software or maintenance task that can be attached to policies. |
| Monitoring alerts | List received alerts, filtered by status: all, unattended, acknowledged, or resolved |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Creating the API Token
The extension signs in to Addigy with an API v2 token, sent as a bearer token on every request.
- In Addigy, go to Account > Integrations > API & Webhooks. Creating a token requires the Create Integrations API Keys user permission.
- In the Addigy API section, select New API Token.
- Choose only the permissions the tools you plan to use need. For example, device search and installed-software queries need View Devices, and running commands on devices needs Execute Commands. Addigy rejects a call the token lacks permission for with an HTTP 403 (Forbidden) error.
- Copy the token right away and store it securely. Addigy does not show it again.
Providing the Credentials to Your Runner
Store two secrets in your runner's Key Vault with these exact names:
| Secret | Value |
Addigy-ApiUrl |
The Addigy API base URL, normally https://api.addigy.com/api/v2
|
Addigy-ApiToken |
The API v2 token you created in Addigy |
Store the token as Addigy issued it; the extension adds the bearer prefix for you. For how to add secrets, see Accessing and updating your runner's Key Vault.
Reads and Approval-Gated Changes
Of the 15 tools, 11 only read data and run without approval. The other four act on devices or change your Addigy configuration, so they pause the run for approval. The request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Run a shell command on devices; send an MDM restart to a device; create a maintenance item; create a policy |
| Read-only | Search devices; read device facts; read a device's MDM details; list installed software; list configuration profiles; list a policy's profiles; list policies; list child organizations; list alerts; list maintenance items; read a command's output |
A shell command runs on every device you target, so review the command and the device list carefully before you approve it.
Skills
The extension ships four skills that guide an agent through common Addigy tasks:
| Skill | Use it to |
| Inventory Apple Devices | Find, list, or report on Macs, iPhones, and iPads by policy or search term, with their facts, MDM details, or installed software. Read-only. |
| Manage Policies | List policies, see which configuration profiles a policy applies, list organizations, or create a policy. Creating a policy is approval-gated. |
| Run Device Actions | Run a shell command, restart a device, or create a maintenance item, and read back the result. Actions and creates are approval-gated. |
| Review Alerts | Review unattended, acknowledged, or resolved monitoring alerts across the organization. Read-only. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With Addigy Data
- Policy lists and installed-software lists span all of your descendant organizations. Creating a policy, running a command, reading command output, and listing child organizations act on one organization and need its organization id.
- Addigy has no single list of every organization. To discover them, the agent walks the child organizations down from your root organization.
- To list the devices in a policy, ask for a device search filtered by that policy
- Running a command returns an action id rather than the output. The agent then fetches the output with that id.
- Addigy limits API v2 tokens to 1,000 requests every 10 seconds. A workflow that loops over many devices one at a time can reach that limit.
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.