Skip to main content

Egnyte

Egnyte is a content cloud where businesses store, share, and govern their files in Shared and Private folders, share content with outside parties through links, and manage users, groups, and folder permissions. The Egnyte connector reads files, folders, links, permissions, users, groups, comments, metadata, project folders, and audit and file system events, and can create folders, links, users, groups, comments, bookmarks, and permissions.

Egnyte icon

Power end-to-end data operations for your Egnyte API with Nexla. Our bi-directional Egnyte connector is purpose-built for Egnyte, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Egnyte or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Egnyte workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites​

Nexla connects to Egnyte through the Egnyte Public API on your own Egnyte domain (https://<your-domain>.egnyte.com), using an Egnyte API key that your organization registers. Egnyte does not offer self-serve API keys, so complete the following steps before creating a credential in Nexla.

  1. Confirm that your organization is on an eligible Egnyte plan. Egnyte API keys are not available for Trial, Legacy Office, or Team plan domains.

  2. Have an active Egnyte domain administrator request an API key at developers.egnyte.com. Egnyte declines key requests from users who are not domain administrators, and a domain can hold at most five API keys.

  3. Choose the application type that matches the authentication method you plan to use:

    • OAuth 2.0 (Authorization Code): Register the key with the redirect URL https://dataops.nexla.io/nexla-api/oauth/callback. The redirect URL sent during sign-in must match the URL registered on the key exactly.

    • OAuth 2.0 (Username and Password, internal apps): Register the key as an internal application. The password grant is intended for trusted internal applications only.

  4. Wait for Egnyte to approve the key. New keys start as Pending Approval and become Active after Egnyte approves them; Egnyte sends an activation email, and the key works within about 20 minutes of that email.

  5. Copy the key (used as the API Key (Client ID) in Nexla) and its shared secret (the Client Secret). Keys issued after January 2015 require the secret.

Until a key is approved for production use, it only works against the single Egnyte domain registered on the key. Using one key across multiple Egnyte domains requires Egnyte's production approval, and production-approved keys must request their scopes explicitly. For complete details, see Egnyte's Getting Started and Authentication guides.

Egnyte API rate limits

Egnyte enforces limits per access token (not per API key): by default, 2 calls per second and a daily call quota that depends on your plan, from 1,000 calls per day (Business and Essentials) to 2,000 (Enterprise Lite and Elite) or 4,000 (Enterprise and Ultimate). The daily quota resets at 00:00 UTC. Listing a large folder tree or user base can use up the daily quota, so schedule sources that page through large result sets accordingly. Token requests are limited separately: 100 per hour for public applications, and 10 per user per hour for internal applications that use the password grant. See Egnyte's API best practices and FAQ for current limits.

Authenticate​

Every Egnyte credential needs your Egnyte Domain: the part of your Egnyte URL before .egnyte.com, entered without https:// or a trailing slash. For example, for https://acme.egnyte.com, enter acme. Nexla uses the domain for the token request and for every endpoint URL.

Credentials required​

Sign in to Egnyte in the browser. Needs an Egnyte API key and secret registered by a domain admin at developers.egnyte.com, with the Nexla callback as its redirect URL.

FieldRequiredSecretDescription
Egnyte DomainYesNoYour Egnyte domain name only: the part before .egnyte.com, without https:// or a trailing slash. For https://acme.egnyte.com enter acme.
API Key (Client ID)YesYesThe key of your Egnyte API key, from developers.egnyte.com (My Account > Applications).
Client SecretYesYesThe shared secret shown for the same Egnyte API key.
Access ScopeNoNoSpace-separated Egnyte scopes to request. The default covers every source and destination in this connector; production-approved keys must request scopes explicitly.

Both methods request the scopes Egnyte.filesystem Egnyte.link Egnyte.permission Egnyte.user Egnyte.group Egnyte.audit Egnyte.bookmark Egnyte.projectfolders by default, which cover every source and destination template on this page. Egnyte scopes are granted per API rather than per operation, so there is no read-only scope. If you narrow the scopes, templates that need an omitted scope will fail.

Create a credential in Nexla​

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Select the authentication method you want to use, and enter the required values:

    • OAuth 2.0 (Authorization Code): Enter your Egnyte Domain, the API Key (Client ID), and the Client Secret of your Egnyte API key. Optionally, adjust the Access Scope. When you save, Nexla opens the Egnyte sign-in page in your browser; sign in as the Egnyte user that Nexla should act as, and approve access.

    • OAuth 2.0 (Username and Password, internal apps): Enter your Egnyte Domain, the API Key (Client ID) and Client Secret of an internal Egnyte API key, and the Username and Password of the Egnyte user that Nexla should act as. Optionally, adjust the Scopes.

      Changing the Egnyte user's password revokes the token issued with the old password, so update the Password on this credential after a password change. Egnyte allows 10 token requests per user per hour for internal applications.

  4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Nexla tests the credential by reading the signed-in user's profile from Egnyte. The data the credential can read or change is limited to what that Egnyte user can access: for example, non-admin users only see the links they created, and the audit, user creation, user update, and group creation templates require a domain administrator.

Use as a data source​

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Egnyte connector tile, then select the credential that will be used to connect to Egnyte, and click Next; or, create a new Egnyte credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Egnyte endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Egnyte addresses files and folders by path. Unless a template says otherwise, enter paths without a leading slash (for example, Shared/Projects); top-level team content lives under Shared, and each user's own space lives under Private/<username>.

List Files in Folder

This endpoint template lists the files directly inside an Egnyte folder, including each file's name, path, size, entry ID, group ID, last-modified time, and version information. Use it to inventory the contents of a project or team folder. Results are fetched in pages of 1,000 files.

  • Enter the Folder Path without a leading slash (for example, Shared/Projects or Private/jsmith). Use the List Subfolders in Folder template to find folder paths.

List Subfolders in Folder

This endpoint template lists the subfolders directly inside an Egnyte folder, including each subfolder's name, path, folder ID, and parent ID. Use it to walk a folder tree or to find the folder paths and folder IDs that other templates require. Results are fetched in pages of 1,000 folders.

  • Enter the Folder Path without a leading slash (for example, Shared or Shared/Projects). Shared and Private are the top-level folders.

Get File or Folder Metadata

This endpoint template retrieves metadata for a single file or folder by path. For a file, it returns the size, entry ID, group ID, checksum, and versions; for a folder, it returns the folder ID and item counts.

  • Enter the File or Folder Path without a leading slash (for example, Shared/Projects/plan.pdf).

Search Files and Folders

This endpoint template searches files and folders by name, comments, or content, and returns each match's name, path, type, size, last-modified time, and a text snippet. Results are paged automatically.

  • Enter the Search Text (3 to 100 characters).
  • Select the File Fields to Search: All (default), File name, Comments, or Content.

Download File

This endpoint template downloads the latest version of a file by path and reads it as a file, so Nexla can parse its contents into records. Use it to ingest CSV, JSON, XLSX, and other structured files stored in Egnyte.

  • Enter the File Path without a leading slash (for example, Shared/Projects/report.csv).
  • Select the File Format Nexla uses to parse the downloaded file: CSV (default), JSON, XML, XLSX, Parquet, AVRO, or PDF.

List Recently Accessed Files

This endpoint template lists files that the connected user recently accessed or that Egnyte recommends for them.

  • Enter the Folder Path to limit results to recent files inside that folder. The default, /, covers the whole domain.

List Trash

This endpoint template lists the items in the Egnyte trash, newest deletion first, including each item's name, original path, type, size, who deleted it, the deletion date, and the purge date. Results are paged automatically.

  • No additional parameters are required.

List Links

This endpoint template lists share and upload links, including each link's path, type, accessibility (anyone, password, domain, or recipients), creator, creation date, and expiry. Use it to review which content is shared outside your organization. Results are paged automatically.

  • No additional parameters are required.
  • Non-admin users only see the links they created; connect as a domain administrator to review all links.

Get Link

This endpoint template retrieves the details of one link, including its URL, path, type, accessibility, recipients, expiry, and creator.

  • Enter the Link ID. Use the List Links template to find it.

Get Folder Permissions

This endpoint template retrieves the users and groups that have permissions on a folder, their permission level (None, Viewer, Editor, Full, or Owner), and whether the folder inherits permissions from its parent. Use it to review who has access to a folder.

  • Enter the Folder Path without a leading slash (for example, Shared/Projects). Use the List Subfolders in Folder template to find folder paths.

Get User's Effective Folder Permission

This endpoint template retrieves the effective permission level that one user has on one folder, after group and inherited permissions are applied.

  • Enter the Username to check. Use the List Users template to find it.
  • Enter the Folder Path as an absolute path that starts with a slash (for example, /Shared/Finance).

List Users

This endpoint template lists all users in the Egnyte domain, including each user's username, email address, name, active status, user type, role, authentication type, and last login. Use it to audit accounts or find inactive users. Results are paged automatically.

  • No additional parameters are required.

Get User

This endpoint template retrieves one user's profile, including username, email address, name, status, user type, role, and last login.

  • Enter the numeric User ID. Use the List Users template to find it.

List Groups

This endpoint template lists all groups in the Egnyte domain with their IDs and display names. Results are paged automatically.

  • No additional parameters are required.

Get Group Members

This endpoint template retrieves one group together with its members (user ID and name).

  • Enter the Group ID. Use the List Groups template to find it.

Get Current User

This endpoint template retrieves the user that the credential is signed in as, including the user ID, username, and first and last name. Use it to confirm which Egnyte account the credential acts as.

  • No additional parameters are required.

List Audit Events

This endpoint template reads audit events, such as file actions, logins, and permission, user, and group changes, from the last 7 days through the Egnyte audit stream. Results are read page by page using the cursor that Egnyte returns. This template requires a domain administrator account.

  • Enter the Start Date in YYYY-MM-DD format, within the last 7 days. The default, {now-6}, is six days before the current date.
  • Select the Audit Type: All types (default), File, Login, Permission, User, Group, Configuration settings, Workflow, or Upload requests.

Get Events Cursor

This endpoint template retrieves the latest and oldest event IDs of the Egnyte file system events stream. Use these IDs as the starting point for the List File System Events template.

  • No additional parameters are required.

List File System Events

This endpoint template reads up to 100 file system, comment, and permission-change events that occurred after a given event ID, including the action, actor, affected object, and time of each event.

  • Enter the Start Event ID to read from. Use the latest_event_id or oldest_event_id value returned by the Get Events Cursor template.

List Comments

This endpoint template lists the comments on a file or folder, including each comment's author, text, and time. Results are paged automatically.

  • Enter the File Path as an absolute path that starts with a slash (for example, /Shared/Projects/plan.pdf).

List Bookmarks

This endpoint template lists the folders that the connected user has bookmarked. Results are paged automatically.

  • No additional parameters are required.

List Metadata Namespaces

This endpoint template lists the custom metadata namespaces defined in the Egnyte domain, with their keys and types.

  • No additional parameters are required.

Get Metadata Namespace

This endpoint template retrieves one metadata namespace's keys, key types, and allowed values.

  • Enter the Namespace Name. Use the List Metadata Namespaces template to find it.

Get File Metadata Values

This endpoint template retrieves the custom metadata values set on a file within one metadata namespace.

  • Enter the file's File Group ID (its group_id). Use the List Files in Folder template to find it.
  • Enter the Namespace Name. Use the List Metadata Namespaces template to find it.

Get Folder Metadata Values

This endpoint template retrieves the custom metadata values set on a folder within one metadata namespace.

  • Enter the folder's Folder ID (its folder_id). Use the List Subfolders in Folder template to find it.
  • Enter the Namespace Name. Use the List Metadata Namespaces template to find it.

Get Folder Statistics

This endpoint template retrieves a folder's total size and its file and subfolder counts, by folder ID.

  • Enter the folder's Folder ID (its folder_id). Use the List Subfolders in Folder template to find it.

List Project Folders

This endpoint template lists the folders marked as projects, including each project's name, status, customer, dates, and root folder. Results are paged automatically.

  • No additional parameters are required.

Get Project Folder

This endpoint template retrieves one project folder's details, including its name, status, description, dates, and custom fields.

  • Enter the Project ID. Use the List Project Folders template to find it.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration​

Egnyte data sources can also be manually configured to ingest data from any valid Egnyte Public API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers. Egnyte endpoint URLs take the form https://<your-domain>.egnyte.com/pubapi/...; see the Egnyte API documentation for the available endpoints.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Egnyte data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination​

Click the + icon on the Nexset that will be sent to the Egnyte destination, and select the Send to Destination option from the menu. Select the Egnyte connector from the list of available destination connectors, then select the credential that will be used to connect to Egnyte, and click Next; or, create a new Egnyte credential for use in this flow.

Endpoint templates​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Egnyte endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Each record in the Nexset is sent as the JSON body of one request, one record at a time. Path and ID settings, such as Source Path or User ID, are fixed on the destination and apply to every record it sends, so each record acts on the same file, folder, user, or group.

Create Folder

This endpoint template creates a folder at the path configured on the destination. Parent folders must already exist.

  • Enter the New Folder Path: the full path of the folder to create, without a leading slash (for example, Shared/Projects/New Project).
  • Each record sent to this destination must be {"action": "add_folder"}. Because the path is fixed on the destination, send one record per destination.

Move, Copy or Rename File or Folder

This endpoint template moves, copies, renames, locks, or unlocks a file or folder. The operation and its target come from each record.

  • Enter the Source Path of the file or folder to act on, without a leading slash.
  • Each record carries the action and, for a move or copy, the destination, for example {"action": "move", "destination": "/Shared/Archive/plan.pdf"}.

Create Link

This endpoint template creates a share link for a file or folder, or an upload link that lets people outside your organization add files to a folder.

  • Each record must include path and type (file, folder, or upload). accessibility and expiry_date are optional.

Set Folder Permissions

This endpoint template sets user and group permissions on a folder.

  • Enter the Folder Path without a leading slash (for example, Shared/Finance).
  • Each record maps users or groups to a permission level, for example {"userPerms": {"jsmith": "Editor"}}. Valid levels are None, Viewer, Editor, Full, and Owner.

Create User

This endpoint template creates one Egnyte user per record. This template requires a domain administrator account.

  • Each record must include userName, email, name (with givenName and familyName), active, authType, and userType.

Update User

This endpoint template updates a user's fields from each record. This template requires a domain administrator account.

  • Enter the numeric User ID of the user to update. Use the List Users source template to find it.
  • Each record contains the fields to change, such as email, givenName, familyName, active, userType, or role.

Create Group

This endpoint template creates one group per record. This template requires a domain administrator account.

  • Each record must include displayName. members is optional and is a list of objects of the form {"value": 123}, where the value is a user ID.

Add or Remove Group Members

This endpoint template adds members to or removes members from a group using a SCIM PatchOp record.

  • Enter the Group ID. Use the List Groups source template to find it.
  • Each record contains schemas and Operations, for example an Operations value of [{"op": "add", "path": "members", "value": [{"value": 123}]}].

Add Comment

This endpoint template adds a comment to a file or folder from each record.

  • Each record must include path (an absolute path, such as /Shared/Projects/plan.pdf) and body (the comment text).

Create Bookmark

This endpoint template bookmarks a folder for the connected user from each record.

  • Each record must include either path or folder_id.

Mark Folder as Project

This endpoint template marks a folder as a project from each record.

  • Each record must include rootFolderId, name, and status (pending, in-progress, completed, on-hold, or canceled).

Set File Metadata Values

This endpoint template sets custom metadata values on a file within one metadata namespace.

  • Enter the file's File Group ID (its group_id). Use the List Files in Folder source template to find it.
  • Enter the Namespace Name. Use the List Metadata Namespaces source template to find it.
  • Each record maps key names to values, for example {"status": "approved"}.

Manual configuration​

Egnyte destinations can also be manually configured to send data to any valid Egnyte Public API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The Egnyte Public API expects JSON request bodies for the operations covered by the templates above. Destination writes count toward the same per-token rate limits as sources: 2 calls per second and a plan-dependent daily quota.

Save & activate​

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Egnyte endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Egnyte endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.