Breaking Change: Assertions Field Required for Asset Filter-Based API Endpoints
This article describes a breaking API behavior change for asset filter-based bulk operations.
What changed
Section titled “What changed”For API endpoints that execute actions by asset filter, the assertions object is now required in the request body.
Previously, this field could be omitted.
You must include:
{
"assertions": {
"failIfNumberOfAssetsGreaterThan": NUMBER
}
}
Why this change was introduced
Section titled “Why this change was introduced”This safety control reduces the risk of unintended bulk operations caused by broad or incorrect filters.
When failIfNumberOfAssetsGreaterThan is set, the request fails instead of executing if the filter matches more assets than expected.
This helps prevent accidental high-impact actions across large asset sets.
Affected asset filter API endpoints
Section titled “Affected asset filter API endpoints”The following API endpoints include assertions and should be treated as requiring this field:
| Endpoint | Docs |
|---|---|
/api/public/acquisitions/acquire | Open |
/api/public/acquisitions/acquire/image | Open |
/api/public/triages/triage | Open |
/api/public/full-text-search-tasks | Open |
/api/public/auto-asset-tag/start-tagging | Open |
/api/public/baseline/acquire | Open |
/api/public/assets/tasks/reboot | Open |
/api/public/assets/tasks/shutdown | Open |
/api/public/assets/tasks/isolation | Open |
/api/public/assets/tasks/retrieve-logs | Open |
/api/public/assets/tasks/version-update | Open |
/api/public/assets/uninstall-without-purge | Open |
/api/public/assets/purge-and-uninstall | Open |
/api/public/assets/purge-without-uninstall | Open |
Request pattern example
Section titled “Request pattern example”The full request body varies by endpoint, but the assertions pattern is shared:
{
"assertions": {
"failIfNumberOfAssetsGreaterThan": NUMBER
},
"...": "other specific fields"
}
Required action for API consumers
Section titled “Required action for API consumers”- Update all integrations that call the affected endpoints.
- Add
assertions.failIfNumberOfAssetsGreaterThanto each request body. - Set the threshold based on your operational safety limits.
- Validate behavior in a non-production environment before rollout.