Egnyte has migrated its API management platform from Mashery to Apigee. This change is required to maintain a secure, scalable, and reliable environment for all the API integrations.
As part of this change, users will only be required to create a new account using the same email address they previously used on the Mashery-based Egnyte Developers Portal.
All existing API keys will continue to be available and visible in the Developers Portal, ensuring no disruption to current integrations. In addition, developers will have the option to create new applications and generate new keys as needed. They can also revoke an API key, or disable it; however, these are optional actions and not related to the migration.
The article covers the steps to create a new account, access existing keys, and create new apps to get new keys. You can register for a key† and explore and test the APIs first, or dive right into the documentation.
Egnyte Public API is not available for customers on Trial, legacy Office and Team plans.
- We can only approve API keys for domain Admins that are not using Service Accounts.
- It is recommended to use a Service Account with Egnyte APIs when authorizing Access Tokens.
- For any questions or issues, please contact api-support@egnyte.com.
†Refer to Usage Restrictions by Plan for API calls limits and restrictions. Contact your Sales Rep or Egnyte Sales team for details.
Skip Ahead To...
Create an Account
Access Existing Keys
Get New Keys
Revoke an API Key
Disable an API
Create an Account
- Navigate to the Developers Portal and click on Sign In.
- Click on Create an account.
- Enter the details, read through and agree to the terms, and click on Create Account.
Users must provide the same email address previously used on the Mashery-based Developers Portal when creating their account.
- A new account will be created and an email will be sent for verification on the provided email address.
- Users can click on the link in the email and verify their account.
Back to Top...
Access Existing Keys
- Log in to the Developers Portal and click on the username on the top-right.
- Select Apps from the dropdown.
The existing Apps will be displayed. Click on the app to view the associated API keys.
Back to Top...
Get New Keys
- Log in to the Developers Portal and click on the username on the top-right.
- Select Apps from the dropdown.
- Click on New App.
- Provide the app details:
- Enter the required App Name and detailed Description.
Note: App requests with insufficient description will be not be approved. - Provide additional details as Egnyte domain (required), App Icon URL(Optional), Registered OAuth Redirect URI (If needed).
- Select Type as Publicly Available Application (default) or Internal Application (own company use only)
- Select the User Base
- Choose the Platform from the available options. Web App is selected by default.
- Enter the required App Name and detailed Description.
- Click on Request for Collaborate and/or Secure & Govern (SnG-API) to request for the key.
- The user must request for at least one API key for the app
- If both Collaborate and SnG-API are selected, one API key will be generated that can be used on both applications
- Only one API key can be requested from the Developers Portal for each application. To request for additional API keys for the same app, contact the API Support team
- Click on Save after entering all the details.
The API Support team will be notified and the user will be able to view the API keys. The status will remain inactive until the request is approved. The approval process can take up to 24 hours.
The status will change to Active once the request is approved.
Back to Top...
Revoke an API Key
- Log in to the Developers Portal and click on the username on the top-right.
- Select Apps from the dropdown.
- Click on the App Name to view the details.
- Under API Keys, Click on Revoke under Actions.
- Click on Confirm to revoke the key. This action cannot be undone.
Back to Top...
Disable an API
- Log in to the Developers Portal and click on the username on the top-right.
- Select Apps from the dropdown.
- Click on the App Name to view the details.
- Click on Disable for either of the APIs.
- Click on Save to save the changes. The app will then be updated.