---
title: "Get Samba shares"
method: GET
path: "/samba/shares"
tags: ["Samba"]
---

# Get Samba shares

`GET /samba/shares`

## Request

- Base URL: `https://sylve.lan:8181/api`
- URL: `https://sylve.lan:8181/api/samba/shares`
- Auth: API key in header `Authorization`

Retrieve all configured Samba shares

## Response `200`

Success

- GithubComAlchemillahqSylveInternalAPIResponseArrayInternalHandlersSambaSambaShareResponse
  - `data` InternalHandlersSambaSambaShareResponse[]
    - `auditEnabled` boolean
    - `auditRetentionDays` integer
    - `auditedOperations` string[]
    - `createMask` string
    - `createdAt` string
    - `dataset` string
    - `directoryMask` string
    - `enabled` boolean
    - `extraShareConfig` string
    - `guest` InternalHandlersSambaSambaGuestResponse
      - `enabled` boolean
      - `writeable` boolean
    - `id` integer
    - `name` string
    - `permissions` InternalHandlersSambaSambaPermissionsResponse
      - `read` InternalHandlersSambaSambaPrincipalSetResponse
        - `directory` GithubComAlchemillahqSylveInternalDbModelsDirectoryservicesPrincipal[]
          - `kind` string
          - `name` string
          - `sid` string
          - `unixId` integer
        - `groups` InternalHandlersSambaSambaPrincipalGroupResponse[]
          - `id` integer
          - `name` string
        - `users` InternalHandlersSambaSambaPrincipalUserResponse[]
          - `id` integer
          - `username` string
      - `write` InternalHandlersSambaSambaPrincipalSetResponse
        - `directory` GithubComAlchemillahqSylveInternalDbModelsDirectoryservicesPrincipal[]
          - `kind` string
          - `name` string
          - `sid` string
          - `unixId` integer
        - `groups` InternalHandlersSambaSambaPrincipalGroupResponse[]
          - `id` integer
          - `name` string
        - `users` InternalHandlersSambaSambaPrincipalUserResponse[]
          - `id` integer
          - `username` string
    - `timeMachine` boolean
    - `timeMachineMaxSize` integer
    - `updatedAt` string
  - `error` string
  - `message` string
  - `status` string

## Other responses

- `500`: Internal Server Error

## Changes

- **2026-08-12** `9a5026bf9057`: 1 info
  - the endpoint scheme security `BearerAuth` was added to the API
- **2025-08-14** `0e0247c98990`: 1 info
  - endpoint added
- **2025-03-11** `2b736ca1b025`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/alchemillahq/apis/sylve-api/changes/samba/shares/get.md)

---

[API](https://skmtc.dev/alchemillahq/apis/sylve-api.md) - [All operations](https://skmtc.dev/alchemillahq/apis/sylve-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alchemillahq/apis/sylve-api/revisions/9565cdd0abf5?raw)