---
title: "Get Edge Shares"
method: GET
path: "/enterprise-search/edges/{edge_id}/shares"
tags: ["Enterprise Search"]
---

# Get Edge Shares

`GET /enterprise-search/edges/{edge_id}/shares`

## Request

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

Get every SMB share an appliance exposes for the volumes it connects.

Answers regardless of inventory state, so the Configure page can list an
eligible appliance's shares before anyone has inventoried it — the roster comes
from Web Access configuration, not from Search indexing. Only ``file_count``
waits on an inventory run, and it is always null here.

Returns 200 with an empty list for an appliance that exposes no shares.

Args:
    edge_id: The ID of the appliance whose shares should be returned

Returns:
    EnterpriseSearchEdgeSharesResponseDto: The appliance's share roster

## Path parameters

- `edge_id` string, uuid, required

## Response `200`

Appliance shares retrieved successfully

- EnterpriseSearchEdgeSharesResponseDto: Every SMB share one appliance exposes, regardless of inventory state. PM-1951: the roster comes from the appliance's own Web Access configuration, so it is known before any inventory runs — only the file counts wait on one.
  - `edge_id` string, uuid, required
  - `shares` EnterpriseSearchShareDto[]
    - `share_name` string, required
    - `path` string, required: Path within the volume that the share exposes.
    - `volume_guid` string, required
    - `volume_name` string, required
    - `provider` string, nullable, required
    - `volume_region` string, nullable: Storage region of the share's volume, or null when none is on record.
    - `web_access_enabled` boolean, required: The filer's Web Access toggle. Only enabled shares are indexed; disabled ones are reported so the UI can count them.
    - `file_count` integer, nullable: Always null today. NOC reports inventory file counts per volume, not per share, so a per-share number cannot be sourced without splitting a volume's total across its shares.

## 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)