• Introduction
  • About the CTERA Portal API
  • About This Guide
  • About the Examples in This Guide
  • Contacting Technical Support
• CTERA Portal RESTful API Basics
  • CTERA Object Model
    • Supported HTTP Methods
    • Examples
  • The API Base URL
  • User Authentication
  • HTTP Response Status Codes
• Logging In and Out
  • Logging In
  • Logging Out
  • Changing the Current Virtual Portal
• Operations on CTERA API Objects
  • Reading Objects
  • Modifying Objects
  • Deleting Objects
  • Invoking Extended Methods
  • Creating Objects
• Enumerations
  • AccountStatus
  • ACLRuleType
  • AdminUsernamePolicy
  • AdminPortalRole
  • BackupPassphraseProtectionPolicy
  • BillingCycle
  • BillingMode
  • BooleanFunction
  • CalculatedAccountStatus
  • CloudDriveLogging
  • CloudFolderMode
  • CompressionMethod
  • Comment
  • CountryCode
  • CountryCodeForRegion
  • DayOfWeek
  • DeviceType
  • DirectoryConnectorType
  • EnableDisable
  • EncryptionMode
  • FileAccessMode
  • GenericRC
  • InvoiceStatus
  • Language
  • LogSeverity
  • LogSourceType
  • LogTopic
  • OriginType
  • Permission
  • PlanItemEnum
  • PortalActivationStatus
  • PortalObjType
  • PortalRole
  • PortalServiceState
  • ProjectAccessMode
  • ProtectionLevel
  • RemoteAccessType
  • ReportType
  • ResellerPortalDeduplicationLevel
  • ScheduleType
  • SendFormat
  • SLAWarning
  • SsoType
  • TeamPortalDeduplicationLevel
• Object Classes
  • AccessControlRule
  • ActiveDirectory
  • ActiveDirectorySettings
  • ADDomainIDMapping
  • AddOn
  • AddonItem
  • AddonParam
  • AddonsStatisticsReport
  • AddonStatistics
  • ADGroup
  • ADIDMapping
  • ADSearchResult
  • ADUser
  • AlertRule
  • ApplicationsTopic
  • Backup
  • BackupPolicy
  • BackupPolicyTemplate
  • BackupSet
  • BackupTemplate
  • BaseObject
  • BaseUser
  • BillingAddress
  • CliCommandTemplate
  • CloudDrive
  • CloudDrivePolicyRule
  • CloudFolder
  • ConfigTopic
  • CreditCard
  • CteraPhoneNumber
  • CustomizedTemplate
  • DailySchedule
  • DevicesStatisticsReport
  • DeviceStatistics
  • DeviceTemplate
  • DeviceTemplateAutoAssignmentRule
  • DeviceTemplateSettings
  • DirectoryConnector
  • DirEntry
  • Domain
  • DomainControlIPAddresses
  • EffectiveSLA
  • ExportFolderParams
  • FileEntry
  • FilterRule
  • FirmwaresSettings
  • FoldersGroup
  • FolderGroupStatistics
  • FolderGroupsStatisticsReport
  • FoldersListTopic
  • FolderStatistics
  • FoldersStatisticsReport
  • FolderStats
  • Group
  • HomeFolderSettings
  • HourlySchedule
  • Invoice
  • InvoiceComponent
  • IntervalSchedule
  • IpRange
  • Log
  • MailSettings
  • ManagedDevice
  • MonthlySchedule
  • NoPlanDefaults
  • Notification
  • NotificationCategories
  • OfficeOnlineSettings
  • PasswordPolicySettings
  • PasswordsHistoryParams
  • Plan
  • PlanAutoAssignmentRule
  • PlanItem
  • PlanOptions
  • PlansStatisticsReport
  • PlanStatistics
  • Portals
  • PortalAdmin
  • PortalEndUser
  • PortalGuiSettings
  • PortalGroup
  • PortalInvitation
  • PortalInvitationEmailAndKey
  • PortalInvitationSettings
  • PortalNotification
  • PortalRoleSettings
  • PortalServiceStatus
  • PortalSettings
  • PortalStatistics
  • PortalsStatisticsReport
  • PortalStats
  • PortalUser
  • PortalUserStats
  • ProjectACLRule
  • ProjectManagementPermissionRule
  • Report
  • ResellerPortal
  • ResellerPortalNewUserSettings
  • ResellerPortalSpecificSettings
  • RetentionPolicy
  • RolesSettings
  • SamlSettings
  • ScheduleTopic
  • SessionTokenParams
  • Skin
  • Snapshot
  • SoftwareUpdatesTopic
  • SSOSettings
  • StorageLocationStatistics
  • StorageLocationsStatisticsReport
  • SyncThrottlingSettings
  • SyncThrottlingTopic
  • TaskSchedule
  • TeamPortal
  • TeamPortalNewUserSettings
  • TeamPortalSpecificSettings
  • TemplateFirmware
  • ThrottlingSettings
  • ThrottlingTopic
  • TimeRange
  • TotalConnectionStatus
  • TotalStatus
  • TotalStorage
  • TrustSecurityCode
  • UserAddOn
  • Voucher
  • WatermarkSettings
  • WeeklySchedule
• Managing CTERA Portal Users
  • Creating a New Portal User
  • Modifying Individual Attributes of a Portal User
  • Fetching the Details of an Existing Portal User
  • Setting the Plan of a Portal User
  • Adding an Addon to a Portal User
  • Removing an Addon from a Portal User
  • Deleting a Portal User
  • Fetching Active Directory Users into CTERA Portal
    • Fetching and Syncing Active Directory Users and Groups
  • Generate an Access Tokens to Impersonate a User
• Managing Virtual Portals
  • Creating a Reseller Portal
  • Creating a Team Portal
  • Modifying Individual Attributes of a Reseller Portal
  • Modifying Individual Attributes of a Team Portal
  • Fetching the Details of an Existing Reseller Portal
  • Fetching the Details of an Existing Team Portal
  • Adding an Addon to a Reseller Portal
  • Adding an Addon to a Team Portal
  • Removing an Addon from a Reseller Portal
  • Removing an Addon from a Team Portal
  • Unsubscribing a Reseller Portal from a Plan
  • Unsubscribing a Team Portal from a Plan
  • Deleting a Reseller Portal
  • Deleting a Team Portal
  • Scanning Portal Backup Files For Malware
  • Running an Antivirus Scan to Rescan Files
• Generating Reports
• Managing Files and Folders with WebDAV
  • WebDAV Java Examples
  • WebDAV Access URLs
  • Base URLs
    • Internal WebDAV
    • External WebDAV
  • Deleting a File or Directory
    • Internal WebDAV
    • External WebDAV
  • Creating a Directory
    • Internal WebDAV
    • External WebDAV
  • Moving or Renaming a File or Directory
    • Internal WebDAV
    • External WebDAV
  • Copying a File or Directory
    • Internal WebDAV
    • External WebDAV
  • Downloading a File
    • Internal WebDAV
    • External WebDAV
  • Uploading a File or Directory
    • Internal WebDAV
    • External WebDAV
  • Listing Directory Content
    • Internal WebDAV
    • External WebDAV
  • Changing Sardine Client Constructor to Disallow Overwrite
• Setting Up Use From a Mobile Device
  • Setting up a mobile device
    • Logging in to a portal via a mobile device
    • Attaching a logged in mobile device to the portal
  • Folder Management
    • Retrieve a list of folders and their files
    • Search a folder for a file
    • Create a folder
    • Share a folder
    • Move a folder
    • Copy a folder
    • Rename a folder
    • Delete a folder
  • File Management
    • Share a file
    • Move a file
    • Copy a file
    • Rename a file
    • View the version history for a file
    • Delete a file
  • Upload a file to the portal
  • Set share permissions