Getting Started with the Egnyte Public API

Overview

The Egnyte Public API enables developers to build applications that interact with an Egnyte domain programmatically. Using these APIs, you can integrate Egnyte with internal systems, automate workflows, build custom applications, and extend Egnyte functionality into your own products.

Common use cases include:

• Automating file and folder management
• Integrating Egnyte with business systems such as CRM, ERP, or DAM platforms
• Building workflow automation
• Creating custom tools that interact with Egnyte content and metadata
• Developing partner integrations for Egnyte customers

The Egnyte API is built on REST principles, uses JSON responses, and is secured through OAuth 2.0 authentication.

Most developers can make their first successful API request in just a few minutes by following the steps below.

Requesting an API Key

To authenticate with the Egnyte API, you must first create an API key from the Egnyte Developer Portal. This key is linked to your domain and allows it to request authentication tokens. Before creating an API key, please ensure the following requirements are met:

Prerequisites

• Eligible Plan: API access is only available to active Egnyte customers on eligible plans. Egnyte domains on Trial, Legacy Office, or Team plans are not supported. Contact your account manager or Egnyte Sales team to upgrade to the latest plan.
• Admin Access: API keys are restricted to Egnyte domain administrators. Please ensure you are requesting a key with an Egnyte Domain Admin account. API keys requested by a non-admin will be declined.
• Valid Admin Email: The email address must be associated with an active domain administrator account excluding Service Accounts for this domain.
• Egnyte Customers: If you are not an Egnyte customer and working on a third-party application integration made for the public, please fill out this form to request a developer domain.

Step 1: Register for a Developer Account

To start using the Public APIs, register for a developer account and create an application.

Step 2: Confirm Your Email

Click on the confirmation link to get access to developer portal:

Step 3: Access Your Apps

Login to your developer account and click on the drop-down arrow next to your email:

And click on "Apps":

Step 4: Create a New App

Click on New APP to create an application which will provide the API key and Secret.

Step 5: Fill in Application Details

Fill the details to request an API key and Secret.

Application Form Fields

Step 6: Save Your Application

Once you fill the form and request the API key, click Save.

Step 7: View Your API Key and Secret

Now you can see the API and Secret and the status of the API key:

Type of Auth Supported

Egnyte uses the OAuth 2.0 standard for secure authentication. The flow you choose depends on your application type:

• Authorization Code Flow (Recommended): Used for server-side applications. It is the most secure method as it keeps the token hidden from the browser.
• Implicit Grant Flow: Designed for client-side/browser applications (e.g., JavaScript single-page apps).
• Resource Owner Password Credentials (Internal Apps): Used primarily by customers for internal automation. You exchange an admin username and password directly for a token.
• Refresh Tokens: Support for obtaining new access tokens without requiring the user to re-authenticate.

Token Generation

You need a valid Access Token to make an API call. This token acts like a temporary key, proving your application has permission to access data and perform the operation programmatically.

Egnyte uses the OAuth 2.0 standard. To get started, identify which type of application key you have:

Choose Your Authentication Flow

Depending on your application type, you will use a specific "flow" to get your token:

• Internal Applications: If you are building a tool for your own company, use the Resource Owner flow.
• Public Applications: If you are building an integration for other Egnyte customers to use, use the Authorization Code (most secure) or Implicit Grant flow.

Authorization Code Flow

The Authorization Code Flow is the most commonly used OAuth 2.0 flow for server-side applications.

It is designed for applications where:

• API requests are made from a backend server
• Sensitive credentials (like tokens and secrets) can be stored securely
• You want to act on behalf of a user

Step 1: Initiate the Authentication Flow

In this step, your application redirects the user to Egnyte's OAuth authorization page. This is where:

• The user logs in
• The user grants permission to your application and clicks on "Allow Access"

Authorization URL:

https://<Egnyte Domain>.egnyte.com/puboauth/token?client_id=<API Key>&redirect_uri=<Callback URL>&scope=<SELECTED SCOPES>&state=<STRING>&response_type=code

Example:

https://apidemo.egnyte.com/puboauth/token?client_id=x2g35g8gynb5cedas649m4h4&redirect_uri=https://yourapp.com/oauth&scope=Egnyte.filesystem%20Egnyte.link&state=apidemo123&response_type=code

Path Parameters

Step 2: Make the Authorization Request

This is a HTTPS:GET call so you need to make this call from your browser, just enter the authorization URL in the browser and hit enter.

Step 3: Receive the Authorization Code

Once you click on "Allow Access", Egnyte redirects them back to your redirect_uri, where you will receive a code in the URL itself.

Step 4: Exchange Code for Access Token

After getting the "code" the next step is to make a HTTPS:POST call using any client to generate the token using the API details below:

API Endpoint: https://<Egnyte Domain>.egnyte.com/puboauth/token

Request Body: application/x-www-form-urlencoded

Request Body Parameters

Step 5: Receive the Access Token

Once you make the call with all the above parameters, you will receive a token as a response:

Sample Response:

{
  "access_token": "68zc99lfxv959htk3hbnma3q",
  "refresh_token": "46zc95e3xv954ujk3h0gya3f",
  "token_type": "bearer",
  "expires_in": 2592000
}

Make the First API Call

User Information API

You can fetch the details of the user who has generated the token using the Access token via this API call. After making the GET Request, you will get all details in JSON format as Response.

HTTP Method: GET

API Endpoint: https://{yourDomain}.egnyte.com/pubapi/v1/userinfo

Headers

API headers include the mandatory information you send along with the request URL and body. This information helps provide insights into request context and authorization credentials that, in turn, allows access to protected resources.

Request cURL:

curl -i -X GET "https://{yourDomain}.egnyte.com/pubapi/v1/userinfo" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "id": 12,
  "first_name": "egnyte",
  "last_name": "developer",
  "username": "egnytedev",
  "user_type": "admin",
  "email": "api-support@egnyte.com"
}

API Limits

Customers' use of the Egnyte Platform is subject to certain usage caps, limitations, and restrictions, which differ from plan to plan and are described below.

API Call Limits by Plan Family

Excludes calls from Egnyte applications. Additional calls can be purchased by contacting Egnyte API Support.

For more information on best practices, kindly check here.

Egnyte Sandbox

Request a Developer Domain

Egnyte can provide a free development domain for the ones working on a third-party application integration made for public use.

To request a development domain, contact Egnyte's Ecosystem team and ask to be provided a developer domain.

Customers or users working on a third-party integration for a specific domain or customer can reach out to the relevant account team to request a developer domain.

Please note the following rules for development domains:

• Development domains should not be used for purposes other than application development.
• These domains may be audited and purged from time to time.