---
title: "Get Ai Activate Inventory"
method: GET
path: "/ai_activate/inventories/{volume_id}"
tags: ["AI Activate"]
---

# Get Ai Activate Inventory

`GET /ai_activate/inventories/{volume_id}`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/ai_activate/inventories/{volume_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/ai_activate/inventories/:volume_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get AI Activate inventory for a specific volume.

## Path parameters

- `volume_id` string, required

## Response `200`

AI Activate inventory retrieved successfully

- AiActivateInventoryDto
  - `volume_guid` string, required
  - `volume_name` string, required
  - `provider` string, required: Provider used to execute inventory indexing, for example AWS or Azure.
  - `volume_provider` string: 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_region` string, nullable: API-provided volume region (default NDS region unless changed by the user).
  - `region` string, 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_count` integer, nullable: Number of files included in the volume inventory. May be unavailable until inventory data is ready.
  - `billable_file_count` integer, nullable: Content-indexed files counted against the subscription. Null when usage has not been collected.
  - `metadata_only_file_count` integer, nullable: Metadata crawl files without extracted content. Null when usage has not been fully collected.
  - `volume_size` string, nullable: Human-readable volume size string e.g. '10.5 TB'. May be unavailable until the volume is fully indexed.
  - `removal_deadline_at` string, 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.

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions
- `404`: Resource not found
- `408`: Request timeout
- `422`: Invalid input data
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)