MFT API - Folder Management 3.10.3

This API scope covers comprehensive folder management functionalities, including creation, retrieval, updating, deletion (CRUD), navigation, content search, sharing, status checks, and managing favorite folders.

All endpoints are accessed relative to the base URL: http://localhost:8010/vault_rest.

Authentication for most endpoints requires an API key provided in the Authorization header as a Bearer token. The API key can be obtained from the "Request An API Key" endpoint.

Server

http://localhost:8010

Authentication

http bearerAuth

Bearer token obtained from the /authenticate endpoint.

http basicAuth

Basic authentication using username and password.

Folder Management

Operations for creating, retrieving, updating, and deleting folders, as well as navigating and searching folder contents.

GET

/vault_rest/folder_content/{folderGuid}/{start}/{count}

GET

/vault_rest/folder_search/{folderGuid}/{start}/{count}

POST

/vault_rest/folder

PUT

/vault_rest/rename_folder

PUT

/vault_rest/v2/move_folders

PUT

/vault_rest/move_folders

GET

/vault_rest/root_folder

GET

/vault_rest/folder/{folderId}

DELETE

/vault_rest/folder/{folderId}

GET

/vault_rest/shared_folder/{folderId}

DELETE

/vault_rest/folders

GET

/vault_rest/folder/status/{folderId}

POST

/vault_rest/folder/availability

Enumerate Folder Contents

Retrieves a paginated list of contents (files and subfolders) within a specified folder.

Since ## 3.10.3

Auth

Path Params

folderGuid

string

The unique identifier (GUID) of the folder to enumerate.

start

string

The starting index for pagination.

pattern: ^\d+$

count

string

The number of items to retrieve per page.

pattern: ^\d+$

GET /vault_rest/folder_content/{folderGuid}/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/folder_content/%7BfolderGuid%7D/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved folder content.

object	object	Represents the result of enumerating or searching folder content.
totalCount	int32	The total number of items found.
items	array[object]	A list of folder and file entries.
id	uuid	The unique identifier (GUID) of the folder.
name	string	The name of the folder.
type	string	The type of entry (e.g., "folder", "file").
parentFolderId	uuid	The GUID of the parent folder.
creationDate	date-time	The date and time when the folder was created.
lastModifiedDate	date-time	The date and time when the folder was last modified.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to access the folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "totalCount": "{int32}", "items": [  {   "id": "{uuid}",   "name": "{string}",   "type": "{string}",   "parentFolderId": "{uuid}",   "creationDate": "{date-time}",   "lastModifiedDate": "{date-time}"  } ]}
Copy

Search Folder Contents

Searches for files and subfolders within a specified folder, returning a paginated list of results.

Since ## 3.10.3

Auth

Path Params

folderGuid

string

The unique identifier (GUID) of the folder to search within.

start

string

The starting index for pagination.

pattern: ^\d+$

count

string

The number of items to retrieve per page.

pattern: ^\d+$

GET /vault_rest/folder_search/{folderGuid}/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/folder_search/%7BfolderGuid%7D/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved search results.

object	object	Represents the result of enumerating or searching folder content.
totalCount	int32	The total number of items found.
items	array[object]	A list of folder and file entries.
id	uuid	The unique identifier (GUID) of the folder.
name	string	The name of the folder.
type	string	The type of entry (e.g., "folder", "file").
parentFolderId	uuid	The GUID of the parent folder.
creationDate	date-time	The date and time when the folder was created.
lastModifiedDate	date-time	The date and time when the folder was last modified.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to search the folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "totalCount": "{int32}", "items": [  {   "id": "{uuid}",   "name": "{string}",   "type": "{string}",   "parentFolderId": "{uuid}",   "creationDate": "{date-time}",   "lastModifiedDate": "{date-time}"  } ]}
Copy

Create a New Folder

Creates a new folder within the system. The request body should contain the details for the new folder, such as its name and parent folder ID.

Since ## 3.10.3

Auth

Request Body

Folder creation details.

object	object
name	string	The name of the new folder.
parentFolderId	uuid	The GUID of the parent folder where the new folder will be created.

POST /vault_rest/folder

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/folder' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "My New Project Folder",  "parentFolderId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"}'
Copy

Responses

200

Folder created successfully.

object	object	The result of a folder creation operation.
folderId	uuid	The GUID of the newly created folder.
name	string	The name of the newly created folder.

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to create folders.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "name": "{string}"}
Copy

Rename a Folder

Renames an existing folder. The request body should specify the folder's ID and its new name.

Since ## 3.10.3

Auth

Request Body

Folder rename details.

object	object
folderId	uuid	The GUID of the folder to rename.
newName	string	The new name for the folder.

PUT /vault_rest/rename_folder

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/rename_folder' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",  "newName": "Updated Project Name"}'
Copy

Responses

200

Folder renamed successfully.

object	object	The result of a folder rename operation.
folderId	uuid	The GUID of the renamed folder.
newName	string	The new name of the folder.

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to rename the folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "newName": "{string}"}
Copy

Move Multiple Folders (V2)

Moves multiple folders to a new parent folder. This is a V2 endpoint, potentially offering enhanced functionality or different request/response structures compared to V1. The request body should contain a list of folder IDs to move and the ID of the destination parent folder.

Since ## 3.10.3

Auth

Request Body

Details for moving multiple folders.

object	object
folderIds	array[string]	An array of GUIDs of the folders to move.
destinationFolderId	uuid	The GUID of the target parent folder where the folders will be moved.

PUT /vault_rest/v2/move_folders

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/v2/move_folders' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderIds": [    "a1b2c3d4-e5f6-7890-1234-567890abcdef",    "b2c3d4e5-f6a7-8901-2345-67890abcdef0"  ],  "destinationFolderId": "c3d4e5f6-a7b8-9012-3456-7890abcdef01"}'
Copy

Responses

200

Folders moved successfully. Returns a stream, likely containing a status or result object.

object object

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to move folders.

404

One or more folders or destination not found.

Response

xxxxxxxxxx
 
{}
Copy

Move Multiple Folders (V1)

Moves multiple folders to a new parent folder. This is a V1 endpoint. The request body should contain a list of folder IDs to move and the ID of the destination parent folder.

Since ## 3.10.3

Auth

Request Body

Details for moving multiple folders.

object	object
folderIds	array[string]	An array of GUIDs of the folders to move.
destinationFolderId	uuid	The GUID of the target parent folder where the folders will be moved.

PUT /vault_rest/move_folders

xxxxxxxxxx
 
curl --request PUT \ --url 'http://localhost:8010/vault_rest/move_folders' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderIds": [    "a1b2c3d4-e5f6-7890-1234-567890abcdef",    "b2c3d4e5-f6a7-8901-2345-67890abcdef0"  ],  "destinationFolderId": "c3d4e5f6-a7b8-9012-3456-7890abcdef01"}'
Copy

Responses

200

Folders moved successfully.

array	array[object]
folderId	uuid	The GUID of the folder that was moved.
status	string	The status of the move operation for this specific folder (e.g., "success", "failed").

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to move folders.

404

One or more folders or destination not found.

Response

xxxxxxxxxx
 
[ {  "folderId": "{uuid}",  "status": "{string}" }]
Copy

Get Root Folder Details

Retrieves the details of the user's root folder.

Since ## 3.10.3

Auth

GET /vault_rest/root_folder

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/root_folder' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved root folder details.

object	object	Represents the details of the root folder.
id	uuid	The GUID of the root folder.
name	string	The name of the root folder (e.g., "My Vault").

401

Unauthorized. Authentication required or invalid token.

Response

xxxxxxxxxx
 
{ "id": "{uuid}", "name": "{string}"}
Copy

Get Folder Details by ID

Retrieves the details of a specific folder using its unique identifier.

Since ## 3.10.3

Auth

Path Params

folderId

string

The unique identifier (GUID) of the folder to retrieve.

GET /vault_rest/folder/{folderId}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/folder/%7BfolderId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved folder details.

object	object	Represents a folder entry with its basic details.
id	uuid	The unique identifier (GUID) of the folder.
name	string	The name of the folder.
type	string	The type of entry (e.g., "folder", "file").
parentFolderId	uuid	The GUID of the parent folder.
creationDate	date-time	The date and time when the folder was created.
lastModifiedDate	date-time	The date and time when the folder was last modified.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to access this folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "id": "{uuid}", "name": "{string}", "type": "{string}", "parentFolderId": "{uuid}", "creationDate": "{date-time}", "lastModifiedDate": "{date-time}"}
Copy

Delete a Folder

Deletes a specific folder identified by its ID.

Since ## 3.10.3

Auth

Path Params

string

The unique identifier (GUID) of the folder to delete.

DELETE /vault_rest/folder/{folderId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/folder/{folderId}' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Folder deleted successfully.

object	object	The result of a folder deletion operation.
folderId	uuid	The GUID of the folder that was attempted to be deleted.
status	string	The status of the deletion operation (e.g., "success", "failed").

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to delete the folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "status": "{string}"}
Copy

Get Shared Folder Details by ID

Retrieves the details of a specific folder that has been shared, using its unique identifier.

Since ## 3.10.3

Auth

Path Params

folderId

string

The unique identifier (GUID) of the shared folder to retrieve.

GET /vault_rest/shared_folder/{folderId}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/shared_folder/%7BfolderId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved shared folder details.

object	object	Represents a folder entry with its basic details.
id	uuid	The unique identifier (GUID) of the folder.
name	string	The name of the folder.
type	string	The type of entry (e.g., "folder", "file").
parentFolderId	uuid	The GUID of the parent folder.
creationDate	date-time	The date and time when the folder was created.
lastModifiedDate	date-time	The date and time when the folder was last modified.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to access this shared folder.

404

Shared folder not found.

Response

xxxxxxxxxx
 
{ "id": "{uuid}", "name": "{string}", "type": "{string}", "parentFolderId": "{uuid}", "creationDate": "{date-time}", "lastModifiedDate": "{date-time}"}
Copy

Delete Multiple Folders

Deletes multiple folders based on the provided list of folder IDs in the request body.

Since ## 3.10.3

Auth

Request Body

List of folder IDs to delete.

object	object
folderIds	array[string]	An array of GUIDs of the folders to delete.

DELETE /vault_rest/folders

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/folders' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderIds": [    "a1b2c3d4-e5f6-7890-1234-567890abcdef",    "b2c3d4e5-f6a7-8901-2345-67890abcdef0"  ]}'
Copy

Responses

200

Folders deleted successfully. Returns a stream, likely containing a status or result object.

object object

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to delete one or more folders.

Response

xxxxxxxxxx
 
{}
Copy

Get Folder Status

Retrieves the current status of a specific folder, identified by its ID. This might include information about its availability, integrity, or other relevant states.

Since ## 3.10.3

Auth

Path Params

folderId

string

The unique identifier (GUID) of the folder to check status for.

GET /vault_rest/folder/status/{folderId}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/folder/status/%7BfolderId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved folder status.

object	object	Represents the status of a folder.
folderId	uuid	The GUID of the folder.
status	string	The current status of the folder (e.g., "available", "processing", "error").
details	string	Additional details about the folder's status.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to access this folder's status.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "status": "{string}", "details": "{string}"}
Copy

Check Folder Availability for Download

Checks if a specific folder is available for download. The request body should contain the folder's ID.

Since ## 3.10.3

Auth

Request Body

Folder availability check details.

object	object
folderId	uuid	The GUID of the folder to check for download availability.

POST /vault_rest/folder/availability

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/folder/availability' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"}'
Copy

Responses

200

Successfully checked folder availability.

object	object	The result of checking folder availability for download.
folderId	uuid	The GUID of the folder.
isAvailable	boolean	Indicates if the folder is available for download.
reason	string	If not available, provides a reason.

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to check availability for this folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "isAvailable": "{boolean}", "reason": "{string}"}
Copy

Enumerate Shared Content

Retrieves a paginated list of content (files and folders) that has been shared with the current user.

Since ## 3.10.3

Auth

Path Params

start

string

The starting index for pagination.

pattern: ^\d+$

count

string

The number of items to retrieve per page.

pattern: ^\d+$

GET /vault_rest/shared_content/{start}/{count}

xxxxxxxxxx
 
curl --get \ --url 'http://localhost:8010/vault_rest/shared_content/%7Bstart%7D/%7Bcount%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

Successfully retrieved shared content.

object	object	Represents the result of enumerating or searching folder content.
totalCount	int32	The total number of items found.
items	array[object]	A list of folder and file entries.
id	uuid	The unique identifier (GUID) of the folder.
name	string	The name of the folder.
type	string	The type of entry (e.g., "folder", "file").
parentFolderId	uuid	The GUID of the parent folder.
creationDate	date-time	The date and time when the folder was created.
lastModifiedDate	date-time	The date and time when the folder was last modified.

401

Unauthorized. Authentication required or invalid token.

Response

xxxxxxxxxx
 
{ "totalCount": "{int32}", "items": [  {   "id": "{uuid}",   "name": "{string}",   "type": "{string}",   "parentFolderId": "{uuid}",   "creationDate": "{date-time}",   "lastModifiedDate": "{date-time}"  } ]}
Copy

Update Folder Share Settings

Updates the sharing settings for a specific folder. This can include adding or removing users/groups, or changing permissions. The request body should contain the folder ID and the new sharing configuration.

Since ## 3.10.3

Auth

Request Body

Folder share update details.

object	object
folderId	uuid	The GUID of the folder whose share settings are being updated.
shareSettings	object	An object containing the new share configuration (e.g., permissions, users, groups).

POST /vault_rest/update_folder_share

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/update_folder_share' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",  "shareSettings": {}}'
Copy

Responses

200

Folder share settings updated successfully.

object	object	The result of updating folder share settings.
folderId	uuid	The GUID of the folder whose share settings were updated.
status	string	The status of the share update operation (e.g., "success", "failed").

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to update share settings for this folder.

404

Folder not found.

Response

xxxxxxxxxx
 
{ "folderId": "{uuid}", "status": "{string}"}
Copy

Bulk Update Folder Share Settings

Performs a bulk update of sharing settings for multiple folders. This allows for efficient modification of share configurations across several folders in a single request. The request body should contain a list of folder IDs and their respective new sharing configurations.

Since ## 3.10.3

Auth

Request Body

Bulk folder share update details.

object	object
updates	array[object]	An array of objects, each specifying a folder ID and its new share settings.
folderId	uuid	The GUID of the folder to update.
shareSettings	object	The new share configuration for this folder.

POST /vault_rest/bulk_update_folder_share

xxxxxxxxxx
 
curl --request POST \ --url 'http://localhost:8010/vault_rest/bulk_update_folder_share' \ --header 'Authorization: Bearer {token}' \ --data '{  "updates": [    {      "folderId": "{uuid}",      "shareSettings": {}    }  ]}'
Copy

Responses

200

Bulk folder share settings updated successfully. Returns a stream, likely containing a status or result object.

object object

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to update share settings for one or more folders.

Response

xxxxxxxxxx
 
{}
Copy

Remove Folder Shares

Removes existing shares for one or more folders. The request body should contain a list of folder IDs for which shares are to be removed.

Since ## 3.10.3

Auth

Request Body

Details for removing folder shares.

object	object
folderIds	array[string]	An array of GUIDs of the folders whose shares are to be removed.

DELETE /vault_rest/remove_folder_shares

xxxxxxxxxx
 
curl --request DELETE \ --url 'http://localhost:8010/vault_rest/remove_folder_shares' \ --header 'Authorization: Bearer {token}' \ --data '{  "folderIds": [    "a1b2c3d4-e5f6-7890-1234-567890abcdef",    "b2c3d4e5-f6a7-8901-2345-67890abcdef0"  ]}'
Copy

Responses

200

Folder shares removed successfully.

object	object	The result of removing folder shares.
folderIds	array[string]	An array of GUIDs of folders for which shares were processed.
status	string	Overall status of the operation (e.g., "success", "partial_failure").

400

Bad Request. Invalid input or missing required fields.

401

Unauthorized. Authentication required or invalid token.

403

Forbidden. User does not have permission to remove shares for one or more folders.

Response

xxxxxxxxxx
 
{ "folderIds": [  "{array[string]...}" ], "status": "{string}"}
Copy

MFT API - Folder Management 3.10.3

Authentication

Folder Management

Enumerate Folder Contents

Since ## 3.10.3

Search Folder Contents

Since ## 3.10.3

Create a New Folder

Since ## 3.10.3

Rename a Folder

Since ## 3.10.3

Move Multiple Folders (V2)

Since ## 3.10.3

Move Multiple Folders (V1)

Since ## 3.10.3

Get Root Folder Details

Since ## 3.10.3

Get Folder Details by ID

Since ## 3.10.3

Delete a Folder

Since ## 3.10.3

Get Shared Folder Details by ID

Since ## 3.10.3

Delete Multiple Folders

Since ## 3.10.3

Get Folder Status

Since ## 3.10.3

Check Folder Availability for Download

Since ## 3.10.3

Folder Sharing

Enumerate Shared Content

Since ## 3.10.3

Update Folder Share Settings

Since ## 3.10.3

Bulk Update Folder Share Settings

Since ## 3.10.3

Remove Folder Shares

Since ## 3.10.3