- Home
- Resources
- Net Folder Servers
GET /admin/net_folder_servers
Gets a list of Net Folder Servers.
Request Parameters
name |
type |
description |
default |
constraints |
include_full_details |
query |
If true, the Net Folder Server's sync_schedule is included in the response. Otherwise, it is not included. |
false |
boolean |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SearchResultList of NetFolderServer objects. |
application/xml |
searchResultList
(XML) |
POST /admin/net_folder_servers
Creates a new Net Folder Server.
The following Net Folder Server fields are mandatory:
- name
- driver_type
- server_path
- auth_type
- proxy_use_identity
- proxy_dn/proxy_password or proxy_identity
Response Body
media type |
data type |
description |
application/json |
NetFolderServer
(JSON) |
The full Net Folder Server object |
application/xml |
netFolderServer
(XML) |
GET /admin/net_folder_servers/{id}
Gets a Net Folder Server by ID
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the Net Folder Server |
long |
Response Codes
code |
condition |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
Response Body
media type |
data type |
description |
application/json |
NetFolderServer
(JSON) |
The Net Folder Server with the specified ID. |
application/xml |
netFolderServer
(XML) |
PUT /admin/net_folder_servers/{id}
Updates a Net Folder Server. Only the fields that are included in the request body are updated.
Updating the name of the Net Folder Server is not supported.
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Codes
code |
condition |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
Response Body
media type |
data type |
description |
application/json |
NetFolderServer
(JSON) |
The updated Net Folder Server. |
application/xml |
netFolderServer
(XML) |
DELETE /admin/net_folder_servers/{id}
Deletes a Net Folder Server.
The Net Folder Server cannot be deleted if it is hosting one or more Net Folders. You must delete all of the Net Folders
associated with the Net Folder Server prior to deleting the Net Folder Server.
Request Parameters
name |
type |
description |
constraints |
id |
path |
The ID of the Net Folder Server. |
long |
Response Codes
code |
condition |
204 |
The Net Folder Server is deleted successfully |
403 |
(NET_FOLDER_SERVER_IN_USE) The Net Folder Server is hosting one or more Net Folders. |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
GET /admin/net_folder_servers/{id}/net_folders
Gets Net Folders associated with a Net Folder Server.
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
The ID of the Net Folder Server |
|
long |
include_full_details |
query |
If true, the Net Folder sync schedule and the assigned users will be returned with each Net Folder result.
These require additional database lookups so are not returned by default. |
false |
boolean |
type |
query |
(optional) Accepted values are "net" and "home". If "home", only Home Directories will be returned. If "net",
Home Directories will be excluded. |
|
|
Response Codes
code |
condition |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
Response Body
media type |
data type |
description |
application/json |
SearchResultList
(JSON) |
A SaerchResultList of NetFolder objects. |
application/xml |
searchResultList
(XML) |
POST /admin/net_folder_servers/{id}/net_folders
Creates a new Net Folder associated with the specified Net Folder Server.
The following Net Folder fields are mandatory in the request body:
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Request Body
media type |
data type |
application/json |
NetFolder
(JSON) |
application/xml |
netFolder
(XML) |
Response Codes
code |
condition |
404 |
(NET_FOLDER_SERVER_NOT_FOUND) No Net Folder Server exists with the specified ID. |
409 |
(TITLE_EXISTS) A Net Folder already exists with the specified name. |
Response Body
media type |
data type |
description |
application/json |
NetFolder
(JSON) |
The full Net Folder object |
application/xml |
netFolder
(XML) |