NAnasuni
AI Activate

Get Ai Activate Inventory

Get AI Activate inventory for a specific volume.

get/ai_activate/inventories/{volume_id}

Request

Path parameters

volume_idstring required

Response

AI Activate inventory retrieved successfully

volume_guidstring required
volume_namestring required
providerstring required

Provider used to execute inventory indexing, for example AWS or Azure.

volume_providerstring

Cloud provider backing the source volume, for example Amazon S3 or Azure. Defaults to the index execution provider when omitted by an older Portal WebAPI deployment.

volume_regionstring nullable

API-provided volume region (default NDS region unless changed by the user).

regionstring nullable

Region used to execute inventory indexing. For AWS volumes, this must match the volume storage region. For Azure volumes, this must be a supported Azure location code; if different from the volume storage region, it may incur egress costs. May be null for volumes that have not been configured for indexing.

status'Not Activated' | 'Preparing for Volume Inventory' | 'Volume Inventory In Progress' | 'Ready to Activate' | 'Activation In Progress' | 'Active' | 'Paused' | 'Volume Inventory Failed' | 'Activation Failed' | 'Volume Inventory Expired' | 'Removal Pending' | 'Removed' | 'Unknown' required
file_countinteger nullable

Number of files included in the volume inventory. May be unavailable until inventory data is ready.

billable_file_countinteger nullable

Content-indexed files counted against the subscription. Null when usage has not been collected.

metadata_only_file_countinteger nullable

Metadata crawl files without extracted content. Null when usage has not been fully collected.

volume_sizestring nullable

Human-readable volume size string e.g. '10.5 TB'. May be unavailable until the volume is fully indexed.

removal_deadline_atstring date-time nullable

Instant after which a requested removal stops being reversible. Null when no removal is pending for the volume, and on NOC deployments that predate the field.

Changes

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