- Based on Comet 25.3.1
- Support yearly retention rules
- Support yearly schedule rules
- Support storage vault key rotation
- Support restoring deduplicated files from NTFS disk images
Update to 24.12.5
- Based on Comet 24.12.5
- Based on Comet 24.12.4
- Based on Comet 24.12.4
- Based on Comet 24.12.3
- Additional properties for BrandingOptions, BrandingProperties and ServerMetaBrandingProperties
- Based on Comet 24.12.2
- Support new Login Protection feature
- Support requiring password changes for admin accounts
- Support new user grouping functionality
- Support creating a first admin account on empty servers
- Support vault-device associations and automatic vault creation
- Based on Comet 24.9.6
- New API AdminDispatcherTestSmbAuth to instruct a device to test Windows SMB credentials
- New RESTORETYPE_WINDISK_VHDX to restore Disk Image backup as Hyper-V VHDX format
- BackupJobDetail supports ConflictingJobID field to indicate conflicting job if a lock error occurred
- BackupJobProgress can report the total number of items for progress visualization
- DiskDrive adds information about parent disks on Linux
- Based on Comet 24.9.1
- Added Hyper-V Guest limits per user
- Added VMware Guest limits per user
- Added protected item type (engine) to protected item class
- Added Force Overwrite Restore permissions
- Based on Comet 24.6.6
- Add new AdminConvertStorageRole API
- Update data types for new job retry feature (BackupJobDetail, BackupRuleEventTriggers, and new JOB_STATUS_RUNNING_TRYAGAIN)
- Add support for custom Prefix in S3GenericVirtualStorageRole
- Based on Comet 24.6.4
- Added Server Device and Booster Limits
- Added API to count devices registered on a Server
- Added Software Build Role configuration per tenant
- Based on Comet 24.6.2
- Fixed an issue with the PHP SDK converting objects to arrays, during JSON encoding, when the keys are numeric
- Based on Comet 24.6.0
- Added custom HELO/EHLO STMP support
- Added support to set if disabled Office 365 accounts should be backed up
- Added EngineType as a property of VaultSnapshots
- Based on Comet 24.5.0
- Added support for matching Microsoft Office 365 users and groups by Drive ID
- Added support for configuring Object Lock on a Impossible Cloud Partner API Storage Template
- Added support for Custom Body Date when using a Custom Remote Bucket Storage Template
- Based on Comet 24.3.9
- Based on Comet 24.3.8
- Added support for configuring Software Build Role builder count
- Added LastStartTime field to job statistics
- Based on Comet 24.3.7
- Added support for configuring concurrency in Microsoft 365 Protected Items
- Based on Comet 24.3.6
- Testing new release process
- Based on Comet 24.3.5
- Based on Comet 23.12.3
- Based on Comet 23.12.3
- Based on Comet 23.12.1
- Based on Comet 23.11.2
- Based on Comet 23.9.11
- Based on Comet 23.9.9
- Add Syncro support
- Based on Comet 23.9.8
- Based on Comet 23.9.7
- Add VMware support
- (This git tag is identical to the v4.16.0 release version.)
- Based on Comet 23.9.6
- Added new "Comet Storage" and "Comet Storage (Object Lock)" storage destinations, allowing users to select Comet's new bundled Wasabi storage option for Storage Vaults (including Storage Templates)
- Fixed an issue with the Comet Server stats processing returning incorrect stats for previous days
- Fixed an issue in Comet Server web interface where creating or editing a custom Storage Vault can cause invalid Object Lock settings
- Based on Comet 23.9.5
- Add new field
LogLevel
to control job log verbosity - Add new
RESTORETYPE_WINDISK_ESXI
for restoring to VMware-compatible virtual disks
- Based on Comet 23.9.2
- 'UseObjectLock' for S3 compatible storage settings deprecated. Replaced by 'ObjectLockMode'
- New Streamable event SEVT_DEVICE_LOBBY_CONNECT and SEVT_DEVICE_LOBBY_DISCONNECT
- Added 'TOTPCode' to 'InstallCreds' used for device registration.
- 'GroupedBy' added to 'PSAConfig' for grouping statistics.
- New APIs
- AdminInstallationDispatchDropConnection
- AdminInstallationDispatchRegisterDevice
- AdminInstallationListActive
- AdminJobAbandon
- Based on Comet 23.8.0
- Improve documentation of JobStatus constants
- Based on Comet 23.6.9
- Added WebDAV
DestinationLocation
- Update PHPDoc types for arrays with non-int keys
- Based on Comet 23.6.9
- Support new API endpoints for managing external admin authentication sources
- Support Object Lock policy option
- Update docstrings for various types and fields
- Based on Comet 23.6.5
- Support
DeviceConfig->ClientVersion
- Support new
OSInfo
andRestoreJobAdvancedOptions
fields - Support new
SourceConfig
fields for tracking policy-enforced Protected Items - Support new optional parameters in
AdminDispatcherRunRestoreCustom
API - Add many more documentation comments, including behaviour of base64 byte arrays
- Based on Comet 23.5.0
- Add new
StreamableEventType
constants (SEVT_*
) used for tracking Comet Server config changes - Add new
StreamerType
constants (STREAMER_TYPE_*
) - Add new
FileOptions
type for configuring the Comet Server to log live events to a file - Add new field
AuditFileOptions
to theOrganization
type for configuring per-tenant audit log options - Add
Actor
(authenticated user),ResourceID
,Timestamp
andTypeString
fields to theStreamableEvent
type - Deprecate the
UserProfileFragment
type - Add extra comments to many types
- Based on Comet 23.3.7
- No functional changes
- Add significantly many more comments to constants, fields and types
- Based on Comet 23.3.5
- Support new
AdminDispatcherSearchSnapshots
API to remotely search for files in a Storage Vault - Support new
AdminMetaRemoteStorageVaultTest
API to test connections for a Storage Template - Support new
AccentColor
andBrandingStyleType
branding options for the Comet Server web interface - New Self-Backup option to include server logs
- Track creation and modification timestamps for
GroupPolicy
objects
- Based on Comet 23.3.1
- Support filter parameters on
AdminGetJobLogEntries
- Support S3 Object Lock
- Support Azure Key Vault codesigning
- Based on 22.12.8
- Add
TimeSpan
option toEmailReportOptions
- Add
AlertsDisabled
(default: false) toggle forPSAConfig
objects - Add
LastSuspended
for trackingUserProfileConfig
suspensions - Improve documentation
- Based on 22.12.2
- Add new
AdminCountJobsForCustomSearchRequest
API to count total number of jobs for a given search query - Add new
AdminMetaEmailOptionsGetRequest
/AdminMetaEmailOptionsSetRequest
/AdminMetaSendTestReportRequest
APIs for managing tenant email settings - Add new O365 Protected Accounts quota option in the
UserProfileConfig
- Add new tenant admin permission
AllowEditEmailOptions
- Based on 22.11.1
- Support
getCode()
on exceptions to retrieve internal error code - New features for PSAs, remote URLs and MS SQL Server restores.
- New features for exporting a self backup for single tenant.
- Based on 22.9.0
- Add Storj.io support as a Storage Vault Location and Storage Template provider
- Add Constellation role support for Tenants
- Add Webhook edit option for Tenant admins
- Add MySQL direct restore option
- Improve Office365 credentials handling
- Based on 22.6.7
- Add support enforcing the
RandomDelaySecs
for both whole-server and in policies - Add support for username filter parameter in
AdminDispatcherListActive
- Add custom region parameters for S3-compatible storage
- Add IDrive e2 as a Storage Template provider and in Constellation, including access-key cleanup
- Add
OverwriteIfNewer
toRestoreJobAdvancedOptions
- Add Office365 User Principal names
- Based on 22.6.2
- BREAKING: Add support for PHP 7 return type declarations and scalar argument types. PHP 7.0 is now the minimum required PHP version
- BREAKING: Remove deprecated
::createFrom()
methods, deprecated since SDK 3.0.0. Callers should switch tocreateFromArray
(drop-in compatible, but with known issues for server round-trips) orcreateFromStdclass
- BREAKING: The
Organization::Email
class member is now declared asEmailOptions
type instead ofAdminEmailOptions
. This change is fully backward-compatible on the HTTP/JSON level, but may cause issues if your application code checked this type explicitly - BREAKING: The
AdminOrganizationDeleteRequest
API's response type has changed to beAPIResponseMessage
, notOrganizationResponse
. The Comet Server API had only ever filled in theAPIResponseMessage
-compatible fields of theOrganizationResponse
structure, so the HTTP/JSON response is unchanged, but this may cause issues if your application code checked this type explicitly - "Requestable" Storage Vaults have been renamed to "Storage Templates". The API endpoint is unchanged, so this is backward-compatible with older Comet Server instances
- Document all
ServerConfigOptions
types for theAdminMetaServerConfigSet
andAdminMetaServerConfigGet
APIs - Add new
FallbackServers
option for LDAP external authentication sources - Add new
RandomDelaySecs
option for job schedules
- Based on 22.5.0
- Add support for AWS Virtual Storage Roles
- Add
$TargetOrganization
to some API methods to support cross-tenant actions - Add
RESTOREARCHIVEFORMAT_TARZSTD
for tar.zst archive restore format - Add
COMPRESS_*
Server Self-Backup compression settings - Add zh-TW language
- Based on 22.3.7
- Add new
REMOTESERVER_S3_GENERIC
RemoteServerType
- Add new
S3GenericVirtualStorageRole
support to theRemoteServerAddress
- Based on 22.3.5
- Add new
RestrictRuntime
,FromTime
,ToTime
,RestrictDays
,DaysSelect
types to ScheduleConfig to add time and day restrictions in a hourly schedule. - Add new
TotalVmCount
toBackupJobDetail
API. - Add new fields to
MacOSCodeSignProperties
to support code signing.
- Based on 22.3.0
- Add new
ForceUpgradeRunning
,ApplyDeviceFilter
, andDeviceFilter
fields toUpdateCampaign
types to support sending a bulk upgrade to a custom query of users
- Based on 22.2.0
- Add new
AdminBrandingGenerateClientSpkDsm6
andAdminBrandingGenerateClientSpkDsm7
APIs and associated types for generating and downloading Synology SPKs - Add new
PathAppIconImage
field to branding options types to support branding of the app icon when installed in Synology's Package Center (and other software managers) - Add new constants for VMDK single file restore
- Fix an issue with serialization of types which include BASE64-ed byte array fields
- Based on 21.12.4
- Add
AdminStoragePingDestination
API to perform a server-side Test Connections action when configuring Storage Role - Add
DestinationSize*
onBackupJobDetail
struct, to track Storage Vault size measurements taken as part of jobs - Add
HasLicense
onOffice365MixedVirtualAccount
struct, and addTotalLicensedMailsCount
andTotalUnlicensedMailsCount
onBackupJobDetail
struct, to track Office 365 license usage - Add
AdminWebAuthnRegistration
newType
field andWEBAUTHN_DEVICE_TYPE
constants, to determine the type of hardware WebAuthn device - Add deprecation comments to U2F types (use WebAuthn instead), to
B2DestinationLocation.MaxConnections
, and toOffice365CustomSetting
(use Office365CustomSettingV2 instead) - Fix an issue with wrong array types in
WebAuthnPublicKeyCredentialCreationOptions
andWebAuthnPublicKeyCredentialRequestOptions
- Fix an issue with executable permissions on some files
- Based on 21.12.1
- Add
AdminAccountWebauthnRegistration
endpoint for new WebAuthn support. - Deprecate
AdminAccountU2fSubmitChallenge
as U2F is ending browser support in February 2022.
- Based on 21.9.12
- Add support for Thai and Danish localizations
- Add From and To fields to the EmailReportGenerated API
- Add
AdminDispatcherEmailPreview
api method for requesting the HTML content of an email - Add
ImageEtag
field to the response of the ServerMetaBrandingProperties endpoint. - Add support for new engine properties on the Office365 backup type.
- Add
AdminDispatcherOffice365ListVirtualAccounts
api method for requesting Objects that Office365 is capable of backing up.
- Based on 21.9.7
- Add Support for HideFiles parameter in B2 Destination Locations
- Add support for RegistrationTime to the DeviceConfig
- Upgrade MYSQL to support new TLS connection options
- Add support for new API: AdminMetaReadAllLogsRequest and AdminDispatcherRequestWindiskSnapshot
- Based on Comet 21.9.2
- Support new
CustomHeaders
option on theWebhookOption
class for specifying custom HTTP headers to be sent in webhook POST requests from Comet Server
- Based on Comet 21.9.1
- Support new device_timezone field on the DeviceConfig class.
- Add admin_dispatcher_ping_destination api method
- Add support for new retention range type constants: RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY
- Add support for new retention range type constants: RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK
- Add support for new retention range type constants: RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH
- Add support for Microsoft Office 365 Sharepoiint constant STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY
- Add Microsoft Office 365 Region cloud region constants OFFICE_365_REGION_PUBLIC
- Add Microsoft Office 365 Region cloud region constants OFFICE_365_REGION_CHINA
- Add Microsoft Office 365 Region cloud region constants OFFICE_365_REGION_GERMANY
- Add Microsoft Office 365 Region cloud region constants OFFICE_365_REGION_US_GOVT
- Add Microsoft Office 365 Region cloud region constants OFFICE_365_REGION_US_DOD
- Based on Comet 21.6.6
- Support new
DefaultSourceWithOSRestriction
andLastSuccessfulBackupJob
fields - Support custom credentials when performing a cloud Office 365 restore job
- Support identifying Microsoft Teams folders inside a Sharepoint backup job
- Document the
SourceIncludePattern
structure used forPINCLUDE
/RINCLUDE
rules in a File-typeEngineProps
array - Document existing
BrandingProps
endpoint
- Based on Comet 21.6.1
- Add new APIs to remotely browse MySQL, MongoDB, MSSQL database servers
- Add Microsoft Office 365 properties on BackupJobDetail and on StoredObject
- Add Microsoft Office 365 browsing APIs
- Add Microsoft Office 365 Engine definition (
ENGINE_BUILTIN_MSOFFICE
) and associatedEngineProp
data structure definitions - Add
AdminDispatcherRegisterOfficeApplication
APIs - Add
RESTORETYPE_OFFICE365_CLOUD
constant - Support suspending organizations
- Support reading the Server Self-Backup status
- Support new
PathMenuBarIcnsFile
branding option for Comet Backup on macOS - Add more detailed description for
AdminDispatcherRequestStoredObjects
- Add defensive null checks when parsing fields that may be omitted
- Based on Comet 21.2.1
- Support restoring files to original paths
- Support the new "Custom" requestable Storage Vault provider type and its
CustomRemoteBucketSettings
structure - Support new
SpanUseStaticSlots
attribute - Fix missing fields in
ExternalLDAPAuthenticationSourceSettings
structure - Fix broken
AdminDispatcherRequestFilesystemObjects
that was parsing into the wrong response type
- Based on Comet 20.11.0
- Support new
AdminDispatcherDeleteSnapshots
API for deleting multiple snapshots in a single step - Support
AdminMetaResourceNew
API using multipart request - Support
setLanguage()
to request translated error messages and status codes - Fix an issue with expected filesizes unit tests for downloading software versions
- Fix a cosmetic issue with capitalization in AdminMetaResourceNewRequest API description
- Based on Comet 20.9.10
- Support new
ThawExec
feature
- Based on Comet 20.9.6
- Support new
AdminStorageBucketProperties
API - Allow passing in null or no value for
AdminStorageFreeSpace
parameter
- Based on Comet 20.9.1
- Support
SetTOTPCode
function, to authenticate against Comet Server with a temporary 6-digit TOTP code - Support new Organization feature
- Support new
AdminCreateInstallTokenRequest
API - Support new Admin user management APIs
- Support new
RebrandStorage
property on Storage Vaults and on Requestable destination targets - Fix an issue with incorrect type marshalling in
StorageFreeSpaceInfo.UsedPercent
- Remove some unnecessary null checks and constant comparisons when submitting an API parameter containing object data
- Add definitions for B2/Wasabi direct to cloud storage
- Add definitions for remote LDAP servers
- Use gzip content-encoding for all response bodies
- Update descriptions for
SEVT_META_HELLO
andAdminMetaWebhookOptionsSet
- Fix an issue with submitting boolean, array, and map parameters to the Comet Server
- Fix an issue with receiving 2xx status codes other than 200
- Fix an issue with interpreting null parameters where an array or key-value map was expected in the response
- Fix an issue with running the test suite against current versions of Comet Server
- Fix an issue with not properly configuring a custom SDK User-Agent for API requests
- Based on Comet 20.8.0
- Support new AdminGetJobLogEntries endpoint
- Based on Comet 20.6.8-rc
- Support new feature for configuring default Protected Items and default Schedules in Policies
- Support new Microsoft SQL Server OLE DB method type constants
- Support new MX Direct email method constant
- Fix an issue with wrong API name in phpdoc comment for
HybridSessionStartRequest
- Fix an issue with type definitions for
WebhookOptions
and forStorageSpaceFreeInfo->UsedPercent
- Fix an issue with statically calling non-static methods in
toJSON
andtoStdClass
methods
- Based on Comet 20.6.6-rc
- Support new Disk Image Protected Item type
- Support restoring files as archive (
RESTORETYPE_FILE_ARCHIVE
) or as physical disk image (RESTORETYPE_WINDISK
) - Support remotely browsing Application-Aware Writers, Exchange EDB databases, Hyper-V VMs, Disk Image drives
- Support webhooks (configure by submitting
WebhookOption
structs toAdminMetaWebhookOptions
APIs; webhook target will receiveStreamableEvent
by POST) - Support new limited permission APIs to modify server settings (
AdminMetaRemoteStorageVault
,AdminMetaBuildConfig
,AdminMetaBrandingConfig
) - Support new limited permission flags for admin user accounts (
PreventChangePassword
,AllowEditBranding
,AllowEditRemoteStorage
) - Support new
AdminDisableUserTotp
API - Update field definitions for
ConstellationCheckReport
data structure and its embedded data structures - Update description for
AdminDispatcherRequestFilesystemObjects
parameter - Fix an issue with incorrect data type marshalling in
AdminU2FRegistration
classRegistration
field
- Based on Comet 20.5.0
- Support new
RequirePasswordChange
field inUserProfileConfig
, and matching parameter on existingAdminAddUserRequest
API - Support new TOTP fields in
UserProfileConfig
and corresponding newAdminAccountValidateTotp
helper API - Support new
B2
field inStorageFreeSpaceInfo
class type - Support new
AdminDispatcherUninstallSoftware
API, and matchingUninstallConfig
parameter on existingAdminDeleteUser
API - Support new
AdminDispatcherRequestFilesystemObjects
API - Support new
AdminDispatcherUpdateLoginUrl
API - Support new
HideCloudStorageBranding
,RequirePasswordOpenAppUI
, andModeRequireUserResetPassword
policy fields in theUserPolicy
class type - Support new case-insensitive search clause operators
- Support new
EmailAddress
parameter onAdminPreviewUserEmailReport
API - Support new
OldPassword
parameter onAdminResetUserPassword
API
- Based on Comet 20.2.1
- Support new
AdminBrandingGenerateClientTest
andAdminStorageFreeSpace
APIs - Support new
GroupPolicy.DefaultUserPolicy
field - Support new
OSInfo
field in bothLiveUserConnection
andUserProfileConfig.Devices
- Based on Comet 19.12.2-rc
- Support new
AdminDispatcherDeleteSnapshot
andAdminMetaSendTestEmail
APIs - Support new
AllowZeroFilesSuccess
property on backup job advanced options - Support new properties for MongoDB, FTPS, Microsoft SQL Server, Regex searches, Periodic schedules
- Update description for Portuguese languages
- Fix an issue with exceptions thrown from placeholder
AdminMetaResourceNew
API
- Based on Comet 19.9.0-rc
- BREAKING: Change
AdminRequestStorageVault
response type to add extra parameter. This would be a backwards-compatible change if no callers are checking the exact returned object type from this function. - Fix spelling mistake in
AdminRequestStorageVault
API
- Based on Comet 19.6.9-rc
- Support new
AdminAccountSessionStartAsUser
API - Support existing
UserWebSessionStart
/UserWebSessionRevoke
APIs - Update documentation for
HybridSessionStart
API - Fix a cosmetic issue with inconsistent terminology for News APIs
- Based on Comet 19.6.2
- Support new
SelfAddress
parameter inAdminDispatcherUpdateSoftwareRequest
API - Support new Scheduled Emailer properties in
ServerMetaVersionInfo
API - Support new custom options in
AdminDispatcherRunBackupCustom
API - Support new
AdminDispatcherRunRestoreCustom
API - Support new
AdminMetaServerConfigNetworkInterfaces
API - Support new
JOB_STATUS_RUNNING_REVIVED
status - Update documentation for
JOB_STATUS_RUNNING_INDETERMINATE
- Update documentation for more
STOREDOBJECTYPE
constants - Fix wrong description for
AdminBrandingGenerateClientByPlatform
API
- Fix an issue with
\Comet\SearchClause
class type definition
- Fix an issue with unmarshalling empty objects to array instead of
stdClass
- Fix an issue with distinguishing empty arrays and empty objects when marshalling data after having used the compatibility methods
- Fix an issue with unmarshalling empty arrays from some versions of Comet Server, that were returning
null
instead of[]
(v2)
- Based on Comet 19.3.5-rc
- Support new S3 V2 signing option
- Support new filename consent options
- Support browsing and restoring single files from snapshots
- Fix an issue with unmarshalling empty arrays from some versions of Comet Server, that were returning
null
instead of[]
- Based on Comet 18.12.6-rc
- Support new "Account Name" field
- Support new retention options in policies, backup runtime options
- Support new software download APIs
- Support new hybrid admin/user session logon API
- Based on Comet 18.12.0
- Updated list of available languages in
\Comet\Def
- Fix an issue with JSON marshalling for objects containing top-level k/v maps
- Based on Comet 18.11.1
- Fix release codename in
\Comet\Def
- Fix an issue with error exceptions
- Based on Comet 18.11.1-rc
- Support new policy email report functionality
- Fix broken
multipart/form-data
AdminMetaResourceNew API - Fix undeclared
for_json_encode
variable in marshaller - Fix download size tests for latest version of Comet Server
- Remove unnecessary
isset
check in unmarshaller
- Based on Comet 18.9.9-rc
- Support new resource and security functionality
- Based on Comet 18.9.5-rc
- Support new email functionality
- Fix an issue with
AdminReplicationStateRequest
response types
- Based on Comet 18.9.2
- BREAKING: Throw exception on all non-200 status responses
- BREAKING: Make
inflateFrom()
method protected - BREAKING: Remove
forJSONEncode
parameter fromtoArray()
class methods - Accurately round-trip empty arrays/objects instead of using a heuristic
- New
createFromArray()
,createFromJSON()
,createFromStdclass()
,toStdclass()
class methods - Add test cases for downloading client software and for modifying server settings
- Fix an issue with
@unreached
response types
- Based on Comet 18.9.2-rc
- Add stub classes for
ServerConfigOptions
/ConstellationCheckReport
- Fix an issue with
MAXINT
constants - Fix an issue with
AdminPoliciesDeleteRequest
response types
- Based on Comet 18.8.2
- Fix an issue with Exception classes
- Based on Comet 18.8.1
- Initial public release