Viewing the Status of a Blueprint (Jamf Pro API) - Jamf Pro Blueprints Configuration Guide

Best Practice:

Viewing Blueprint Status with the Platform API

For faster fleet-level status checks, use the Platform API instead of querying each device individually. Retrieve an aggregate success and failure count for the blueprint from the blueprint status report. To see which devices are assigned to a specific blueprint, use the declaration report. To review all declarations reported by a single device, including structured failure reasons, use the device report. Use the workflow in this task for cases where you need the raw declaration payload returned directly by Jamf Pro.

For more information, see the following in the Platform API Reference:

You can use the Jamf Pro API to view the raw data of declarative device management reporting, allowing you to see the validation and installation status of a deployed blueprint.

This can be useful to track hosting or formatting errors of custom-deployed components like Service configuration files or Service background tasks, where a declaration can successfully install from Jamf Pro, but the instructions to install an object may fail to complete.

Installed declarations can be both an asset or configuration type, depending on the blueprint. For example:

A blueprint with a Service configuration files component will contain an asset from a hosted ZIP file and an associated configuration declaration object that defines how the asset is used.
A blueprint with a Service background tasks component will contain a mix of asset and configuration declarations. Any deployed ZIP or PLIST file is considered an asset, and a configuration declaration object that defines how the assets are used.

Requirements

The client management ID of the device. This is the "Jamf Pro Management ID" in the computer or device inventory record.
The blueprint ID. This is not required to use the Jamf Pro API, but the blueprint ID helps correlate status information with specific blueprint objects in the response.
To find the blueprint ID, navigate to a blueprint you have deployed and view the identifier at the end of the URL. For example: https://JAMF_PRO_URL.jamfcloud.com/view/mfe/blueprints/31e67fa3-45e6-413c-81f6-3c1e01856df6

In the Jamf Pro API, click declarative-device-management to view its endpoints, and then click GET /v1/declarative-device-management/{clientManagementId}/status-items
Click Try It Out.
In the clientManagementId field, enter the Jamf Pro Management ID of the device.

Click Execute.

If your deployed blueprint had multiple objects within it, each component has a separate declaration and status associated with it.

Example:

In the example below, the blueprint contains three configuration objects that are associated with the same blueprint ID.

{
  "key": "management.declarations.configurations",
  "value": "{active=true, identifier=Blueprint_5ceed44c-bed7-40b5-8c52-46e6bc7ea6e5_s1_c1_cfg1, valid=valid, server token=87906e1f60769c956e75719b84a64c21a7d6101b0874bb9c3f9b33deca99171e},{active=true, identifier=Blueprint_5ceed44c-bed7-40b5-8c52-46e6bc7ea6e5_s1_c2_cfg1, valid=valid, server-token=ba335e40f293939797707cf5df0e816a79a14f795bcee2577d1f7799a693ba86},{active=true, identifier=Blueprint_5ceed44c-bed7-40b5-8c52-46e6bc7ea6e5_s1_c3_cfg1, valid=unknown, server-token=756426d52a780363db6193e095b5845abfb903ecd4a1c9ae63c9f52caba8e58d}",
  "lastUpdateTime": "2025-03-05T01:36:38.489"
}