Skip to content
Changelog

Report a bug

Egnyte integration: operations for AI agents

Egnyte connects to Type.com as an integration. This page lists the 210 operations documented for Claude and Codex in Type.com: 87 read, 66 write, 57 destructive.

About Egnyte

Egnyte is a cloud-based content collaboration platform that enables secure file sharing, storage, and governance for businesses.

Categories: Files & Storage

How to connect Egnyte to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

210 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

210 operations listed.

agents

  • Read

    List agents

    Returns all available AI agents configured in the domain.

    GET /pubapi/v1/ai/agents/list

  • Read

    Get agent execution status

    Retrieves the status and response of a previously submitted agent question. Poll this endpoint until status is COMPLETED or FAILED.

    GET /pubapi/v1/ai/agents/{agentId}/ask/{requestId}/status

  • Write

    Ask a question to an agent

    Submits a question to a specific agent. Returns a requestId to poll for the response. The question field is required; all other fields are optional. Maximum question length is 35,000 characters.

    POST /pubapi/v1/ai/agents/{agentId}/ask

ai

  • Read

    Get AI Assistant execution status

    Polls for the result of an async AI Assistant request. Call this endpoint after POST /v1/ai/assistant/ask until status is no longer IN_PROGRESS. Returns the answer text, citations, tool calls, and other execution details once complete.

    GET /pubapi/v1/ai/assistant/{executionId}/status

  • Read

    List knowledge bases (deprecated) (deprecated)

    **Deprecated.** Knowledge Bases have been migrated to Agents. Once your domain is migrated, this endpoint is no longer available and returns `410 Gone` with error code `KBA_MIGRATED_TO_AGENTS`. Use `GET /v1/ai/agents/list` instead. Your existing `kb-id` is now the `agentId`. Returns a paginated list of knowledge bases in the caller's domain. Sort by `createdOn` or `name` and specify filter criteria such as status (ACTIVE, DELETED or CREATED), createdBy, createdAfter, createdBefore, and flags to include placeholder data, processing statistics and prompts.

    POST /pubapi/v1/ai/kb/list

  • Read

    Hybrid semantic and keyword search

    Performs a hybrid search combining semantic (vector) and keyword-based retrieval across the caller's domain. Supports filtering by folder path, file types, date ranges, creator, and pagination.

    POST /pubapi/v1/hybrid-search

  • Write

    Ask a question about a document

    Generates an answer to a question based on the contents of a specific document version. The `entry-id` in the path identifies the document version. The request body must include a `question` string and may include an optional `includeCitations` boolean and a `chatHistory` object representing previous messages.

    POST /pubapi/v1/ai/document/{entry-id}/ask

  • Write

    Summarize a document

    Generates a concise summary of a document's contents. The `entry-id` identifies the document version. The request body may include an optional `chatHistory` object to provide context.

    POST /pubapi/v1/ai/document/{entry-id}/summary

  • Write

    Ask AI Assistant a question (async)

    Sends a question to AI Assistant and immediately returns an executionId. Poll GET /v1/ai/assistant/{executionId}/status to retrieve the answer once processing is complete. The request body must include a question and may optionally include selectedItems, chatHistory, includeCitations, conversationId, mcpSelectionId, and modelDetails. AI Assistant replaces the deprecated /v1/ai/copilot/ask endpoint; note that the response format has changed — the ask response is now asynchronous.

    POST /pubapi/v1/ai/assistant/ask

  • Write

    Ask Copilot a question (deprecated) (deprecated)

    **Deprecated.** This endpoint is deprecated and will be removed on September 30, 2026. Use `POST /v1/ai/assistant/ask` instead. Note: the replacement endpoint is **asynchronous** — POST `/assistant/ask` returns an `executionId`, and you must poll `GET /assistant/{executionId}/status` to retrieve the answer, whereas `/copilot/ask` returns the answer synchronously. Until then, `/copilot/ask` remains fully supported for backward compatibility. Sends a question to the Egnyte Copilot, which can search across the caller's domain or within selected files and folders. The request body must include a `question` and may include `selectedItems` (lists of folder IDs and file entry IDs), a `chatHistory` object and an `includeCitations` flag.

    POST /pubapi/v1/ai/copilot/ask

  • Write

    Ask a question about a knowledge base (deprecated) (deprecated)

    **Deprecated.** Knowledge Bases have been migrated to Agents. Once your domain is migrated, this endpoint is no longer available and returns `410 Gone` with error code `KBA_MIGRATED_TO_AGENTS`. Use `POST /v1/ai/agents/{agentId}/ask` instead. Your existing `kb-id` is now the `agentId`. Note: the replacement endpoint is **asynchronous** — it returns a `requestId`, and you must poll `GET /v1/ai/agents/{agentId}/ask/{requestId}/status` to retrieve the answer, whereas this endpoint returns the answer synchronously. Generates an answer based on the contents of a specific knowledge base. Provide the KB identifier in the path and a `question` in the request body along with optional `includeCitations` and `chatHistory` fields.

    POST /pubapi/v1/ai/kb/{kb-id}/ask

v1-reports

  • Read

    Check Audit Report Generation Status

    Returns the status of an audit report generation job. Poll this endpoint with the job identifier returned when a report is created. Returns HTTP 200 with status "running" while generating; returns HTTP 303 redirect when complete. Poll no more than once every 2 minutes.

    GET /pubapi/v1/audit/jobs/{id}

  • Read

    Retrieve Audit Report

    Downloads a completed audit report of the specified type using the report ID. When the report format is JSON, the offset and count query parameters can be used to paginate events.

    GET /pubapi/v1/audit/{type}/{id}

  • Write

    Create Login Audit Report

    Generates a login audit report for a given date range.

    POST /pubapi/v1/audit/logins

  • Write

    Create File Audit Report

    Generates a file audit report for a specified date range. Either `folders` or `file` must be specified.

    POST /pubapi/v1/audit/files

  • Write

    Create Permissions Audit Report

    Generates a permissions audit report for specified folders over a date range.

    POST /pubapi/v1/audit/permissions

  • Write

    Create User Provisioning Audit Report

    Generates a user provisioning audit report for specified users and actions within a date range.

    POST /pubapi/v1/audit/users

  • Write

    Create Group Provisioning Audit Report

    Generates a group provisioning audit report for specified groups and actions within a date range.

    POST /pubapi/v1/audit/groups

  • Write

    Create Configuration Settings Audit Report

    Generates a configuration settings audit report for specified users within a date range.

    POST /pubapi/v1/audit/workgroup-settings

  • Write

    Create Workflow Audit Report

    Generates a report on workflow activity including creation, completion, cancellation, step transitions, and task actions.

    POST /pubapi/v1/audit/workflows

  • Write

    Create Workflow Templates Audit Report

    Generates a report on workflow template changes including creation, editing, and status changes.

    POST /pubapi/v1/audit/workflow-templates

  • Write

    Create Quality Docs Audit Report

    Generates a report on Quality Docs activity including document actions, training assignments, and status changes.

    POST /pubapi/v1/audit/quality-docs

  • Write

    Create Quality Docs Categories Audit Report

    Generates a report on Quality Docs category and subcategory changes.

    POST /pubapi/v1/audit/quality-docs-categories

  • Write

    Create Quality Docs Courses Audit Report

    Generates a report on Quality Docs training course activity.

    POST /pubapi/v1/audit/quality-docs-courses

  • Write

    Create eTMF Audit Report

    Generates a report on electronic Trial Master File (eTMF) activity.

    POST /pubapi/v1/audit/etmf

  • Write

    Create Snapshot Restore Audit Report

    Generates a report on snapshot restore activity including mounting, unmounting, previewing, and restoring snapshots.

    POST /pubapi/v1/audit/snapshot-restore

  • Write

    Create Upload Requests Audit Report

    Generates a report on upload request activity including request creation, file uploads, document submissions, and approvals.

    POST /pubapi/v1/audit/upload-requests

v2-stream

  • Read

    Retrieve Audit Events (stream via GET)

    Retrieves a stream of audit events occurring within the last seven days. Either startDate or nextCursor is required, but not both. Returns up to 5,000 events and a nextCursor for subsequent requests. Rate limited to 10 requests per minute and 100 requests per hour.

    GET /pubapi/v2/audit/stream

  • Read

    Retrieve Audit Events (stream via POST)

    Retrieves a stream of audit events by sending parameters in the request body. Either startDate or nextCursor is required, but not both. Returns up to 5,000 events and a nextCursor for subsequent requests. Rate limited to 10 requests per minute and 100 requests per hour.

    POST /pubapi/v2/audit/stream

bookmarks

  • Read

    List Bookmarks

    Lists all bookmarks for the authenticated user. Optional query parameters offset and count may be used for pagination.

    GET /pubapi/v1/bookmarks

  • Read

    Get Bookmark by ID

    Retrieves the details for a specific bookmark.

    GET /pubapi/v1/bookmarks/{id}

  • Write

    Create Bookmark

    Creates a new bookmark on a folder. Supply either path to the folder to be bookmarked or folder_id (UUID).

    POST /pubapi/v1/bookmarks

  • Destructive

    Delete Bookmark

    Deletes a bookmark by id.

    DELETE /pubapi/v1/bookmarks/{id}

comments

  • Read

    List Comments

    Lists all comments for a given file or, if file is omitted and the caller is an admin, lists all comments for the domain.

    GET /pubapi/v1/notes

  • Read

    Show Comment

    Retrieves the details for a specific comment.

    GET /pubapi/v1/notes/{UUID}

  • Write

    Add Comment

    Creates a new comment on a file or folder. Requires path and body in the request.

    POST /pubapi/v1/notes

  • Destructive

    Delete Comment

    Deletes a specific comment by UUID.

    DELETE /pubapi/v1/notes/{UUID}

Documents

  • Destructive

    Import a Document

    Import a new document or a new version of an existing document into the Controlled Document Management app. Requires Admin or Category Manager role.

    POST /pubapi/v1/controlled-docs/documents/import

Assignments

  • Write

    Import Training Assignments

    Import training assignment records into the Controlled Document Management app. The system automatically calculates the training assignment status based on dueDate, completedDate, and canceledDate. Requires Admin or Category Manager role.

    POST /pubapi/v1/controlled-docs/assignments/import

Workspaces

  • Read

    List Workspaces

    Retrieve a list of all workspaces in your Egnyte domain. Requires the `Egnyte.documentportal` OAuth scope.

    GET /pubapi/v1/document-portal/workspaces

  • Write

    Create Workspace

    Create a new workspace from an existing folder, from a template, or as a blank workspace. Requires the `Egnyte.documentportal` OAuth scope. Exactly one of the following field combinations is required in the request body: - **From existing folder**: `workspaceFolderId` - **Blank workspace**: `workspaceParentFolderId` - **From template**: `workspaceParentFolderId` + `workspaceTemplateId` (optionally with `variables`)

    POST /pubapi/v1/document-portal/workspaces

Settings

  • Read

    Get Document Portal Settings

    Retrieve Document Portal configuration settings, including available workspace types. Requires the `Egnyte.documentportal` OAuth scope.

    GET /pubapi/v1/document-portal/settings

navigate

  • Write

    Launch a Navigate session (v2)

    Generates a one‑time URL that loads either the full Egnyte Web UI or an embedded view. The URL is valid for a single use and will return 404 if reused.

    POST /pubapi/v2/navigate

  • Write

    Launch a Navigate session (v1 – deprecated) (deprecated)

    Generates a one‑time redirect URL via an HTTP 303 response. The URL is returned in the `Location` header of the response. The client must not follow redirects automatically.

    POST /pubapi/v1/navigate/embedded/{scope}

etmf

  • Read

    List Studies

    Returns a list of studies the current user has access to. Requires the `Egnyte.etmf` OAuth scope.

    GET /pubapi/v1/etmf/studies

  • Read

    List Filing Levels

    Returns a list of filing levels the current user has access to for a given study. Requires the `Egnyte.etmf` OAuth scope.

    GET /pubapi/v1/etmf/studies/{studyId}/filing-levels

  • Read

    List Artifacts and Milestones

    Returns a list of artifacts and milestones for a specific filing level. Requires the `Egnyte.etmf` OAuth scope.

    GET /pubapi/v1/etmf/studies/{studyId}/artifacts

  • Read

    List Documents

    Returns a list of documents for a specific filing level. Requires the `Egnyte.etmf` OAuth scope.

    POST /pubapi/v1/etmf/studies/{studyId}/documents/listing

  • Write

    Add Documents

    Adds a document to a study. The document must already exist in the Egnyte file system. Requires the `Egnyte.etmf` OAuth scope.

    POST /pubapi/v1/etmf/studies/{studyId}/documents

events

  • Read

    Get a cursor for the events stream

    Returns the latest and oldest event identifiers along with a timestamp. Clients should call this endpoint once to establish a starting cursor before polling for events.

    GET /pubapi/v1/events/cursor

  • Read

    List events (version 1)

    Retrieves a list of events that have occurred after the event associated with the specified cursor. Use the `id` parameter to supply the cursor obtained from the cursor endpoint. Optional parameters allow filtering by folder, event type, and other criteria. If there are no events after the provided cursor the endpoint returns 204.

    GET /pubapi/v1/events

  • Read

    List events (version 2)

    Retrieves events in the same way as the v1 endpoint but also includes permission change events. By default this endpoint returns all event types: `file_system`, `note`, and `permission_change`. Use the `type` query parameter to filter the set returned.

    GET /pubapi/v2/events

Permissions

  • Read

    Get Effective Permissions for a User

    Retrieves the effective permissions for a specific user on a given folder. Takes into account both direct user permissions and group memberships, along with permission inheritance.

    GET /pubapi/v1/perms/user/{username}

  • Read

    Get Folder Permissions (v2)

    Retrieves all user and group permissions set on a specific folder, including permission inheritance status.

    GET /pubapi/v2/perms/{path}

  • Read

    Get Folder Permissions (v1, deprecated) (deprecated)

    Deprecated: Use the v2 endpoint instead. Retrieves permissions for specific users and groups on a folder. At least one of the users or groups query parameters must be provided.

    GET /pubapi/v1/perms/folder/{path}

  • Destructive

    Modify folder options

    Update configuration options for a folder, including description, link sharing permissions, move/delete restrictions, and email preferences. At least one field must be included in the request body. Note: email_preferences (notification settings) are write-only — they are not included in the response.

    PATCH /pubapi/v1/fs/{path}

  • Destructive

    Set Folder Permissions (v2)

    Sets or updates permissions for users and groups on a folder. This is a delta API — it only modifies the permissions you specify, leaving other permissions unchanged. To remove a permission, set it to None.

    POST /pubapi/v2/perms/{path}

  • Destructive

    Set Folder Permissions (v1, deprecated) (deprecated)

    Deprecated: Use the v2 endpoint instead. Sets the same permission level for multiple users or groups on a folder. At least one of users or groups must be provided.

    POST /pubapi/v1/perms/folder/{path}

fs

  • Read

    Retrieve file or folder metadata

    Returns metadata for the specified file or folder. When the `list_content` query parameter is set to `true` and the path refers to a folder, the contents of the folder are included in the response. Additional query parameters allow paging, sorting and inclusion of permissions or custom metadata.

    GET /pubapi/v1/fs/{path}

  • Read

    Retrieve file or folder metadata (v2)

    Functions the same as the v1 endpoint but may include additional metadata fields.

    GET /pubapi/v2/fs/{path}

  • Read

    Retrieve file or folder metadata by ID

    Returns metadata for the file or folder identified by its unique ID. Use `group_id` for files and `folder_id` for folders. Supports the same query parameters as the path-based GET endpoint.

    GET /pubapi/v1/fs/ids/{type}/{id}

  • Read

    Get folder statistics by ID

    Retrieves size and item count statistics for the folder identified by its unique ID, including all files and subfolders recursively.

    GET /pubapi/v1/fs/ids/folder/{folder_id}/stats

  • Write

    Perform a file or folder operation — add_folder

    Named action=add_folder payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Write

    Perform a file or folder operation — copy

    Named action=copy payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Write

    Perform a file or folder operation — unlock

    Named action=unlock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Write

    Perform a file or folder operation (v2) — add_folder

    Named action=add_folder payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Write

    Perform a file or folder operation (v2) — copy

    Named action=copy payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Write

    Perform a file or folder operation (v2) — unlock

    Named action=unlock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Write

    Perform a file or folder operation by ID — copy

    Named action=copy payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/ids/{type}/{id}

  • Write

    Perform a file or folder operation by ID — unlock

    Named action=unlock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/ids/{type}/{id}

  • Destructive

    Perform a file or folder operation

    Creates a new folder, moves or copies an item, renames an item, or locks/unlocks a file. The desired operation is specified by the `action` field in the request body. * `add_folder` – create a new folder at the specified path. * `move` – move the target to the destination path. * `copy` – copy the target to the destination path. * `rename` – rename the target; provide the new name in the `new_name` field. * `lock` – lock the file to prevent modifications. Optional fields: `lock_token`, `lock_timeout`, `collaboration`. * `unlock` – unlock a previously locked file. Requires the `lock_token` used when locking.

    POST /pubapi/v1/fs/{path}

  • Destructive

    Delete a file or folder

    Deletes the file or folder at the specified path. Returns the parent folder path of the deleted item.

    DELETE /pubapi/v1/fs/{path}

  • Destructive

    Perform a file or folder operation (v2)

    Same functionality as the v1 POST endpoint, with support for additional v2 features such as advanced permission handling.

    POST /pubapi/v2/fs/{path}

  • Destructive

    Delete a file or folder (v2)

    Deletes the specified file or folder. Returns the parent folder path of the deleted item.

    DELETE /pubapi/v2/fs/{path}

  • Destructive

    Perform a file or folder operation by ID

    Moves, copies, locks, or unlocks a file or folder identified by its unique ID. The desired operation is specified by the `action` field in the request body. * `move` – move the item to the destination. * `copy` – copy the item to the destination. * `lock` – lock the file to prevent modifications. * `unlock` – unlock a previously locked file.

    POST /pubapi/v1/fs/ids/{type}/{id}

  • Destructive

    Delete a file or folder by ID

    Deletes the file or folder identified by its unique ID. Returns the parent folder path of the deleted item.

    DELETE /pubapi/v1/fs/ids/{type}/{id}

  • Destructive

    Perform a file or folder operation — move

    Named action=move payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Destructive

    Perform a file or folder operation — rename

    Named action=rename payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Destructive

    Perform a file or folder operation — lock

    Named action=lock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/{path}

  • Destructive

    Perform a file or folder operation (v2) — move

    Named action=move payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Destructive

    Perform a file or folder operation (v2) — rename

    Named action=rename payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Destructive

    Perform a file or folder operation (v2) — lock

    Named action=lock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v2/fs/{path}

  • Destructive

    Perform a file or folder operation by ID — move

    Named action=move payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/ids/{type}/{id}

  • Destructive

    Perform a file or folder operation by ID — lock

    Named action=lock payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/ids/{type}/{id}

fs_content

  • Read

    Download file content by path

    Returns the raw contents of a file at the specified path. Optionally specify the `entry_id` query parameter to retrieve a specific revision of the file. Range requests are supported for partial content retrieval.

    GET /pubapi/v1/fs-content/{path}

  • Read

    Download file content by file ID

    Returns the raw contents of a file identified by its file system ID. Optionally specify the `entry_id` query parameter to retrieve a specific revision of the file. Range requests are supported for partial content retrieval.

    GET /pubapi/v1/fs-content/ids/file/{id}

  • Destructive

    Upload file content by path

    Uploads a file to the specified path. If the file already exists it will be overwritten; otherwise it will be created. The request must be sent as `multipart/form-data` with a single part named `file` containing the file bytes. For files larger than 100 MB, use the chunked upload endpoints (`POST /v1/fs-content-chunked/{path}` or `POST /v1/fs-content-chunked/ids/file/{id}`) instead.

    POST /pubapi/v1/fs-content/{path}

  • Destructive

    Chunked upload by path

    Uploads a large file in chunks to the specified path. Recommended for files larger than 100 MB. **Chunked Upload Process:** 1. Split the file into chunks (recommended size: 100 MB; min: 10 MB; max: 1 GB). All chunks must be the same size except the last. 2. Upload the first chunk with `X-Egnyte-Chunk-Num: 1` and `X-Egnyte-Chunk-Sha512-Checksum`. Save `X-Egnyte-Upload-Id` from the response. 3. Upload remaining chunks (except last) with `X-Egnyte-Upload-Id`, `X-Egnyte-Chunk-Num`, and `X-Egnyte-Chunk-Sha512-Checksum`. 4. Upload the final chunk with `X-Egnyte-Last-Chunk: true` and `X-Sha512-Checksum` set to the composite whole-file checksum `{version}-{numChunks}-{chunkSize}-{SHA512 of the concatenated hex-encoded chunk checksums}` (a plain SHA512 of the file bytes is rejected). 5. Chunks expire 24 hours after the first chunk upload.

    POST /pubapi/v1/fs-content-chunked/{path}

  • Destructive

    Chunked upload by file ID

    Uploads a large file in chunks to the location identified by its file system ID. Recommended for files larger than 100 MB.

    POST /pubapi/v1/fs-content-chunked/ids/file/{id}

groups

  • Read

    List groups

    Returns a paginated list of custom groups. You can use query parameters to control the starting index, the number of results returned, and to filter by display name.

    GET /pubapi/v2/groups

  • Read

    Get group details

    Retrieves details of a specific group by its ID.

    GET /pubapi/v2/groups/{groupId}

  • Write

    Create a group

    Creates a new group with the specified display name and optional members. Members should be supplied as an array of user IDs.

    POST /pubapi/v2/groups

  • Destructive

    Update a group

    Replaces the group's display name and membership. A complete set of members must be provided; omissions will remove members.

    PUT /pubapi/v2/groups/{groupId}

  • Destructive

    Partially update a group

    Performs a partial update on a group using the SCIM 2.0 PatchOp format. This can be used to rename the group or add/remove members without supplying the full membership.

    PATCH /pubapi/v2/groups/{groupId}

  • Destructive

    Delete a group

    Deletes the specified group. All membership associations will be removed.

    DELETE /pubapi/v2/groups/{groupId}

insights

  • Read

    List recently accessed files

    Returns a list of up to 10 files that the authenticated user has recently accessed. No parameters are required.

    GET /pubapi/v1/insights/files

links

  • Read

    Get link details

    Returns details of a specific link. Only administrators or the user who created the link can retrieve its details.

    GET /pubapi/v1/links/{linkId}

  • Read

    Get link details (v2)

    Returns details of a specific link. Same as the v1 endpoint but may include additional attributes.

    GET /pubapi/v2/links/{linkId}

  • Write

    Create a link

    Creates a new link for a file or folder. Specify the path to the item and set additional options such as link type, accessibility, expiration date, and notification preferences.

    POST /pubapi/v1/links

  • Write

    Create a link (v2)

    Same functionality as the v1 endpoint but may support additional fields or validations.

    POST /pubapi/v2/links

  • Destructive

    Delete a link

    Deletes a specific link. Only administrators or the user who created the link can delete it.

    DELETE /pubapi/v1/links/{linkId}

  • Destructive

    Delete a link (v2)

    Deletes a specific link. Same rules as the v1 endpoint.

    DELETE /pubapi/v2/links/{linkId}

metadata

  • Read

    List namespaces

    Lists all custom metadata namespaces defined in the domain.

    GET /pubapi/v1/properties/namespace

  • Read

    Get namespace keys

    Returns all custom metadata keys within the specified namespace.

    GET /pubapi/v1/properties/namespace/{namespaceName}

  • Read

    Get metadata values for a file or file version

    Returns the metadata values for the specified namespace on a file or file version identified by its group ID or entry ID.

    GET /pubapi/v1/fs/ids/file/{id}/properties/{namespaceName}

  • Read

    Get metadata values for a folder

    Returns the metadata values for the specified namespace on a folder identified by its ID.

    GET /pubapi/v1/fs/ids/folder/{id}/properties/{namespaceName}

  • Write

    Create a namespace

    Creates a new namespace with custom metadata keys. The request body defines the namespace name, scope, display name, and the key definitions.

    POST /pubapi/v1/properties/namespace

  • Write

    Update namespace attributes

    Updates the display name, key priorities, folder associations, or document type associations of a namespace. Only include folderAssociation or documentTypeAssociation in a single request, not both.

    PATCH /pubapi/v1/properties/namespace/{namespaceName}

  • Write

    Create a metadata key

    Adds a new key to an existing namespace.

    POST /pubapi/v1/properties/namespace/{namespaceName}/keys

  • Write

    Update a metadata key

    Updates attributes of a key within a namespace. You can change the display name, help text, priority and, in some cases, the type (to a broader type).

    PATCH /pubapi/v1/properties/namespace/{namespaceName}/keys/{keyName}

  • Write

    Set metadata values on a file or file version

    Sets values for multiple keys in the specified namespace on a file or file version. Use a group ID to set metadata on the latest version, or an entry ID to target a specific version.

    PUT /pubapi/v1/fs/ids/file/{id}/properties/{namespaceName}

  • Write

    Search metadata

    Searches for files and folders that have specific metadata fields or field values. The `key_with_value` search performs a substring match, not an exact match. If multiple objects are provided in either array, items matching any condition will be returned.

    POST /pubapi/v1/search

  • Write

    Set metadata values on a folder

    Sets values for multiple keys in the specified namespace on a folder.

    PUT /pubapi/v1/fs/ids/folder/{id}/properties/{namespaceName}

  • Destructive

    Delete a namespace

    Deletes the specified namespace. If the namespace or its keys are in use, a 403 error will be returned unless the request includes the `X-Egnyte-Force-Delete` header set to `Yes`.

    DELETE /pubapi/v1/properties/namespace/{namespaceName}

  • Destructive

    Delete a metadata key

    Deletes a key from a namespace. If the key is in use, a 403 error will be returned unless the request includes the `X-Egnyte-Force-Delete` header set to `Yes`.

    DELETE /pubapi/v1/properties/namespace/{namespaceName}/keys/{keyName}

  • Destructive

    Delete data for a single key

    Deletes specific enumerated values from a single metadata key. If the key data is in use and `X-Egnyte-Force-Delete` is not set to `Yes`, the request will fail with a 403 error.

    PATCH /pubapi/v1/properties/namespace/{namespaceName}/keys/{keyName}/data

  • Destructive

    Delete data for multiple keys

    Deletes specific enumerated values from multiple metadata keys in a single request. If the key data is in use and `X-Egnyte-Force-Delete` is not set to `Yes`, the request will fail with a 403 error.

    PATCH /pubapi/v1/properties/namespace/{namespaceName}/keys/data

search

  • Read

    Search files and folders (v1)

    Performs a keyword search across file names, folder names, full‑text content and metadata. The `query` parameter is required and must be between 3 and 100 characters. Optional parameters control pagination and filtering by folder or modification/upload dates and specify whether to include snippets.

    GET /pubapi/v1/search

  • Read

    Search with custom metadata (v2)

    Performs a metadata‑aware search. Provide `offset`, `count`, an optional list of `namespaces` and an array of `custom_metadata` filters. Each filter object requires a `namespace`, `key` and an `operator` (EQUALS, GREATER_THAN, LESS_THAN, BETWEEN, IN, HAS_KEY, HAS_NOT_KEY, CONTAINS, SUB_SET). The response includes a list of matching files with a `custom_properties` array.

    POST /pubapi/v2/search

  • Read

    Advanced search (v1)

    Performs an advanced search using a structured JSON criteria object. Parameters may include `keywords`, `path`, `owners`, date ranges such as `uploadedAfter` and `uploadedBefore`, and numeric filters like `sizeGreaterThan` and `sizeLessThan`. This endpoint mirrors the advanced search capabilities of the Egnyte web UI.

    POST /pubapi/v1/advanced_search

Webhooks

  • Read

    List Webhooks

    Returns all webhooks registered by the MSP.

    GET /pubapi/v1/msp/webhooks

  • Read

    Get Webhook Details

    Returns full details of a single webhook including event types, callback URL, and auth header.

    GET /pubapi/v1/msp/webhooks/{webhook_id}

  • Write

    Register a Webhook

    Registers a new webhook. Returns the ID and status of the newly registered webhook.

    POST /pubapi/v1/msp/webhooks

  • Destructive

    Update a Webhook

    Updates an existing webhook. All fields are replaced with provided values.

    PUT /pubapi/v1/msp/webhooks/{webhook_id}

  • Destructive

    Unregister a Webhook

    Unregisters a webhook so it no longer receives event notifications.

    DELETE /pubapi/v1/msp/webhooks/{webhook_id}

Domains

  • Read

    List Domains

    Returns a paginated list of Connect domains registered by the MSP.

    GET /pubapi/v1/msp/domains

  • Read

    Get Domain Details

    Returns full details of a single domain including license usage, features, and sources.

    GET /pubapi/v1/msp/domains/{domain}

Tenants

  • Read

    List Tenants

    Returns a paginated list of Protect tenants registered by the MSP.

    GET /pubapi/v1/msp/tenants

  • Read

    Get Tenant Details

    Returns full details of a single Protect tenant including CUP usage and monthly cost.

    GET /pubapi/v1/msp/tenants/{tenant_name}

Plans

  • Read

    List Plans

    Returns a paginated list of plans available to the MSP. Results may include Connect plans, DLC plans, and Protect plans, each with different fields.

    GET /pubapi/v1/msp/plans

  • Read

    Get Power Users Quote

    Returns a pricing quote for adding power users to the MSP pool without committing the purchase.

    POST /pubapi/v1/msp/plans/{planId}/power-users/quote/

  • Write

    Allocate Power Users to Domain

    Allocates power users from the MSP pool to a specific customer domain.

    POST /pubapi/v1/msp/domains/{domain}/power-users/allocate

  • Destructive

    Purchase Power Users

    Purchases additional power users for the MSP pool. Billed immediately on a prorated basis for the remainder of the billing period.

    POST /pubapi/v1/msp/plans/{planId}/power-users/purchase/

Trials

  • Write

    Start New Trial

    Creates a new trial domain under the MSP reseller account.

    POST /pubapi/v1/msp/trials/

  • Destructive

    Activate Trial

    Converts a trial domain to a paid subscription.

    POST /pubapi/v1/msp/trials/{domain}/activate/

Users

  • Read

    Get list of users

    Returns a paginated list of users belonging to the requesting MSP reseller.

    GET /pubapi/v1/msp/users

  • Read

    Get user details

    Returns a single user belonging to the requesting MSP reseller.

    GET /pubapi/v1/msp/users/{userId}

  • Read

    Get user activity logs

    Returns a paginated list of activity logs for the given MSP user, newest first.

    GET /pubapi/v1/msp/users/{userId}/logs

notes

  • Read

    Get comment details

    Returns details of a specific comment identified by its UUID.

    GET /pubapi/v1/notes/{noteId}

  • Destructive

    Delete a comment

    Deletes a specific comment. Only the comment creator or an administrator can delete comments.

    DELETE /pubapi/v1/notes/{noteId}

procore

  • Read

    List synced projects

    List synced projects for given domain.

    GET /pubapi/v1/procore/sync

  • Read

    Synced project details

    Synced project details.

    GET /pubapi/v1/procore/sync/{syncId}

  • Read

    List Procore projects

    List Procore projects for given company account. In order to use the API commands, Egnyte's DMSA key must be verified once per company via setting up a sync in the Egnyte WebUI.

    GET /pubapi/v1/procore/company/{companyId}/projects

  • Write

    Create sync project

    Create sync between egnyte folder and procore project. In order to use the API commands, Egnyte's DMSA key must be verified once per company via setting up a sync in the Egnyte WebUI.

    POST /pubapi/v1/procore/sync

  • Write

    Update sync option

    Update sync option between egnyte folder and procore project. In order to use the API commands, Egnyte's DMSA key must be verified once per company via setting up a sync in the Egnyte WebUI.

    PATCH /pubapi/v1/procore/sync/{syncId}

  • Destructive

    Remove sync project

    Remove sync between egnyte folder and procore project. In order to use the API commands, Egnyte's DMSA key must be verified once per company via setting up a sync in the Egnyte WebUI.

    DELETE /pubapi/v1/procore/sync/{syncId}

project-custom-fields

  • Read

    List all custom field definitions

    Fetch all project custom field definitions for the domain.

    GET /pubapi/v1/properties/project-tag/custom-fields

  • Write

    Create a custom field definition

    Create a new project custom field definition. **Validation rules:** - `enum` and `multi_value_enum` fields require a non-empty `data` array. - `labels` fields accept an optional `data` array. - Primitive types (`string`, `integer`, `decimal`, `date`) must not include `data`. - `project_status` is a reserved field. New custom status values can be added to it, but its `displayName`, `helpText`, `priority`, and default status cannot be modified. - The internal `name` is auto-derived from `displayName` (lowercase, spaces → hyphens). Duplicate names are resolved with numeric suffixes (e.g., `field-1`, `field-2`). - The domain's maximum custom fields limit must not be exceeded.

    POST /pubapi/v1/properties/project-tag/custom-fields

  • Destructive

    Update a custom field definition

    Update an existing custom field definition. All body fields are optional. **Behavior by type for `data`:** - **Dropdown with single select (`enum`):** New values *replace* existing values. - **Dropdown with multi select (`multi_value_enum`) and labels:** New values are *appended* to existing values.

    PATCH /pubapi/v1/properties/project-tag/custom-fields/{field_name}

  • Destructive

    Delete a custom field definition

    Delete a custom field definition and remove all its values from all existing projects. **Warning:** This operation cannot be undone. When the field is in use, a `403` error is returned. Set the `X-Egnyte-Force-Delete` header to `Yes` to force deletion.

    DELETE /pubapi/v1/properties/project-tag/custom-fields/{field_name}

  • Destructive

    Delete custom field definition data

    Remove specific predefined values from an `enum`, `labels`, or `multi_value_enum` field and clear their usage from all existing projects. **Warning:** This operation cannot be undone. When the field data is in use, a `403` error is returned. Set the `X-Egnyte-Force-Delete` header to `Yes` to force deletion. The request body is a JSON array of string values to delete.

    PATCH /pubapi/v1/properties/project-tag/custom-fields/{field_name}/data

project_folders

  • Read

    List all projects

    Lists all project folders in the domain. The response includes a JSON array of project objects. Pagination parameters can be supplied via query string to control the number of results returned.

    GET /pubapi/v2/project-folders

  • Read

    Get project details

    Retrieves detailed information about a project folder identified by its project ID. The response includes metadata such as the root folder ID, project name, projectId, customer name, description, location, status and timestamps.

    GET /pubapi/v2/project-folders/{projectId}

  • Write

    Mark folder as project

    Converts an existing folder into a project folder. Supply the root folder ID, a name for the project and a status. Optionally include a description and start and completion dates. If successful, the new project metadata is returned.

    POST /pubapi/v1/project-folders

scim

  • Read

    List users

    Returns a paginated list of users. Query parameters `startIndex` (1‑based) and `count` (max 100) control pagination; `filter` lets you retrieve a subset of users by attributes such as userName or email.

    GET /pubapi/scim/v2/Users

  • Read

    Get user

    Retrieves a single user by their ID.

    GET /pubapi/scim/v2/Users/{userId}

  • Read

    List groups

    Lists custom groups in the domain (default groups are not returned). Pagination parameters `startIndex` and `count` are supported; a `filter` can be used to match group names.

    GET /pubapi/scim/v2/Groups

  • Read

    Get group

    Returns the details of a single group, including its members.

    GET /pubapi/scim/v2/Groups/{groupId}

  • Write

    Create user

    Creates a new user in the domain. The request body must contain a SCIM user object with required attributes `userName` and `name`. Optional attributes include `emails`, `externalId`, `active` and `groups`.

    POST /pubapi/scim/v2/Users

  • Write

    Create group

    Creates a new custom group. Provide a `displayName` and optionally a list of member user IDs.

    POST /pubapi/scim/v2/Groups

  • Destructive

    Replace user

    Replaces a user’s attributes entirely. Provide a full SCIM user object.

    PUT /pubapi/scim/v2/Users/{userId}

  • Destructive

    Update user

    Partially updates a user using a SCIM Patch operation (RFC 7644). The request body must contain a list of operations to apply.

    PATCH /pubapi/scim/v2/Users/{userId}

  • Destructive

    Delete user

    Removes a user from the domain.

    DELETE /pubapi/scim/v2/Users/{userId}

  • Destructive

    Replace group

    Replaces a group’s attributes and membership entirely.

    PUT /pubapi/scim/v2/Groups/{groupId}

  • Destructive

    Update group

    Applies partial updates to a group using SCIM Patch operations (e.g. add or remove members).

    PATCH /pubapi/scim/v2/Groups/{groupId}

  • Destructive

    Delete group

    Removes a group from the domain.

    DELETE /pubapi/scim/v2/Groups/{groupId}

sfdc

  • Read

    Get folder mapping for a Salesforce record

    Retrieves the Egnyte folder mapped to a Salesforce record. Supply the 18‑character Salesforce record ID as the path parameter. The response returns the folder path and folder UUID.

    GET /pubapi/v1/sfdc/foldermap/{recordId}

sign

  • Read

    List Templates

    Retrieve a list of active templates available to the authenticated user.

    GET /pubapi/v1/egnyte-sign/templates

  • Read

    Get Template Details

    Retrieve detailed information about a specific template, including participants and document configuration.

    GET /pubapi/v1/egnyte-sign/templates/{template_id}

  • Read

    List Sent Signature Requests

    Retrieve all signature requests sent by the authenticated user.

    GET /pubapi/v1/egnyte-sign/signature-requests/sent-requests

  • Read

    List Assigned Signature Requests

    Retrieve all signature requests assigned to the authenticated user.

    GET /pubapi/v1/egnyte-sign/signature-requests/my-requests

  • Write

    Create Signature Request

    Create a signature request from an existing template. If the template includes role-based participants, you must provide recipient mappings.

    POST /pubapi/v1/egnyte-sign/signature-requests

  • Destructive

    Cancel Signature Request

    Cancel an in-progress signature request. This action cannot be undone.

    POST /pubapi/v1/egnyte-sign/signature-requests/{agreement_id}/cancel

tasks

  • Read

    List tasks assigned to the current user

    Returns a paginated list of workflow tasks assigned to the authenticated user. Optional query parameters allow filtering by task status (NOT_STARTED, IN_PROGRESS, BEING_CANCELLED, CANCELLED, SUSPENDED, APPROVED, REJECTED, COMPLETED), controlling the page size (limit), specifying an offset for pagination, and sorting by name, due date, status or task type in ascending or descending order.

    GET /pubapi/v1/workflows/tasks

tokens

  • Read

    Get user information for a token

    Returns basic user information (id, first name, last name, username) associated with the OAuth access token presented in the Authorization header.

    GET /pubapi/v1/userinfo

  • Read

    Inspect the current token

    Returns the OAuth client ID, username, domain and granted scopes for the current token. Requires a valid OAuth token but no specific scope.

    GET /pubapi/v1/whoami

  • Destructive

    Revoke an OAuth token

    Revokes a bearer token. This endpoint accepts a form‑encoded body with a single `token` field containing the token to revoke.

    POST /pubapi/v1/tokens/revoke

Trash

  • Read

    List Trash Contents (v1) (deprecated)

    Retrieve a paginated list of all items in the trash. **Deprecated:** Use GET /pubapi/v2/fs/trash for new integrations.

    GET /pubapi/v1/fs/trash

  • Read

    List Trash Contents (v2)

    Retrieve a paginated list of all items in the trash with optional filtering by user and date range.

    GET /pubapi/v2/fs/trash

  • Read

    Get Trash Total Count

    Retrieve the total count of items in the trash without fetching the full list. Use this endpoint before paginating with the v2 list endpoint.

    GET /pubapi/v2/fs/trash/totalcount

  • Write

    Restore or Permanently Delete Items from Trash — RESTORE

    Named action=RESTORE payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/trash

  • Destructive

    Restore or Permanently Delete Items from Trash

    Restore or permanently delete up to 10 files, folders, or versions from the trash. Set `action` to `RESTORE` to restore items to their original locations, or `PURGE` to permanently delete them. Purged items cannot be recovered.

    POST /pubapi/v1/fs/trash

  • Destructive

    Restore or Permanently Delete Items from Trash — PURGE

    Named action=PURGE payload capability sharing the displayed route; complete discriminated request and response contract retained.

    POST /pubapi/v1/fs/trash

Templates

  • Read

    List Templates

    Retrieves a list of available upload request templates. Use this endpoint to obtain template IDs and default instructions needed when creating upload requests.

    GET /pubapi/v1/upload-requests/templates

Upload Requests

  • Write

    Create Upload Request

    Creates a new upload request and sends it to one or more assignees. Assignees can be internal users (identified by `userId`) or external users (identified by `externalEmail`).

    POST /pubapi/v1/upload-requests

users

  • Read

    List users

    Retrieves a paginated list of users. Administrators can filter the results using the `filter` parameter, and control pagination using the `startIndex` and `count` query parameters. The response includes SCIM pagination attributes (`itemsPerPage`, `totalResults`, `startIndex`) and an array of user resources.

    GET /pubapi/v2/users

  • Read

    Get a single user

    Retrieves detailed information for a specific user identified by the numeric user id.

    GET /pubapi/v2/users/{id}

  • Read

    List users (legacy)

    Legacy version of the user list endpoint. It functions similarly to `/v2/users` but may return slightly different field names. For new integrations use `/v2/users`. Parameters and responses are omitted here for brevity.

    GET /pubapi/1.0/users

  • Write

    Create a user

    Creates a new user. Required fields include userName, email, name, active, authType and userType. Additional options include sending an invitation email and specifying a language or externalId. Returns the created user resource.

    POST /pubapi/v2/users

  • Destructive

    Update a user

    Performs a partial update of the specified user. Only fields present in the request body will be updated.

    PATCH /pubapi/v2/users/{id}

  • Destructive

    Delete a user

    Deletes the specified user.

    DELETE /pubapi/v2/users/{id}

webhooks

  • Read

    List registered webhooks

    Returns all webhooks registered by the authenticated client. Each element includes a webhookId, expiration timestamp and status.

    GET /pubapi/v1/webhooks

  • Read

    Get webhook status

    Returns the status of a webhook (enabled or disabled) along with its expiration timestamp.

    GET /pubapi/v1/webhooks/{webhookId}/status

  • Read

    Get webhook details

    Returns full details of a webhook including its ID, expiration timestamp, status, event types, path, auth header and callback URL.

    GET /pubapi/v1/webhooks/{webhookId}/details

  • Write

    Register a webhook

    Registers a new webhook callback. The request body must include a callback URL (`url`), an array of event type strings (`eventType`) and optionally a comma‑separated list of folder paths to scope the webhook (`path`). Event type values can be wildcards such as `fs:*` or specific events like `fs:add_file`.

    POST /pubapi/v1/webhooks

  • Destructive

    Update a webhook

    Updates an existing webhook. Fields that can be updated include `url`, `eventType`, `path`, `status` (enabled or disabled) and custom headers.

    PUT /pubapi/v1/webhooks/{webhookId}

  • Destructive

    Unregister a webhook

    Deletes the specified webhook registration.

    DELETE /pubapi/v1/webhooks/{webhookId}

  • Destructive

    Set webhook status

    Updates the status of a webhook to enabled or disabled. Provide a JSON body with a `status` property set to either `enabled` or `disabled`.

    POST /pubapi/v1/webhooks/{webhookId}/status

workflows

  • Read

    List workflows

    Returns a list of workflows visible to the caller. Admins receive all workflows in the domain; non‑admins receive only the workflows they created. Supports filtering by assignerId, assigneeId, groupId, status and completionStatus, as well as pagination and sorting.

    GET /pubapi/v1/workflows

  • Read

    Get workflow details

    Fetches the details of a specific workflow, including steps, assignees, status and associated file.

    GET /pubapi/v1/workflows/{workflowId}

  • Write

    Create a workflow

    Creates a new workflow on a file. The request body must include a workflow name, the file’s groupId and an array of step definitions. Optionally include a reasonForChange and workflowType (TODO, APPROVAL or REVIEW_APPROVE). Each step definition contains a name, type (TODO, REVIEW or APPROVAL), optional description and stepOptions specifying assignees, dueDate, minMustComplete and signatureRequired.

    POST /pubapi/v1/workflows

  • Write

    Send completion signal for a webhook task

    Marks a task of type Outbound Webhook as completed. When using an outbound webhook step with the completion signal option enabled, the payload includes a callback URL; invoke this endpoint to signal completion.

    POST /pubapi/v1/workflows/{workflowId}/tasks/{taskId}/completion-signal

  • Destructive

    Cancel a workflow

    Cancels an in‑progress workflow. Once cancelled, the workflow cannot be resumed.

    POST /pubapi/v1/workflows/{workflowId}/cancel

OAuth connection setup

  • Write

    Initiate authorization-code consent

    Named OAuth authorization_code setup flow on the shared token endpoint.

    GET /puboauth/token

  • Write

    Initiate implicit-grant consent

    Named OAuth implicit setup flow on the shared token endpoint.

    GET /puboauth/token

  • Write

    Exchange authorization code

    Named OAuth authorization_code setup flow on the shared token endpoint.

    POST /puboauth/token

  • Write

    Acquire internal-app password token

    Named OAuth password setup flow on the shared token endpoint.

    POST /puboauth/token

  • Write

    Refresh OAuth token pair

    Named OAuth refresh_token setup flow on the shared token endpoint.

    POST /puboauth/token

See How connections work for access and permissions, or browse all integrations.