The CloudRadial AutomationAI CloudRadial v2 API extensions let a workflow or agent read and change the data in your CloudRadial portal through the CloudRadial v2 API: companies and portal users, managed endpoints, training, portal content, services and products, compliance and assets, feedback and archives, and per-company tokens. This article covers which of the eight extensions to install for what, the one API key pair they all share, which tools require approval, and the skills that ship with them. It is for workspace users who build automations (Admin or Owner Role).
- What the Extensions Cover
- Choosing Which Extensions to Install
- Creating the API Key
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With CloudRadial Data
What the Extensions Cover
The CloudRadial v2 API is split into eight extensions by area, so that no single extension carries more tools than an agent can load at once. Together they provide 163 tools: 58 that only read data and 105 that create, change, or delete records.
| Extension | What you can automate | Tools |
| CloudRadial v2 API — Companies & Users | Read and create, update, or delete companies, portal users, company groups, and managed domains; add a company to a group or remove it | 28: 10 reads, 18 approval-gated |
| CloudRadial v2 API — Endpoints | Read and create, update, or delete managed endpoints, the applications installed on them, and per-device custom properties | 18: 6 reads, 12 approval-gated |
| CloudRadial v2 API — Training | Read and create, update, or delete courses, course lessons, and lesson completion history; enroll a user in a course, update an enrollment, and mark an enrollment completed | 23: 8 reads, 15 approval-gated |
| CloudRadial v2 API — Content | Read and create, update, or delete knowledge-base articles, quickstart guides, menus, media items, service catalogs, and catalog questions | 36: 12 reads, 24 approval-gated |
| CloudRadial v2 API — Services & Products | Read and create, update, or delete services, service installations (where each service is installed), and product catalog entries | 18: 6 reads, 12 approval-gated |
| CloudRadial v2 API — Compliance & Assets | Read security assessments and import questions from an assessment template into another assessment; read and create, update, or delete certificates; read and manage flexible assets, flexible asset types, and their fields | 22: 10 reads, 12 approval-gated |
| CloudRadial v2 API — Feedback & Archives | Read and create, update, or delete submitted feedback (CSAT ratings and comments) and archived report items | 12: 4 reads, 8 approval-gated |
| CloudRadial v2 API — Tokens | Read and create, update, or delete per-company integration tokens | 6: 2 reads, 4 approval-gated |
Install each one from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Choosing Which Extensions to Install
Install only the extensions for the areas your automations work with. For example:
- To look up a client or a portal user, or to add users and companies, install Companies & Users
- To report on devices and the software installed on them, install Endpoints. Install Services & Products as well if you also need to see which services run on each endpoint.
- To enroll users in training and track completion, install Training
- To create or update knowledge-base articles, quickstarts, menus, or service catalogs, install Content
- To work with assessments, certificates, or flexible assets, install Compliance & Assets
- To report on CSAT feedback or archived reports, install Feedback & Archives
- To set token values per company, install Tokens
All eight extensions use the same three secrets, so one API key pair serves every part. Adding another extension later needs no new credentials. There is no read-only version of these extensions; instead, every tool that changes data requires approval, as described below.
Creating the API Key
The extensions sign in to the CloudRadial v2 API with HTTP Basic authentication, using an API key pair: the public key is the username and the private key is the password. To create a key pair in CloudRadial, go to Settings > Integrations > API and select + Add API Key. Copy the private key when CloudRadial shows it; it is shown only once, at creation.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names. All eight extensions read the same three secrets.
| Secret | Value |
CloudRadial-BaseUrl |
The regional API root for your CloudRadial portal, with no trailing slash, for example https://api.us.cloudradial.com. Other regions use their own root, such as https://api.eu.cloudradial.com or https://api.au.cloudradial.com. |
CloudRadial-PublicKey |
The API public key |
CloudRadial-PrivateKey |
The API private key |
For how to add secrets, see Accessing and updating your runner's Key Vault. Once the secrets are in place, ask the AI Playground to list a few of your CloudRadial companies to confirm the connection works.
Reads and Approval-Gated Changes
Of the 163 tools, the 58 that list or read records run without interruption. The other 105 create, change, or delete a record, and every one of them is approval-gated: the run pauses and the request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox. Write tools never run in a dry run.
| Tool behavior | Tools |
| Approval-gated | Every create, replace, partial update, and delete in all eight extensions, plus enrolling a user in a course, marking an enrollment completed, and importing assessment template questions |
| Read-only | Every list and get tool in all eight extensions |
Most records offer two kinds of update, and the difference matters when you approve one:
- A replace is a full update. Any field the request leaves out is removed or set to empty.
- A partial update sends only the fields you supply and leaves the rest of the record as it is
Deletes are soft deletes where CloudRadial supports them. Before you approve a write, check the record and company the agent names.
Skills
Each extension ships two skills: one that only reads and one that makes approval-gated changes.
| Skill | Use it to |
| Query Companies & Users | Look up and report on companies, portal users, company groups and their membership, and managed domains. Read-only. |
| Manage Companies & Users | Create, update, or delete companies, portal users, company groups, group membership, and managed domains. Changes are approval-gated. |
| Query Endpoints | Look up and report on managed endpoints, the applications installed on them, and per-device custom properties. Read-only. |
| Manage Endpoints | Create, update, or delete managed endpoints, their installed applications, and per-device custom properties. Changes are approval-gated. |
| Query Training | Look up and report on courses, course lessons, user enrollments, and lesson completion history. Read-only. |
| Manage Training | Create, update, or delete courses, course lessons, user enrollments, and lesson completion history. Changes are approval-gated. |
| Query Content | Look up and report on knowledge-base articles, quickstart guides, menus, media items, service catalogs, and catalog questions. Read-only. |
| Manage Content | Create, update, or delete knowledge-base articles, quickstart guides, menus, media items, service catalogs, and catalog questions. Changes are approval-gated. |
| Query Services & Products | Look up and report on services, where each service is installed, and product catalog entries. Read-only. |
| Manage Services & Products | Create, update, or delete services, service installations, and product catalog entries. Changes are approval-gated. |
| Query Compliance & Assets | Look up and report on security assessments, certificates, and flexible assets with their types and fields. Read-only. |
| Manage Compliance & Assets | Import questions from an assessment template into another assessment, and create, update, or delete certificates and flexible assets with their types and fields. Changes are approval-gated. |
| Query Feedback & Archives | Look up and report on submitted feedback (CSAT ratings and comments) and archived report items. Read-only. |
| Manage Feedback & Archives | Create, update, or delete submitted feedback and archived report items. Changes are approval-gated. |
| Query Tokens | Look up and report on per-company integration tokens. Read-only. |
| Manage Tokens | Create, update, or delete per-company integration tokens. Changes are approval-gated. |
Tips for Working With CloudRadial Data
- Most records belong to a company. Name the company when you ask for data, so the agent filters on it instead of reading every company's records.
- Ask the agent to find a record first and confirm it is the right one before it changes anything. Writes act on a record's id, and the agent resolves the id from a read.
- Prefer a partial update to a replace when you change one or two fields, so the rest of the record is left alone
- In flexible assets, each field on an asset type becomes a key on its assets: the field name in lowercase, with spaces replaced by hyphens. For example, Serial Number becomes
serial-number. - Updating a flexible asset's field values replaces all of them at once, so the agent reads the asset, edits the values, and sends every value back. To avoid duplicates when a workflow re-runs, have it match existing assets on a stable value, such as a serial number, before it creates one.
- Creating a token also updates it if it already exists. A token with a company id of
0is global and usable by every company; a token with a specific company id applies to that company only. A token's type sets how its value is read:1for a string (the default),3for an email address, or4for HTML. - Creating an archived report item does not upload an attachment
- Companies & Users can also be the source for your AutomationAI company registry. By default, the import uses each company's PSA key (
psaKey) as its Company ID and skips companies that have none. See Importing companies from an installed extension.
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.