Endpoint

/v1/smb/shares/

GET

List all SMB shares. Refer to the 'Modify SMB share' method for a description of the returned fields.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "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"
      }
    }
  }
}

POST

Add an SMB share with given options.

Parameters

Name Description Required
allow-fs-path-create Specifies whether the file system path can be created if it does not already exist. No

Request

Schema

{
  "description": "api_smb_share_post",
  "type": "object",
  "properties": {
    "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"
    }
  }
}

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"
    }
  }
}