Egnyte

App · 20 actions

Manage files, folders, sharing links and comments; search files and read users and groups.

Actions

ActionWhat it does
Copy file or folderCopy a file or folder, picked by its path, to a destination path.
Create commentAdd a comment to a file by its path.
Create folderCreate a new folder at the given path in Egnyte.
Create linkCreate a shared link to a file or folder by its path, or an upload link to a folder, with an optional expiry date.
Delete commentDelete a comment by its ID.
Delete file or folderDelete a file or folder by its path.
Delete linkDelete a shared link by its ID, so it no longer opens.
Download fileDownload a file by its path, returning its contents.
Get commentGet one comment by its ID, returning its text, author, time and the file it is on.
Get file or folderGet the details of a file or folder by its path.
Get groupGet one group by its ID, returning its name and members.
Get linkGet one shared link by its ID, returning its URL, the file or folder it shares, its type and its expiry date.
Get userGet one Egnyte user by their ID, returning their name, username, email address, role and whether they are active.
List commentsList the comments on a file by its path, optionally between two times.
List groupsList the groups in your Egnyte domain, returning each group's name and ID.
List linksList the shared links in your Egnyte domain, returning each link's ID.
List usersList the users in your Egnyte domain, returning each user's name, username, email address and role.
Move file or folderMove a file or folder, picked by its path, to a destination path.
Search filesSearch files and folders by name and content, optionally within one folder, by type or by when they were modified.
Upload fileUpload a file to the given path in Egnyte, including the file name.

Copy file or folder

Copy a file or folder, picked by its path, to a destination path. The original stays where it was.

Inputs

File or folder pathpathtextRequired
File or folder path.
DestinationdestinationtextRequired
Destination.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Create comment

Add a comment to a file by its path. Returns the new comment's ID.

Inputs

PathpathtextRequired
Path.
BodybodytextRequired
Body.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "message": "example"
  }
}

Create folder

Create a new folder at the given path in Egnyte. Returns the new folder's details.

Inputs

File or folder pathpathtextRequired
File or folder path.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "folder_id": "example",
    "path": "example"
  }
}

Create a shared link to a file or folder by its path, or an upload link to a folder, with an optional expiry date. Returns the new link's URL. No email is sent.

Inputs

PathpathtextRequired
Path.
TypetypetextRequired
Type.One of: file, folder, upload.
Expiry dateexpiry_datedate
Expiry date.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "links": []
  }
}

Delete comment

Delete a comment by its ID.

Inputs

Comment IDcomment_idtextRequired
Comment ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Delete file or folder

Delete a file or folder by its path. A deleted folder takes everything inside it with it.

Inputs

File or folder pathpathtextRequired
File or folder path.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Delete a shared link by its ID, so it no longer opens. The file or folder it pointed to is kept.

Inputs

Link IDlink_idtextRequired
Link ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Download file

Download a file by its path, returning its contents.

Inputs

File or folder pathpathtextRequired
File or folder path.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "content_base64": "example",
    "content_type": "example"
  }
}

Get comment

Get one comment by its ID, returning its text, author, time and the file it is on.

Inputs

Comment IDcomment_idtextRequired
Comment ID.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "id": "example",
    "message": "example"
  }
}

Get file or folder

Get the details of a file or folder by its path. For a folder, it can also list what the folder contains, a page at a time.

Inputs

File or folder pathpathtextRequired
File or folder path.
List contentlist_contenttrue/false
List content.
Countcountnumber
Count.From 1 to 1000.
Offsetoffsetnumber
Offset.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "files": [],
    "folder_id": "example",
    "folders": [],
    "group_id": "example",
    "is_folder": false,
    "path": "example"
  }
}

Get group

Get one group by its ID, returning its name and members.

Inputs

Groupgroup_idtextRequired
Group ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get one shared link by its ID, returning its URL, the file or folder it shares, its type and its expiry date.

Inputs

Link IDlink_idtextRequired
Link ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Get user

Get one Egnyte user by their ID, returning their name, username, email address, role and whether they are active.

Inputs

Usertarget_user_idtextRequired
User ID.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

List comments

List the comments on a file by its path, optionally between two times. Returns one page; use count and offset for the next page.

Inputs

File or folder pathfiletextRequired
File or folder path.
Countcountnumber
Count.From 1 to 100.
Offsetoffsetnumber
Offset.At least 0.
Start timestart_timedate and time
Start time.
End timeend_timedate and time
End time.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "count": 1,
    "notes": [],
    "offset": 1,
    "total_results": 1
  }
}

List groups

List the groups in your Egnyte domain, returning each group's name and ID. Returns one page; use start index and count for the next page.

Inputs

Start indexstart_indexnumber
Start index.At least 1.
Countcountnumber
Count.From 1 to 100.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "itemsPerPage": 1,
    "resources": [],
    "startIndex": 1,
    "totalResults": 1
  }
}

List the shared links in your Egnyte domain, returning each link's ID. Returns one page; use count and offset for the next page.

Inputs

Countcountnumber
Count.From 1 to 100.
Offsetoffsetnumber
Offset.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "count": 1,
    "links": []
  }
}

List users

List the users in your Egnyte domain, returning each user's name, username, email address and role. Returns one page; use start index and count for the next page.

Inputs

Start indexstart_indexnumber
Start index.At least 1.
Countcountnumber
Count.From 1 to 100.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "itemsPerPage": 1,
    "resources": [],
    "startIndex": 1,
    "totalResults": 1
  }
}

Move file or folder

Move a file or folder, picked by its path, to a destination path.

Inputs

File or folder pathpathtextRequired
File or folder path.
DestinationdestinationtextRequired
Destination.

Outputs

dataobject
Response.
Example output
{
  "data": {}
}

Search files

Search files and folders by name and content, optionally within one folder, by type or by when they were modified. Returns up to 20 matches per page.

Inputs

QueryquerytextRequired
Query.
Folderfoldertext
Folder.
Modified aftermodified_afterdate and time
Modified after.
Modified beforemodified_beforedate and time
Modified before.
Typetypetext
Type.One of: FILE, FOLDER.
Countcountnumber
Count.From 1 to 20.
Offsetoffsetnumber
Offset.At least 0.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "count": 1,
    "offset": 1,
    "results": [],
    "total_count": 1
  }
}

Upload file

Upload a file to the given path in Egnyte, including the file name. Returns the uploaded file's details.

Inputs

File or folder pathpathtextRequired
File or folder path.
FilefiletextRequired
File.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "group_id": "example",
    "path": "example"
  }
}

On this page