purge_and_uninstall_assets
Remove data and uninstall specified assets using endpoint ID filters to optimize storage and manage resource allocation efficiently in the Binalyze AIR environment.
Instructions
Purge data and uninstall specific assets based on filters. Requires specifying filter.includedEndpointIds.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | Yes | Filter object to specify which assets to purge and uninstall. |
Input Schema (JSON Schema)
{
"properties": {
"filter": {
"description": "Filter object to specify which assets to purge and uninstall.",
"properties": {
"excludedEndpointIds": {
"description": "Array of endpoint IDs to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"groupFullPath": {
"description": "Filter by full group path.",
"type": "string"
},
"groupId": {
"description": "Filter by group ID.",
"type": "string"
},
"includedEndpointIds": {
"description": "REQUIRED: Array of endpoint IDs to purge and uninstall.",
"items": {
"type": "string"
},
"type": "array"
},
"ipAddress": {
"description": "Filter by IP address.",
"type": "string"
},
"isolationStatus": {
"description": "Filter by isolation status (e.g., [\"isolated\"]).",
"items": {
"type": "string"
},
"type": "array"
},
"issue": {
"description": "Filter by issue.",
"type": "string"
},
"managedStatus": {
"description": "Filter by managed status (e.g., [\"managed\"]).",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Filter by asset name.",
"type": "string"
},
"onlineStatus": {
"description": "Filter by online status (e.g., [\"online\"]).",
"items": {
"type": "string"
},
"type": "array"
},
"organizationIds": {
"description": "Organization IDs filter. Defaults to [0].",
"items": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"type": "array"
},
"platform": {
"description": "Filter by platform (e.g., [\"windows\"]).",
"items": {
"type": "string"
},
"type": "array"
},
"policy": {
"description": "Filter by policy.",
"type": "string"
},
"searchTerm": {
"description": "Optional search term.",
"type": "string"
},
"tagId": {
"description": "Filter by tag ID.",
"type": "string"
},
"version": {
"description": "Filter by agent version.",
"type": "string"
}
},
"required": [
"includedEndpointIds"
],
"type": "object"
}
},
"required": [
"filter"
],
"type": "object"
}