Egnyte (Preview)

Egnyte is a content collaboration platform that keeps your files safe, synced, and easy to share. Connect to Egnyte to manage your files. You can perform various actions such as upload, move, download, and delete files in Egnyte.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet |
Contact | |
---|---|
URL | https://helpdesk.egnyte.com |
Connector Metadata | |
---|---|
Publisher | Egnyte, Inc. |
Website | https://www.egnyte.com |
Privacy policy | https://www.egnyte.com/corp/privacy_policy.html |
Throttling Limits
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Actions
Copy File By Id |
Copy a file by using an id. |
Copy File By Path |
Copy a file by using a path. |
Copy Folder By Id |
Copy a folder using an id. |
Copy Folder By Path |
Copy a folder by using a path. |
Create file |
Uploads a file to Egnyte. |
Create Folder |
Create a folder in Egnyte. |
Delete File By Id |
Delete a file using an id. |
Delete File By Path |
Delete a file using a path. |
Delete Folder By Id |
Delete a folder using an id. |
Delete Folder By Path |
Delete a folder using a path. |
File Info By Id |
Retrieve file info using file id. |
File Info By Path |
Retrieve file info using path. |
Folder Info By Id |
Retrieve folder info using id. |
Folder Info By Path |
Retrieve folder info using path. |
Get file content by id |
Retrieves the file content from Egnyte using id. |
Get file content by path |
Retrieves the file contents from Egnyte using path. |
Lock File By Id |
Lock file using id. |
Lock File By Path |
Lock file using path. |
Move File By Id |
Move a file in Egnyte using file id. |
Move File By Path |
Move a file in Egnyte using path. |
Move Folder By Id |
Move a folder using id. |
Move Folder By Path |
Move a folder in Egnyte using path. |
Set Metadata By File Id |
Write metadata to a file by using file id. |
Share File |
Share a file in Egnyte. |
Share Folder |
Share a folder in Egnyte. |
Unlock File By Id |
Unlock file using id. |
Unlock File By Path |
Unlock file using path. |
Copy File By Id
Copy a file by using an id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte. |
File Id
|
id | True | string |
The unique identifier of the file to copy in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File ID
|
group_id | string |
The ID to reference the file as a whole. |
File Path
|
path | string |
Full path of the copied file. |
Copy File By Path
Copy a file by using a path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination File
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
Source File
|
path | True | string |
The source file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File ID
|
group_id | string |
The ID to reference the file as a whole. |
File Path
|
path | string |
Full path of the copied file. |
Copy Folder By Id
Copy a folder using an id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Folder Id
|
id | True | string |
The unique identifier of the folder to copy in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
folder_id | string |
The unique ID of the copied folder. |
Folder Path
|
path | string |
Full path of the copied folder. |
Copy Folder By Path
Copy a folder by using a path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Source Folder Path
|
path | True | string |
The source folder path in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
folder_id | string |
The unique ID of the copied folder. |
Folder Path
|
path | string |
Full path of the copied folder. |
Create file
Uploads a file to Egnyte.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File name
|
Name | True | string |
The name of the file to create in Egnyte. |
Folder path
|
Path | True | string |
The folder path to upload the file to Egnyte. |
File content
|
body | True | binary |
The content of the file to upload to Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Version ID
|
id | string |
The id of the current version of the file. |
File Path
|
path | string |
Full path of the uploaded file. |
Create Folder
Create a folder in Egnyte.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | string |
The full path of the new folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
folder_id | string |
The unique ID of the created folder |
Folder Path
|
path | string |
Full path of the created folder |
Delete File By Id
Delete a file using an id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file to delete from Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted file. |
Delete File By Path
Delete a file using a path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted file |
Delete Folder By Id
Delete a folder using an id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder to delete from Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted folder. |
Delete Folder By Path
Delete a folder using a path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The folder path in Egnyte, including target folder name to be deleted. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Parent Folder Path
|
parent_folder_path | string |
Path to the parent folder for the deleted folder. |
File Info By Id
Retrieve file info using file id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | string |
The unique identifier of the file in Egnyte. |
Returns
- Body
- FileInfoResponse
File Info By Path
Retrieve file info using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The unique path to the file in Egnyte. |
Returns
- Body
- FileInfoResponse
Folder Info By Id
Retrieve folder info using id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Id
|
id | True | string |
The unique identifier of the folder in Egnyte. |
Returns
- Body
- FolderInfoResponse
Folder Info By Path
Retrieve folder info using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The unique path to the folder in Egnyte. |
Returns
- Body
- FolderInfoResponse
Get file content by id
Retrieves the file content from Egnyte using id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
fileId | True | string |
The unique identifier of the file in Egnyte. |
Returns
Get file content by path
Retrieves the file contents from Egnyte using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
filePath | True | string |
The unique path to the file in Egnyte. |
Returns
Lock File By Id
Lock file using id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | string |
The unique identifier of the file in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Lock Token
|
lock_token | string |
The token that must be used to unlock the file. |
Timeout
|
timeout | integer |
The time in seconds that the file should be locked for. |
Lock File By Path
Lock file using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Target File Path
|
path | True | string |
The target file path in Egnyte, including target filename. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Lock Token
|
lock_token | string |
The token that must be used to unlock the file. |
Timeout
|
timeout | integer |
The time in seconds that the file should be locked for. |
Move File By Id
Move a file in Egnyte using file id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File ID
|
group_id | string |
The ID to reference the file as a whole. |
File Path
|
path | string |
Full path of the moved file. |
Move File By Path
Move a file in Egnyte using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination File Path
|
destination_path | True | string |
The destination file path in Egnyte, including target filename. |
Source Path
|
path | True | string |
The path to source file. |
Returns
Name | Path | Type | Description |
---|---|---|---|
File ID
|
group_id | string |
The ID to reference the file as a whole. |
File Path
|
path | string |
Full path of the moved file. |
Move Folder By Id
Move a folder using id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Folder Id
|
id | True | string |
The unique identifier of the folder in Egnyte. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
folder_id | string |
The unique ID of the moved folder. |
Folder Path
|
path | string |
Full path of the moved folder. |
Move Folder By Path
Move a folder in Egnyte using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Destination Folder Path
|
destination_path | True | string |
The destination folder path in Egnyte. |
Source Path
|
path | True | string |
The path to source folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
folder_id | string |
The unique ID of the moved folder. |
Folder Path
|
path | string |
Full path of the moved folder. |
Set Metadata By File Id
Write metadata to a file by using file id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
fileId | True | string |
The unique identifier of the file in Egnyte. |
Metadata Key Name
|
metadataName | True | string |
The name of the key you want to assign value to. |
Metadata Value
|
metadataValue | string |
Metadata value to be set. |
|
Namespace Name
|
namespaceName | True | string |
The name of the namespace. |
Returns
Share File
Share a file in Egnyte.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Path
|
path | True | string |
The file path in Egnyte, including target filename to share. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Created By
|
created_by | string |
Username of the user that created the link. |
Creation Date
|
creation_date | string |
Date and time of creation of the link. |
Expiry Date
|
expiry_date | string |
Date and time of the expiration of the link. |
Is referring to version
|
link_to_current | boolean |
Is this current version? T or F |
links
|
links | array of object |
Links |
Link ID
|
links.id | string |
The id of the link. |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Link Url
|
links.url | string |
The full url of the link. |
Notify creator when accessed
|
notify | boolean |
Whether the link creator will be notified via email when link is accessed. |
File Path
|
path | string |
Full path of the shared file. |
Type
|
type | string |
The type of link, either file, folder, or upload. |
Share Folder
Share a folder in Egnyte.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
path | True | string |
The folder path in Egnyte, to share. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Accessibility
|
accessibility | string |
Who a link is accessible by, one of anyone, password, domain, or recipients. |
Created by
|
created_by | string |
Username of the user that created the link. |
Creation Date
|
creation_date | string |
Date and time of creation of the link. |
Expiry Date
|
expiry_date | string |
Date and time of the expiration of the link. |
Is referring to version
|
link_to_current | boolean |
Is this current version? T or F |
links
|
links | array of object |
Links |
Link ID
|
links.id | string |
The id of the link. |
Recipients
|
links.recipients | array of string |
An array of valid email addresses to which the link was sent. |
Link Url
|
links.url | string |
The full url of the link. |
Notify creator when accessed
|
notify | boolean |
Whether the link creator will be notified via email when link is accessed. |
Folder Path
|
path | string |
Full path of the shared folder. |
Type
|
type | string |
The type of link, either file, folder, or upload. |
Unlock File By Id
Unlock file using id.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
File Id
|
id | True | string |
The unique identifier of the file in Egnyte. |
Lock Token
|
lock_token | True | string |
The current lock token for the file. |
Returns
Unlock File By Path
Unlock file using path.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Lock Token
|
lock_token | True | string |
The current lock token for the file. |
File Path
|
path | True | string |
The unique path to the file in Egnyte. |
Returns
Triggers
When a file is copied (properties) |
This operation triggers a flow when a file is copied in a folder. |
When a file is created (properties) |
This operation triggers a flow when a new file is created in a folder. |
When a file is deleted (properties) |
This operation triggers a flow when a file is deleted in a folder. |
When a file is moved (properties) |
This operation triggers a flow when a file is moved in a folder. |
When a file is renamed (properties) |
This operation triggers a flow when a file is renamed in a folder. |
When a folder is copied (properties) |
This operation triggers a flow when a sub-folder is copied in a folder. |
When a folder is created (properties) |
This operation triggers a flow when a sub-folder is created in a folder. |
When a folder is deleted (properties) |
This operation triggers a flow when a sub-folder is deleted in a folder. |
When a folder is moved (properties) |
This operation triggers a flow when a sub-folder is moved in a folder. |
When a folder is renamed (properties) |
This operation triggers a flow when a sub-folder is renamed in a folder. |
When a file is copied (properties)
This operation triggers a flow when a file is copied in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Source File ID
|
data.source_group_id | string |
The source file ID to reference the file as a whole. |
Source File Version ID
|
data.source_id | string |
Source file specific version ID. |
Source File Path
|
data.source_path | string |
Full original path to the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File Path
|
data.target_path | string |
Full path to the file. |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a file is created (properties)
This operation triggers a flow when a new file is created in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder (True or False). |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File Path
|
data.target_path | string |
Full path to the file. |
Event ID
|
id | integer |
The ID of an event. |
Object Detail
|
object_detail | string |
Object Detail. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a file is deleted (properties)
This operation triggers a flow when a file is deleted in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Version Path
|
data.target_path | string |
Full path to the specific file version. |
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a file is moved (properties)
This operation triggers a flow when a file is moved in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Source File Path
|
data.source_path | string |
Full original path to the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File Path
|
data.target_path | string |
Full path to the file. |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a file is renamed (properties)
This operation triggers a flow when a file is renamed in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Source File Path
|
data.source_path | string |
Full original path to the file. |
File ID
|
data.target_group_id | string |
The ID to reference the file as a whole. |
Version ID
|
data.target_id | string |
The ID of the specific version of the file. |
File Path
|
data.target_path | string |
Full path to the renamed file |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a folder is copied (properties)
This operation triggers a flow when a sub-folder is copied in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder (True or False) |
Source Folder Path
|
data.source_path | string |
Full original path to the folder |
Folder Path
|
data.target_path | string |
Full destination path to the folder |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a folder is created (properties)
This operation triggers a flow when a sub-folder is created in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Folder Path
|
data.target_path | string |
The full path to the folder. |
Event ID
|
id | integer |
The ID of an event. |
Object Detail
|
object_detail | string |
Object Detail. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a folder is deleted (properties)
This operation triggers a flow when a sub-folder is deleted in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Folder Path
|
data.target_path | string |
Full path to the deleted folder. |
Event ID
|
id | integer |
The ID of an event. |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a folder is moved (properties)
This operation triggers a flow when a sub-folder is moved in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Source Folder Path
|
data.source_path | string |
Full original path to the folder. |
Folder Path
|
data.target_path | string |
Full destination path to the folder. |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
When a folder is renamed (properties)
This operation triggers a flow when a sub-folder is renamed in a folder.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Folder Path
|
FolderPath | True | string |
The path to the target folder. |
Returns
Name | Path | Type | Description |
---|---|---|---|
Action
|
action | string |
The action associated with this event. |
Action Source
|
action_source | string |
The source of the event. For example WebUI, Mobile, etc. |
User ID
|
actor | integer |
The numeric ID of the user who performed the action. |
Is Folder
|
data.is_folder | boolean |
Whether the resource is a folder. (True or False) |
Source Folder Path
|
data.source_path | string |
Full original path to the folder. |
Folder Path
|
data.target_path | string |
Full destination path to the folder. |
Event ID
|
id | integer |
The ID of an individual event. |
Object Detail
|
object_detail | string |
Object Detail |
Timestamp
|
timestamp | string |
The ISO-8601 formatted timestamp for when this event was recorded. |
Definitions
FileInfoResponse
Name | Path | Type | Description |
---|---|---|---|
Checksum
|
checksum | string |
Checksum value of the current version of the file used to determine file changes. |
Version ID
|
entry_id | string |
The ID of the current version of the file. |
File ID
|
group_id | string |
The ID to reference the file as a whole. |
Is folder
|
is_folder | boolean |
Whether the resource is a folder. True or False |
Last Modified
|
last_modified | string |
Last modified time of the current version of a file. |
Is locked
|
locked | boolean |
Status of the lock on the file. |
Name
|
name | string |
Name of the file. |
Number of versions
|
num_versions | integer |
The total number of versions associated with the specific file path. |
Parent Folder ID
|
parent_id | string |
The ID of the parent folder requested. |
File Path
|
path | string |
Full path of the file. |
Size
|
size | integer |
Size of the file in bytes. |
Uploaded timestamp
|
uploaded | integer |
Uploaded time of the current version of the file. |
Uploaded by
|
uploaded_by | string |
Username of the user that uploaded the version. |
versions
|
versions | array of object |
Versions |
Checksum (version)
|
versions.checksum | string |
Checksum value of the version of the file used to determine file changes. |
Version ID
|
versions.entry_id | string |
The ID of the specific version of the file. |
Is folder (version)
|
versions.is_folder | boolean |
Whether the resource is a folder. True or False |
Last Modified (version)
|
versions.last_modified | string |
Last modified time of the specific version of a file. |
Size (version)
|
versions.size | integer |
Size of the file in bytes. |
Uploaded timestamp (version)
|
versions.uploaded | integer |
Uploaded time of the specific version of the file. |
Uploaded by (version)
|
versions.uploaded_by | string |
Username of the user that uploaded the version. |
FolderInfoResponse
Name | Path | Type | Description |
---|---|---|---|
Is shareable
|
allow_links | boolean |
Is shareable? T or F |
files
|
files | array of object |
Files |
Checksum (file)
|
files.checksum | string |
Checksum value of the current version of the file used to determine file changes. |
Version ID (file)
|
files.entry_id | string |
The ID of the specific version of the file. |
ID (file)
|
files.group_id | string |
The ID to reference the file as a whole. |
Is folder (file)
|
files.is_folder | boolean |
Whether the resource is a folder. True or False |
Last Modified (file)
|
files.last_modified | string |
Last modified time of the current version of a file. |
Is locked (file)
|
files.locked | boolean |
Status of the lock on the file. |
Name (file)
|
files.name | string |
Name of the file. |
Versions Count (file)
|
files.num_versions | integer |
The total number of versions associated with the specific file path. |
Parent Folder ID (file)
|
files.parent_id | string |
The ID of the parent folder. |
Path (file)
|
files.path | string |
Full path of the file. |
Size (file)
|
files.size | integer |
Size of the file in bytes. |
Uploaded Timestamp (file)
|
files.uploaded | integer |
Uploaded time of the current version of the file. |
Uploaded by (file)
|
files.uploaded_by | string |
Username of the user that uploaded the version. |
Folder ID
|
folder_id | string |
The unique ID of the folder. |
folders
|
folders | array of object |
Folders |
ID (subfolder)
|
folders.folder_id | string |
The ID of the folder requested. |
Is folder (subfolder)
|
folders.is_folder | boolean |
Whether the resource is a folder. True or False |
Last Modified (subfolder)
|
folders.lastModified | integer |
The latest time that any file in the folder (but not within subfolders) has been modified. |
Name (subfolder)
|
folders.name | string |
Name of the folder. |
Parent Folder ID (subfolder)
|
folders.parent_id | string |
The id of the parent folder. |
Path (subfolder)
|
folders.path | string |
The full path of the folder as requested. |
Uploaded Timestamp (subfolder)
|
folders.uploaded | integer |
Time when the folder has been uploaded or created. |
Is folder
|
is_folder | boolean |
Whether the resource is a folder. True or False |
Last Modified
|
lastModified | integer |
The latest time that any file in the folder (but not within subfolders) has been modified. |
Name
|
name | string |
Name of the folder. |
Parent Folder ID
|
parent_id | string |
The id of the parent folder. |
Folder Path
|
path | string |
Full path of the folder. |
Possible Public Links
|
public_links | string |
The folder option setting as to how "Allow public inks from this folder for" was set. |
Can be deleted or moved
|
restrict_move_delete | boolean |
Can be deleted or moved? T or F |
Subitems Count
|
total_count | integer |
The total number of items actually available to return. |
Uploaded Timestamp
|
uploaded | integer |
Time when the folder has been uploaded or created. |