Skip to content
SYLVE

Create a Samba share

POST
/samba/shares
curl --request POST \
  --url https://sylve.lan:8181/api/samba/shares \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "auditEnabled": true, "auditRetentionDays": 1, "auditedOperations": [ "example" ], "createMask": "example", "dataset": "example", "directoryMask": "example", "enabled": true, "guest": { "enabled": true, "writeable": true }, "name": "example", "permissions": { "read": { "groupIds": [ 1 ], "userIds": [ 1 ] }, "write": { "groupIds": [ 1 ], "userIds": [ 1 ] } }, "timeMachine": true, "timeMachineMaxSize": 1 }'

Create a Samba share with the specified settings

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Samba share settings

Media typeapplication/json
object
auditEnabled
boolean
auditRetentionDays
integer
auditedOperations
Array<string>
createMask
string
dataset
string
directoryMask
string
enabled
boolean
guest
object
enabled
boolean
writeable
boolean
name
string
permissions
object
read
object
groupIds
Array<integer>
userIds
Array<integer>
write
object
groupIds
Array<integer>
userIds
Array<integer>
timeMachine
boolean
timeMachineMaxSize
integer
Examplegenerated
{
  "auditEnabled": true,
  "auditRetentionDays": 1,
  "auditedOperations": [
    "example"
  ],
  "createMask": "example",
  "dataset": "example",
  "directoryMask": "example",
  "enabled": true,
  "guest": {
    "enabled": true,
    "writeable": true
  },
  "name": "example",
  "permissions": {
    "read": {
      "groupIds": [
        1
      ],
      "userIds": [
        1
      ]
    },
    "write": {
      "groupIds": [
        1
      ],
      "userIds": [
        1
      ]
    }
  },
  "timeMachine": true,
  "timeMachineMaxSize": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}