/v1/smb/shares/{id} | Qumulo Documentation

Endpoint

/v1/smb/shares/{id}

GET

Retrieve the specified SMB share. Refer to the 'Modify SMB share' method for a description of the returned fields.

Parameters

Name	Description	Required
`id`	The unique ID of the SMB share	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_smb_share",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique ID of the SMB share",
      "type": "string"
    },
    "share_name": {
      "description": "The SMB share name",
      "type": "string"
    },
    "fs_path": {
      "description": "The filesystem path to SMB share",
      "type": "string"
    },
    "description": {
      "description": "Description of this SMB share",
      "type": "string"
    },
    "read_only": {
      "description": "Sets the SMB share to read-only",
      "type": "boolean"
    },
    "allow_guest_access": {
      "description": "Allows guest access to this SMB share",
      "type": "boolean"
    },
    "access_based_enumeration_enabled": {
      "description": "Enable Access-based Enumeration on this SMB share",
      "type": "boolean"
    },
    "default_file_create_mode": {
      "description": "Default POSIX file create mode bits on this SMB share (octal, default 0644 if this field is empty)",
      "type": "string"
    },
    "default_directory_create_mode": {
      "description": "Default POSIX directory create mode bits on this SMB share (octal, default 0755 if this field is empty)",
      "type": "string"
    },
    "tenant_id": {
      "description": "The tenant ID of the tenant that the SMB share is a part of",
      "type": "number"
    }
  }
}

PUT

Modify an SMB share's options.

Parameters

Name	Description	Required
`id`	The unique ID of the SMB share	Yes
`allow-fs-path-create`	Specifies whether the file system path can be created if it does not already exist.	No
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_smb_share",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique ID of the SMB share",
      "type": "string"
    },
    "share_name": {
      "description": "The SMB share name",
      "type": "string"
    },
    "fs_path": {
      "description": "The filesystem path to SMB share",
      "type": "string"
    },
    "description": {
      "description": "Description of this SMB share",
      "type": "string"
    },
    "read_only": {
      "description": "Sets the SMB share to read-only",
      "type": "boolean"
    },
    "allow_guest_access": {
      "description": "Allows guest access to this SMB share",
      "type": "boolean"
    },
    "access_based_enumeration_enabled": {
      "description": "Enable Access-based Enumeration on this SMB share",
      "type": "boolean"
    },
    "default_file_create_mode": {
      "description": "Default POSIX file create mode bits on this SMB share (octal, default 0644 if this field is empty)",
      "type": "string"
    },
    "default_directory_create_mode": {
      "description": "Default POSIX directory create mode bits on this SMB share (octal, default 0755 if this field is empty)",
      "type": "string"
    },
    "tenant_id": {
      "description": "The tenant ID of the tenant that the SMB share is a part of",
      "type": "number"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_smb_share",
  "type": "object",
  "properties": {
    "id": {
      "description": "The unique ID of the SMB share",
      "type": "string"
    },
    "share_name": {
      "description": "The SMB share name",
      "type": "string"
    },
    "fs_path": {
      "description": "The filesystem path to SMB share",
      "type": "string"
    },
    "description": {
      "description": "Description of this SMB share",
      "type": "string"
    },
    "read_only": {
      "description": "Sets the SMB share to read-only",
      "type": "boolean"
    },
    "allow_guest_access": {
      "description": "Allows guest access to this SMB share",
      "type": "boolean"
    },
    "access_based_enumeration_enabled": {
      "description": "Enable Access-based Enumeration on this SMB share",
      "type": "boolean"
    },
    "default_file_create_mode": {
      "description": "Default POSIX file create mode bits on this SMB share (octal, default 0644 if this field is empty)",
      "type": "string"
    },
    "default_directory_create_mode": {
      "description": "Default POSIX directory create mode bits on this SMB share (octal, default 0755 if this field is empty)",
      "type": "string"
    },
    "tenant_id": {
      "description": "The tenant ID of the tenant that the SMB share is a part of",
      "type": "number"
    }
  }
}

DELETE

Delete an SMB share. Not undoable.

Parameters

Name	Description	Required
`id`	The unique ID of the SMB share	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
200	Return value on success