Egnyte
Egnyte Public API

REST API providing programmatic access to files, folders, users, groups, permissions, links, audit reports, and workflows in an Egnyte tenant. All endpoints are hosted under the customer's tenant domain at https://{domain}.egnyte.com/pubapi/ and use OAuth 2.0 scoped tokens.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: Egnyte Public API
  version: "1.0"
  description: >-
    Egnyte Public API provides programmatic access to files, folders, users,
    groups, permissions, links, and audit reports in an Egnyte tenant.
    Authentication is via OAuth 2.0 scoped access tokens. All endpoints live
    under the customer tenant domain.
  contact:
    name: Egnyte Developers
    url: https://developers.egnyte.com/docs
servers:
  - url: https://{domain}.egnyte.com/pubapi
    description: Customer tenant
    variables:
      domain:
        default: acme
        description: Egnyte tenant subdomain
security:
  - oauth2: []
paths:
  /v1/fs/{path}:
    get:
      summary: List folder contents or get file metadata
      operationId: getFolderOrFileMetadata
      tags: [File System]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Folder or file metadata
          content:
            application/json:
              schema:
                type: object
    post:
      summary: Create folder or copy/move
      operationId: createFolderOrMove
      tags: [File System]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum: [add_folder, copy, move]
                destination:
                  type: string
      responses:
        '200':
          description: Action result
    delete:
      summary: Delete file or folder
      operationId: deleteFileOrFolder
      tags: [File System]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Deleted
  /v1/fs-content/{path}:
    get:
      summary: Download file content
      operationId: downloadFile
      tags: [File System]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: File bytes
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    post:
      summary: Upload file content
      operationId: uploadFile
      tags: [File System]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Upload result
  /v2/users:
    get:
      summary: List users
      operationId: listUsers
      tags: [Users]
      parameters:
        - in: query
          name: startIndex
          schema:
            type: integer
        - in: query
          name: count
          schema:
            type: integer
      responses:
        '200':
          description: User list
          content:
            application/json:
              schema:
                type: object
    post:
      summary: Create user
      operationId: createUser
      tags: [Users]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Created
  /v2/users/{userId}:
    get:
      summary: Get user
      operationId: getUser
      tags: [Users]
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: User
          content:
            application/json:
              schema:
                type: object
    put:
      summary: Update user
      operationId: updateUser
      tags: [Users]
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
    delete:
      summary: Delete user
      operationId: deleteUser
      tags: [Users]
      parameters:
        - in: path
          name: userId
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Deleted
  /v2/groups:
    get:
      summary: List groups
      operationId: listGroups
      tags: [Groups]
      responses:
        '200':
          description: Group list
          content:
            application/json:
              schema:
                type: object
    post:
      summary: Create group
      operationId: createGroup
      tags: [Groups]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Created
  /v1/links:
    post:
      summary: Create a shared link
      operationId: createLink
      tags: [Links]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                type:
                  type: string
                  enum: [file, folder]
                accessibility:
                  type: string
                  enum: [anyone, password, domain, recipients]
      responses:
        '200':
          description: Link created
  /v1/perms/{path}:
    get:
      summary: List folder permissions
      operationId: listPermissions
      tags: [Permissions]
      parameters:
        - in: path
          name: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Permissions
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{domain}.egnyte.com/puboauth/token
          tokenUrl: https://{domain}.egnyte.com/puboauth/token
          scopes:
            Egnyte.filesystem: File system access
            Egnyte.user: User management
            Egnyte.group: Group management
            Egnyte.permission: Permission management
            Egnyte.link: Shared link management
            Egnyte.audit: Audit report access
Egnyte Public API

Documentation

Specifications

Other Resources

OpenAPI Specification
