---
title: "Get Enterprise Search Inventory"
method: GET
path: "/enterprise-search/inventories/{edge_id}"
tags: ["Enterprise Search"]
---

# Get Enterprise Search Inventory

`GET /enterprise-search/inventories/{edge_id}`

## Request

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

## Path parameters

- `edge_id` string, uuid, required

## Response `200`

Enterprise search inventory retrieved successfully

- EnterpriseSearchEdgeInventoryDto: Response shape for GET /enterprise-search/inventories/{edge_id}, POST /enterprise-search/inventories, and PATCH /enterprise-search/inventories/{edge_id}.
  - `edge_id` string, uuid, required
  - `edge_name` string, required
  - `edge_description` string, required
  - `edge_serial` string, required
  - `days_until_expiry` integer, nullable: Days until the first volume on this edge expires.
  - `search_inventory_status` 'Not Activated' | 'Preparing for Volume Inventory' | 'Volume Inventory In Progress' | 'Ready to Activate' | 'Volume Inventory Failed' | 'Volume Inventory Expired' | 'Removal Pending' | 'Removed' | 'Unknown', required: Enterprise Search volume-inventory lifecycle status. Owned by Enterprise Search — deliberately not shared with or aliased from AI Activate, since the two features are independently licensed and their lifecycles may diverge. Values are listed in the order they occur in the inventory lifecycle.
  - `file_count` integer, nullable: Sum of the reported per-volume file counts on this edge. Volumes whose count NOC has not reported yet are excluded, so this can undercount until every volume has data; null when no volume has reported a count.
  - `volumes` EnterpriseSearchInventoryVolumeDto[], required
    - `volume_guid` string, required
    - `volume_name` string, required
    - `provider` string, required: Provider used to execute inventory indexing. This should match the volume cloud provider, for example AWS or Azure.
    - `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.
    - `days_until_expiry` integer, nullable: Days until this volume's inventory expires.
    - `status` 'Not Activated' | 'Preparing for Volume Inventory' | 'Volume Inventory In Progress' | 'Ready to Activate' | 'Volume Inventory Failed' | 'Volume Inventory Expired' | 'Removal Pending' | 'Removed' | 'Unknown', required: Enterprise Search volume-inventory lifecycle status. Owned by Enterprise Search — deliberately not shared with or aliased from AI Activate, since the two features are independently licensed and their lifecycles may diverge. Values are listed in the order they occur in the inventory lifecycle.
    - `file_count` integer, nullable: Number of files included in the volume inventory. May be unavailable until inventory data is ready.
    - `volume_size` string, nullable: Human-readable volume size string e.g. '10.5 TB'. May be unavailable until the volume is fully indexed.

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions
- `404`: Resource not found
- `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)