Before you start
- An Iru API token with MCP turned on and permissions that cover the calls below (recipe 1).
- Know which category the auditor needs and whether it should cover every blueprint and device family.
Prompt for your agent
I need a Prism export for an auditor. Before you request anything, tell me the category, the blueprint_ids, the device_families, the filter and the sort_by you plan to send, then stop and wait for my approval. Tell me which category value you chose. After I approve, request the export with POST /api/v1/prism/export and show me the id it returns. Then check GET /api/v1/prism/export/{export_id} until status reads success. If it never reads success, show me status and error_msg. When it succeeds, show me the signed_url so I can download the CSV.
Steps
Choose the category and scope
Each export covers one category. Have the agent confirm the category, the optional
blueprint_idsanddevice_families, and anyfilterorsort_bybefore it requests anything.The API documents these category values:
apps,activation_lock,desktop_and_screensaver,device_information,gatekeeper_and_xprotect,installed_profiles,kernel_extensions,local_users,launch_agents_and_daemons,system_extensions,startup_settingsandtransparency_database.Approval requiredThe agent lists the category and scope and waits. Approve once they match what the auditor asked for.
Source: Iru API: Request category export
Request the export
The call returns an
idand astatusof pending. The agent keeps theidto check the export.POST/api/v1/prism/exportSource: Iru API: Request category export
Check the status and download the file
Poll with the
iduntilstatusreads success. The response then carries asigned_url, and opening it downloads a CSV file of the exported category. If the export fails, the response carries anerror_msg.GET/api/v1/prism/export/{export_id}Source: Iru API: Get category export
Export from the web app instead
Open Devices, select the Prism tab and open the category. Select Export CSV, choose Current View or All Attributes, then select Start export.
Current View includes only the data visible in the table plus any applied filters. All Attributes includes every column for the category.
Source: Prism
Common pitfalls
- Only one category goes into each export request. For several categories, request several exports.
- The category list in the API docs doesn't include every category that Prism shows in the web app, such as Cellular. For a category that isn't listed, use Export CSV in Prism.
- Collection frequency differs by category, from every 15 minutes to every 24 hours, so an export reflects the last collection for that category.
FAQ
Which API calls export a Prism category?
POST /api/v1/prism/export starts the export and returns an id. GET /api/v1/prism/export/{export_id} returns its status and the signed_url for the CSV.
Can one export hold several categories?
No. Each export request takes one category.
How do I export from the web app?
Open the category in Prism, select Export CSV, choose Current View or All Attributes, then select Start export.
What does the export contain?
A CSV file of the category. The category, filter, sort_by, blueprint_ids and device_families you send decide which rows it holds.