Interactive Developer Console

Take our API for an interactive test drive using our developer console below. You can also view our comprehensive documentation.

Follow the steps below to start using the console. Note that this console uses a shared demo account. Outside of the console, you'll want to use your own API key and Egnyte account.

If logged into the portal, choose "Manual Input" for the "Existing Client Credentials" dropdown (only necessary if you are logged into this portal).
Paste one of the following demo keys into the "Client ID" field -

x2g35g8gynb5cedas649m4h4 (for "Implicit/ Javascript Client" OAuth flow)
5mns35zabc5wbchggw9dru77 (for "Password Credentials" OAuth flow)
For the "Implicit/ Javascript Client" OAuth flow, click "Get Access Token" to proceed. You'll need to enter user credentials after this.

For the "Password Credentials" flow, you will need to enter user credentials before clicking "Get Access Token".

You must use the following credentials for our Egnyte test account:

username: test
password: password
That's it — you can proceed to test our API methods below!

Note:

The Permissions API and Audit Reporting API are currently unavailable on the console.
Currently only files with fixed placeholder text contents can be created using the Create File endpoint on this console.
The Update Single User endpoint in the User Management API is not available in this console. Refer to the written documentation for more details on this method.

Select an Interactive Documentation
Egnyte Public REST API

OAuth 2.0 Flow:

Existing Client Credentials:

API Key:

App/Key: Manually provide key information

Shared Secret:

Client ID:

Client Secret:

Client ID:

Client Secret:

Username:

Password:

Client ID:

Client Secret:

Authorization Code:

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

Egnyte Filesystem API

List Methods

Expand Methods

GET List File or Folder /pubapi/v1/fs/Path

Obtains file metadata or folder listing

Parameter	Value	Type	Description
Authorization		string	OAuth2 access token
Path		string	The full absolute path of the file or folder.

GET Download File /pubapi/v1/fs-content/Path

Downloads a file

Parameter	Value	Type	Description
Authorization		string	OAuth2 access token
Path		string	The full absolute path of the file.

POST Create Folder /pubapi/v1/fsPath

Creates a folder

Parameter	Type	Description
Authorization	string	OAuth2 access token
Path	string	The full absolute path of the folder.
Content-Type	string	Content type of the payload

Request Body

POST Create File /pubapi/v1/fs-content/Path

Creates or updates a file

Parameter	Type	Description
Path	string	The full absolute path of the file.
Authorization	string	OAuth2 access token
Content-Type	string	Content type of the payload

Request Body

POST Move File or Folder /pubapi/v1/fs/Path

Moves a file or folder

Parameter	Type	Description
Authorization	string	OAuth2 access token
Path	string	The full absolute path of the file or folder.
Content-Type	string	Content type of the payload

Request Body

POST Copy File or Folder /pubapi/v1/fsPath

Copies a file or folder

Parameter	Type	Description
Authorization	string	OAuth2 access token
Path	string	The full absolute path of the file or folder.
Content-Type	string	Content type of the payload

Request Body

DELETE Delete File or Folder /pubapi/v1/fsPath

Deletes a file or folder

Parameter	Value	Type	Description
Path		string	The full absolute path of the file or folder.

Egnyte Link API

List Methods

Expand Methods

POST Create Link /pubapi/v1/links

Generates a file or folder link

Parameter	Value	Type	Description
Authorization		string	OAuth2 access token
Content-Type		string	Content type of the payload

Request Body

GET List Link /pubapi/v1/links/LinkID

Lists the details for a link. Details will not be listed if the user executing this is not an admin and also not the creator of the link.

Parameter	Value	Type	Description
Authorization		string	OAuth2 access token
LinkID		string	Link identifier. For an example, grab it from the one you created above.

GET List Links /pubapi/v1/links

Lists all links. If the user executing this is not an admin, then only links created by the user will be listed.

Parameter	Type	Description
Authorization	string	OAuth2 access token
path	string	Lists links for the absolute path of the destination file or folder
username	string	List links created by this user.
created_before	string	List links created before this date.
created_after	string	List links created after this date.
type	string	Choose 'file' or 'folder'. Links of selected type will be shown.
accessibility	string	Choose 'anyone', 'password', 'domain', or 'recipients'. Links of selected type will be shown.
offset	integer	Start at this link. '0' = first link.
count	integer	Send this number of links. If not specified, all links will be sent.

DELETE Delete Link /pubapi/v1/links/LinkID

Deletes a link. The link will not be deleted if the user executing this is not an admin and also not the creator of the link.

Parameter	Value	Type	Description
Authorization		string	OAuth2 access token
LinkID		string	Link identifier

Interactive Developer Console

Egnyte Filesystem API List Methods Expand Methods

Request Body

Request Body

Request Body

Request Body

Egnyte Link API List Methods Expand Methods

Request Body

Egnyte Filesystem API

List Methods

Expand Methods

Egnyte Link API

List Methods

Expand Methods