Device

Estimate device evidence deletion

Estimates the device evidence that would be deleted for the specified device IDs, grouped by datasource.

A datasource is included if it matches any datasource selector. If no datasource selectors are provided, evidence from every datasource associated with the specified devices is included.

The estimate reflects the inventory available when the request is made. Because inventory may change, it does not guarantee that a later request will delete the same evidence.

Client guidance

  • Submit no more than 500 unique device IDs per request. This recommendation is not enforced, but larger requests provide no processing benefit and may increase latency or timeout risk.
  • Split larger workloads into batches and process them sequentially. Use the same datasource selectors for every batch in one logical operation.
  • There is currently no specific concurrency limit or hard cap in place. We recommend that customers test and tune their request volume based on their network conditions, performance requirements, and business needs.
  • The API does not automatically retry failed estimate requests. Clients may retry transient failures using exponential backoff with jitter.
post/vis/v2/orgs/{orgId}/devices/delete/estimate

Request

Path parameters

orgIdinteger required

The unique identifier for the organization

Example:100

Request body

deviceIdsstring[] required

Device IDs whose evidence should be included. Send no more than 500 unique IDs per request; this recommendation is not enforced by the API.

Example request

{
  "datasourceSelectors": [
    {
      "field": "id",
      "value": "a8d416e5-7212-4a9a-93f3-0b8602ad06f4"
    }
  ],
  "deviceIds": [
    "4e0e3471-ccbc-41c7-a21e-c384f2eb5669"
  ]
}

Response

OK response.

countinteger required

The number of devices whose evidence is selected

datasourceIdstring required

The ID of the datasource

datasourceNamestring required

The name of the datasource

datasourceTypestring required

The type of the datasource

kind'vis:device-deletion-summary' required

The resource's type

Example response

[
  {
    "count": 150,
    "datasourceId": "4e0e3471-ccbc-41c7-a21e-c384f2eb5669",
    "datasourceName": "SCCM_PROD_AP",
    "datasourceType": "SCCM",
    "kind": "vis:device-deletion-summary"
  },
  {
    "count": 42,
    "datasourceId": "a8d416e5-7212-4a9a-93f3-0b8602ad06f4",
    "datasourceName": "ServiceNow Import",
    "datasourceType": "ServiceNow",
    "kind": "vis:device-deletion-summary"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.