API Data Structures
AddBucketResponseMessage
class AddBucketResponseMessage extends CometAPIResponseMessage, NewBucketDetail { }
AdminAccountPropertiesResponse
class AdminAccountPropertiesResponse { string OrganizationID AdminUserPermissions Permissions AdminSecurityOptions Security }
AdminEmailOptions
class AdminEmailOptions { string FromEmail string FromName }
AdminResourceResponse
class AdminResourceResponse extends CometAPIResponseMessage { string ResourceHash }
AdminSecurityOptions
class AdminSecurityOptions { int PasswordFormat string Password bool AllowPasswordLogin bool AllowPasswordAndTOTPLogin // AllowPasswordAndU2FLogin has been deprecated since Comet version 21.12.0 bool AllowPasswordAndU2FLogin bool AllowPasswordAndWebAuthnLogin // U2FRegistrations has been deprecated since Comet version 21.12.0 List<AdminU2FRegistration> U2FRegistrations // Omission from JSON document implies an empty array List<AdminWebAuthnRegistration> WebAuthnRegistrations // Omission from JSON document implies an empty array int TOTPKeyEncryptionFormat // Omission from JSON document implies 0 string TOTPKey // Omission from JSON document implies empty string string IPWhitelist // Omission from JSON document implies empty string }
AdminU2FRegistration
This type has been deprecated since Comet version 21.12.0
class AdminU2FRegistration { string Description int RegisterTime List<byte> Registration }
AdminUserPermissions
class AdminUserPermissions { bool PreventEditServerSettings // Omission from JSON document implies false bool PreventServerShutdown // Omission from JSON document implies false bool PreventChangePassword // Omission from JSON document implies false bool AllowEditBranding // Omission from JSON document implies false bool AllowEditRemoteStorage // Omission from JSON document implies false }
AdminWebAuthnRegistration
class AdminWebAuthnRegistration { string Description int RegisterTime int Type bool IsLegacyU2F // Omission from JSON document implies false List<byte> ID // Omission from JSON document implies an empty array WebAuthnCredential Credential // Omission from JSON document implies zero-initialised WebAuthnCredential class instance }
AllowedAdminUser
class AllowedAdminUser extends AdminSecurityOptions { string Username string OrganizationID string ExternalAuthenticationSource // Omission from JSON document implies empty string AdminUserPermissions Permissions }
AvailableDownload
class AvailableDownload { string Category string Description bool Recommended }
AzureDestinationLocation
class AzureDestinationLocation { string AZBAccountName string AZBAccountKey string AZBContainer string AZBRealm string AZBPrefix }
B2DestinationLocation
class B2DestinationLocation { string AccountID // Omission from JSON document implies empty string string Key // Omission from JSON document implies empty string string Bucket // Omission from JSON document implies empty string string Prefix // Omission from JSON document implies empty string // MaxConnections has been deprecated since Comet version 21.9.7 int MaxConnections // Omission from JSON document implies 0 bool HideDeletedFiles // Omission from JSON document implies false }
B2StorageExtraInfo
class B2StorageExtraInfo { Dictionary<int, B2TransactionTotals> TotalTransactionsInTimeInterval }
B2TransactionTotals
class B2TransactionTotals { int ClassA int ClassB int ClassC }
B2VirtualStorageRoleSettings
class B2VirtualStorageRoleSettings { string MasterBucket string KeyID string AppKey bool HideDeletedFiles }
BackupJobAdvancedOptions
class BackupJobAdvancedOptions { bool SkipAlreadyRunning int StopAfter int LimitVaultSpeedBps bool ReduceDiskConcurrency bool UseOnDiskIndexes bool AllowZeroFilesSuccess }
BackupJobDetail
class BackupJobDetail { string GUID string Username int Classification int Status int StartTime int EndTime string SourceGUID string DestinationGUID string DeviceID string SnapshotID // Omission from JSON document implies empty string string ClientVersion int TotalDirectories int TotalFiles int TotalSize int TotalChunks int UploadSize int DownloadSize int TotalMailsCount // Omission from JSON document implies 0 int TotalSitesCount // Omission from JSON document implies 0 int TotalAccountsCount // Omission from JSON document implies 0 int TotalLicensedMailsCount // Omission from JSON document implies 0 int TotalUnlicensedMailsCount // Omission from JSON document implies 0 string CancellationID // Omission from JSON document implies empty string BackupJobProgress Progress // Omission from JSON document implies zero-initialised BackupJobProgress class instance SizeMeasurement DestinationSizeStart // Omission from JSON document implies zero-initialised SizeMeasurement class instance SizeMeasurement DestinationSizeEnd // Omission from JSON document implies zero-initialised SizeMeasurement class instance }
BackupJobProgress
class BackupJobProgress { int Counter int SentTime int RecievedTime int BytesDone int ItemsDone }
BackupRuleConfig
class BackupRuleConfig extends BackupJobAdvancedOptions { string Description int CreateTime int ModifyTime List<string> PreExec List<string> ThawExec List<string> PostExec string Source string Destination List<ScheduleConfig> Schedules BackupRuleEventTriggers EventTriggers }
BackupRuleEventTriggers
class BackupRuleEventTriggers { bool OnPCBoot // Omission from JSON document implies false bool OnPCBootIfLastJobMissed // Omission from JSON document implies false }
BrandingOptions
class BrandingOptions extends WebInterfaceBrandingProperties, BrandingProperties { }
BrandingProperties
class BrandingProperties extends PublicBrandingProperties, PrivateBrandingProperties { }
BrowseDiskDrivesResponse
class BrowseDiskDrivesResponse extends CometAPIResponseMessage { List<DiskDrive> Disks }
BrowseEDBResponse
class BrowseEDBResponse extends CometAPIResponseMessage { List<EDBFileInfo> Databases }
BrowseHVResponse
class BrowseHVResponse extends CometAPIResponseMessage { List<HyperVMachineInfo> VirtualMachines }
BrowseOffice365ListVirtualAccountsResponse
class BrowseOffice365ListVirtualAccountsResponse extends CometAPIResponseMessage { List<Office365MixedVirtualAccount> Objects }
BrowseOffice365ObjectsResponse
class BrowseOffice365ObjectsResponse extends CometAPIResponseMessage { List<Office365ObjectInfo> Objects }
BrowseSQLServerResponse
class BrowseSQLServerResponse extends CometAPIResponseMessage { Dictionary<string, string> Objects }
BrowseVSSResponse
class BrowseVSSResponse extends CometAPIResponseMessage { Dictionary<string, VSSWriterInfo> VSSWriters }
BucketProperties
class BucketProperties { string OrganizationID int CreateTime int ReadWriteKeyFormat string ReadWriteKey SizeMeasurement Size }
BucketUsageInfo
class BucketUsageInfo { List<int> ExistsOnServers List<UserOnServer> InUseBy }
CometAPIResponseMessage
class CometAPIResponseMessage { int Status string Message }
CometDestinationLocation
class CometDestinationLocation { string CometServer string CometBucket string CometBucketKey }
ConstellationCheckReport
class ConstellationCheckReport { int CheckStarted int CheckCompleted Dictionary<string, BucketUsageInfo> Usage }
ConstellationStats
class ConstellationStats { int LastCheckStart int TotalChecksStarted int TotalBucketsDeleted int ChecksCurrentlyActive }
ConstellationStatusAPIResponse
class ConstellationStatusAPIResponse { bool DeletionEnabled List<string> Targets List<string> TargetNames // Omission from JSON document implies an empty array ConstellationStats Stats }
ContentMeasurement
class ContentMeasurement { int MeasureStarted int MeasureCompleted List<ContentMeasurementComponent> Components }
ContentMeasurementComponent
class ContentMeasurementComponent { int Bytes List<string> UsedBy }
CreateGroupPolicyResponse
class CreateGroupPolicyResponse extends CometAPIResponseMessage { string PolicyHash }
CustomRemoteBucketSettings
class CustomRemoteBucketSettings { string URL }
DefaultEmailReportPolicy
class DefaultEmailReportPolicy extends UserCustomEmailSettings { bool ShouldOverrideDefaultReports }
DefaultSourceWithOSRestriction
class DefaultSourceWithOSRestriction { SourceConfig SourceConfig int RestrictOS }
DestinationConfig
class DestinationConfig extends DestinationLocation { string Description int CreateTime int ModifyTime List<string> PreExec List<string> ThawExec List<string> PostExec int EncryptionKeyEncryptionMethod string EncryptedEncryptionKey int RepoInitTimestamp bool StorageLimitEnabled int StorageLimitBytes DestinationStatistics Statistics // Omission from JSON document implies zero-initialised DestinationStatistics class instance RetentionPolicy DefaultRetention bool RebrandStorage }
DestinationLocation
class DestinationLocation extends CometDestinationLocation, S3DestinationLocation, SFTPDestinationLocation, FTPDestinationLocation, AzureDestinationLocation, LocalDestinationLocation, SpannedDestinationLocation { int DestinationType SwiftDestinationLocation Swift B2DestinationLocation B2 }
DestinationStatistics
class DestinationStatistics { SizeMeasurement ClientProvidedSize ContentMeasurement ClientProvidedContent string LastSuccessfulDeepVerify_GUID // Omission from JSON document implies empty string int LastSuccessfulDeepVerify_StartTime // Omission from JSON document implies 0 int LastSuccessfulDeepVerify_EndTime // Omission from JSON document implies 0 }
DeviceConfig
class DeviceConfig { string FriendlyName int RegistrationTime // Omission from JSON document implies 0 OSInfo PlatformVersion // Omission from JSON document implies zero-initialised OSInfo class instance Dictionary<string, SourceBasicInfo> Sources // Omission from JSON document implies an empty Dictionary string DeviceTimezone // Omission from JSON document implies empty string }
DiskDrive
class DiskDrive { string ID string DeviceName string Caption string Model string SerialNumber int Size List<Partition> Partitions int Flags int Cylinders int Heads int Sectors int SectorSize }
DispatcherAdminSourcesResponse
class DispatcherAdminSourcesResponse extends CometAPIResponseMessage { Dictionary<string, string> ImportSources }
DispatcherStoredObjectsResponse
class DispatcherStoredObjectsResponse extends CometAPIResponseMessage { List<StoredObject> StoredObjects }
DispatcherVaultSnapshotsResponse
class DispatcherVaultSnapshotsResponse extends CometAPIResponseMessage { List<VaultSnapshot> Snapshots }
DispatcherWindiskSnapshotResponse
class DispatcherWindiskSnapshotResponse extends CometAPIResponseMessage { List<DiskDrive> WindiskSnapshot }
EDBFileInfo
class EDBFileInfo { string Name string Guid string ServerName bool CircularLoggingEnabled }
EmailOptions
class EmailOptions extends AdminEmailOptions { string Mode string SMTPHost // Omission from JSON document implies empty string int SMTPPort // Omission from JSON document implies 0 string SMTPUsername // Omission from JSON document implies empty string string SMTPPassword // Omission from JSON document implies empty string bool SMTPAllowInvalidCertificate // Omission from JSON document implies false bool SMTPAllowUnencrypted // Omission from JSON document implies false }
EmailReportConfig
class EmailReportConfig { int ReportType List<ScheduleConfig> SummaryFrequency SearchClause Filter }
EmailReportGeneratedPreview
class EmailReportGeneratedPreview extends CometAPIResponseMessage { string From List<string> To string EmailSubject string EmailBodyHTML string EmailBodyPlaintext }
ExternalLDAPAuthenticationSourceSettings
class ExternalLDAPAuthenticationSourceSettings { string Hostname int Port string SecurityMethod string BindUser string BindPassword string SearchDN string SearchFilter bool AcceptInvalidSSL }
ExtraFileExclusion
class ExtraFileExclusion { string Exclude bool Regex int RestrictOS }
FTPDestinationLocation
class FTPDestinationLocation { string FTPServer string FTPUsername string FTPPassword bool FTPBaseUseHomeDirectory string FTPCustomBaseDirectory int FTPSMode int FTPPort int FTPMaxConnections bool FTPAcceptInvalidSSL }
GetGroupPolicyResponse
class GetGroupPolicyResponse extends CometAPIResponseMessage { GroupPolicy Policy string PolicyHash }
GetProfileAndHashResponseMessage
class GetProfileAndHashResponseMessage extends CometAPIResponseMessage { string ProfileHash UserProfileConfig Profile }
GetProfileHashResponseMessage
class GetProfileHashResponseMessage extends CometAPIResponseMessage { string ProfileHash }
GroupPolicy
class GroupPolicy { string Description string OrganizationID UserPolicy Policy bool DefaultUserPolicy }
HyperVMachineInfo
class HyperVMachineInfo { string ID string Name }
InstallCreds
class InstallCreds { string Username string Password string Server bool AutoLogin }
InstallToken
class InstallToken { string Username string Server string Token int CreateTime bool Used int ExpireTime }
InstallTokenResponse
class InstallTokenResponse extends CometAPIResponseMessage { InstallToken InstallToken }
JobEntry
class JobEntry { int Time string Severity string Message }
LiveUserConnection
class LiveUserConnection { string Username string DeviceID string ReportedVersion string ReportedPlatform OSInfo ReportedPlatformVersion // Omission from JSON document implies zero-initialised OSInfo class instance string DeviceTimeZone // Omission from JSON document implies empty string string IPAddress // Omission from JSON document implies empty string int ConnectionTime bool AllowsFilenames }
LocalDestinationLocation
class LocalDestinationLocation { string LocalcopyPath string LocalcopyWinSMBUsername string LocalcopyWinSMBPassword int LocalcopyWinSMBPasswordFormat }
MSSQLConnection
class MSSQLConnection { string Type string Username string Password string Hostname string InstanceName string Method }
MacOSCodeSignProperties
class MacOSCodeSignProperties { int Level SSHConnection SSHServer string CertificateName string AppCertificateName string AppleID string AppleIDPass int AppleIDPassFormat }
MongoDBConnection
class MongoDBConnection { string Server int Port string Username string Password string AuthenticationDB string MongoShellPath string MongodumpPath string ReadPreference bool UseReplica string ReplicaName List<string> ReplicaMembers bool UseSSL string ClientSSLPEMPath string ServerSSLPEMPath string SSLClientKeyPassword bool AllowInvalidCertificate bool AllowInvalidHostname bool UseSSH SSHConnection SSHConnection // Omission from JSON document implies zero-initialised SSHConnection class instance }
MySQLConnection
class MySQLConnection { string Host string Port string Username string Password bool UseTLS bool TLSSkipVerify string TLSCustomServerCAPath string TLSCustomClientCrtPath string TLSCustomClientKeyPath }
NewBucketDetail
class NewBucketDetail { string NewBucketID string NewBucketKey }
NewsEntry
class NewsEntry { string OrganizationID int DateTime string TextContent }
OSInfo
class OSInfo { string version // Omission from JSON document implies empty string string distribution // Omission from JSON document implies empty string string build // Omission from JSON document implies empty string }
Office365Connection
class Office365Connection { string FeatureFlag Office365Credential Credential Office365CustomSetting CustomSetting List<string> MailboxUniqueMembers List<string> SiteUniqueMembers Office365CustomSettingV2 CustomSettingV2 }
Office365Credential
class Office365Credential { string AppID string TenantID string Secret string AppCert string Region }
Office365CustomSetting
This type has been deprecated since Comet version 21.9.xx
class Office365CustomSetting { string MailboxStrategy string SiteStrategy List<string> MailboxUserIDs List<string> MailboxGroupIDs List<string> SiteIDs }
Office365CustomSettingV2
class Office365CustomSettingV2 { bool Organization Dictionary<string, int> BackupOptions // Omission from JSON document implies an empty Dictionary Dictionary<string, int> MemberBackupOptions // Omission from JSON document implies an empty Dictionary }
Office365MixedVirtualAccount
class Office365MixedVirtualAccount { string id int Type // Omission from JSON document implies 0 string DisplayName // Omission from JSON document implies empty string string Mail // Omission from JSON document implies empty string string JobTitle // Omission from JSON document implies empty string string SiteID // Omission from JSON document implies empty string string WebID // Omission from JSON document implies empty string string WebURL // Omission from JSON document implies empty string int EnabledServiceOption // Omission from JSON document implies 0 List<string> Members // Omission from JSON document implies an empty array int ServiceOptions // Omission from JSON document implies 0 int MemberServiceOptions // Omission from JSON document implies 0 bool hasLicense // Omission from JSON document implies false }
Office365ObjectInfo
class Office365ObjectInfo { string GUID string Name string Type string Value List<string> Members }
Organization
class Organization { string Name List<string> Hosts SoftwareBuildRoleOptions SoftwareBuildRole BrandingOptions Branding List<RemoteStorageOption> RemoteStorage Dictionary<string, WebhookOption> WebhookOptions AdminEmailOptions Email bool IsSuspended }
OrganizationResponse
class OrganizationResponse extends CometAPIResponseMessage { string ID Organization Organization }
Partition
class Partition { string DeviceName string Filesystem string VolumeName string VolumeGuid string VolumeSerial List<string> MountPoints int ReadOffset int Size int UsedSize int Flags int BytesPerFilesystemCluster }
PrivateBrandingProperties
class PrivateBrandingProperties extends WindowsCodeSignProperties { string PathIcoFile string PathIcnsFile string PathMenuBarIcnsFile string PathEulaRtf string PathTilePng string PathHeaderImage string PackageIdentifier MacOSCodeSignProperties MacOSCodeSign }
ProtectedItemEngineTypePolicy
class ProtectedItemEngineTypePolicy { bool ShouldRestrictEngineTypeList List<string> AllowedEngineTypeWhenRestricted }
PublicBrandingProperties
class PublicBrandingProperties { string ProductName string CompanyName string HelpURL bool HelpIsPopup string DefaultLoginServerURL string TileBackgroundColor string AccountRegisterURL bool HideBackgroundLogo }
RegisterOfficeApplicationBeginResponse
class RegisterOfficeApplicationBeginResponse { string Continuation string VerificationURL string UserCode }
RegisterOfficeApplicationCheckResponse
class RegisterOfficeApplicationCheckResponse { string Continuation bool Completed string Error Office365Credential Result // Omission from JSON document implies zero-initialised Office365Credential class instance }
RemoteServerAddress
class RemoteServerAddress { string Type string Description string RemoteAddress // Omission from JSON document implies empty string string Username // Omission from JSON document implies empty string string Password // Omission from JSON document implies empty string ExternalLDAPAuthenticationSourceSettings LDAP // Omission from JSON document implies zero-initialised ExternalLDAPAuthenticationSourceSettings class instance B2VirtualStorageRoleSettings B2 // Omission from JSON document implies zero-initialised B2VirtualStorageRoleSettings class instance WasabiVirtualStorageRoleSettings Wasabi // Omission from JSON document implies zero-initialised WasabiVirtualStorageRoleSettings class instance CustomRemoteBucketSettings Custom // Omission from JSON document implies zero-initialised CustomRemoteBucketSettings class instance }
RemoteStorageOption
class RemoteStorageOption extends RemoteServerAddress { bool StorageLimitEnabled int StorageLimitBytes bool RebrandStorage }
ReplicatorStateAPIResponse
class ReplicatorStateAPIResponse { string Description string RemoteServerID int DisplayClass int ActiveWorkers int TotalWorkers int State int ItemsQueued int BytesQueued int LastWorkerSubmitTime int CurrentTime int ItemsReplicated int BytesReplicated }
RequestStorageVaultResponseMessage
class RequestStorageVaultResponseMessage extends CometAPIResponseMessage { string DestinationID }
RestoreJobAdvancedOptions
class RestoreJobAdvancedOptions { int Type bool OverwriteExistingFiles bool DestIsOriginalLocation string DestPath List<string> ExactDestPaths int ArchiveFormat Office365Credential Office365Credential // Omission from JSON document implies zero-initialised Office365Credential class instance }
RetentionPolicy
class RetentionPolicy { int Mode List<RetentionRange> Ranges }
RetentionRange
class RetentionRange { int Type int Timestamp int Jobs int Days int Weeks int Months int WeekOffset int MonthOffset }
S3DestinationLocation
class S3DestinationLocation { string S3Server bool S3UsesTLS string S3AccessKey string S3SecretKey string S3BucketName string S3Subdir bool S3UsesV2Signing }
SFTPDestinationLocation
class SFTPDestinationLocation { string SFTPServer string SFTPUsername string SFTPRemotePath int SFTPAuthMode string SFTPPassword string SFTPPrivateKey bool SFTPCustomAuth_UseKnownHostsFile string SFTPCustomAuth_KnownHostsFile }
SSHConnection
class SSHConnection { string SSHServer string SSHUsername int SSHAuthMode string SSHPassword string SSHPrivateKey bool SSHCustomAuth_UseKnownHostsFile string SSHCustomAuth_KnownHostsFile }
ScheduleConfig
class ScheduleConfig { int FrequencyType int SecondsPast int Offset // Omission from JSON document implies 0 }
SearchClause
class SearchClause { string ClauseType string RuleField string RuleOperator string RuleValue List<SearchClause> ClauseChildren // Omission from JSON document implies an empty array }
SelfBackupStatistics
class SelfBackupStatistics { int CurrentRunStart int LastRunStart int LastRunEnd bool LastRunSuccess int LastRunSize }
ServerConfigOptionsBrandingFragment
class ServerConfigOptionsBrandingFragment { BrandingOptions Branding }
ServerConfigOptionsSoftwareBuildRoleFragment
class ServerConfigOptionsSoftwareBuildRoleFragment { SoftwareBuildRoleOptions SoftwareBuildRole }
ServerMetaBrandingProperties
class ServerMetaBrandingProperties { string BrandName string ProductName bool HasImage string ImageEtag string TopColor bool HideNewsArea bool AllowUnauthenticatedDownloads bool AllowAuthenticatedDownloads int PruneLogsAfterDays int ExpiredInSeconds }
ServerMetaVersionInfo
class ServerMetaVersionInfo { string Version string VersionCodename bool StorageRole bool AuthenticationRole bool SoftwareBuildRole bool OverseerRole bool ConstellationRole List<string> ExperimentalOptions // Omission from JSON document implies an empty array int ServerStartTime string ServerStartHash int CurrentTime string ServerLicenseHash int LicenseValidUntil int EmailsSentSuccessfully int EmailsSentErrors int EmailsWaitingInQueue int ScheduledEmailThreadCurrentState int ScheduledEmailThreadLastCalculateDurationNanos int ScheduledEmailThreadWaitingUntil int ScheduledEmailThreadLastWakeTime bool ScheduledEmailThreadLastWakeSentEmails List<SelfBackupStatistics> SelfBackup }
SessionKeyRegeneratedResponse
class SessionKeyRegeneratedResponse extends CometAPIResponseMessage { string SessionKey string SessionType }
SizeMeasurement
class SizeMeasurement { int Size int MeasureStarted int MeasureCompleted }
SoftwareBuildRoleOptions
class SoftwareBuildRoleOptions { bool RoleEnabled bool AllowUnauthenticatedDownloads }
SoftwareUpdateNewsResponse
class SoftwareUpdateNewsResponse { string latest_stable string latest_prerelease string downloads_url List<string> updates_info }
SourceBasicInfo
class SourceBasicInfo { string Description int Size Dictionary<string, RetentionPolicy> OverrideDestinationRetention // Omission from JSON document implies an empty Dictionary }
SourceConfig
class SourceConfig { string Engine string Description string OwnerDevice int CreateTime int ModifyTime List<string> PreExec List<string> ThawExec List<string> PostExec Dictionary<string, string> EngineProps Dictionary<string, RetentionPolicy> OverrideDestinationRetention // Omission from JSON document implies an empty Dictionary SourceStatistics Statistics // Omission from JSON document implies zero-initialised SourceStatistics class instance }
SourceIncludePattern
class SourceIncludePattern { string TopDirectory string Value }
SourceStatistics
class SourceStatistics { BackupJobDetail LastBackupJob BackupJobDetail LastSuccessfulBackupJob }
SpannedDestinationLocation
class SpannedDestinationLocation { List<DestinationLocation> SpanTargets bool SpanUseStaticSlots }
SpannedStorageExtraInfo
class SpannedStorageExtraInfo { List<StorageFreeSpaceInfo> Targets }
StatResult
class StatResult { int Buckets int Users int Devices int Boosters int NetworkDevices }
StorageFreeSpaceInfo
class StorageFreeSpaceInfo { bool Unlimited float32 UsedPercent int AvailableBytes SpannedStorageExtraInfo Spanned // Omission from JSON document implies zero-initialised SpannedStorageExtraInfo class instance B2StorageExtraInfo B2 // Omission from JSON document implies zero-initialised B2StorageExtraInfo class instance }
StorageVaultProviderPolicy
class StorageVaultProviderPolicy { bool ShouldRestrictProviderList List<int> AllowedProvidersWhenRestricted }
StoredObject
class StoredObject { string name int mtime string type string subtree int size string dname // Omission from JSON document implies empty string string itemClass // Omission from JSON document implies empty string string from // Omission from JSON document implies empty string string to // Omission from JSON document implies empty string int rtime // Omission from JSON document implies 0 bool has_attachments // Omission from JSON document implies false int stime // Omission from JSON document implies 0 int etime // Omission from JSON document implies 0 bool r // Omission from JSON document implies false int f // Omission from JSON document implies 0 int b // Omission from JSON document implies 0 int d // Omission from JSON document implies 0 }
StreamableEvent
class StreamableEvent { string OwnerOrganizationID int Type any Data // Omission from JSON document implies any value }
SwiftDestinationLocation
class SwiftDestinationLocation { string Username // Omission from JSON document implies empty string string APIKey // Omission from JSON document implies empty string string Region // Omission from JSON document implies empty string string AuthURL // Omission from JSON document implies empty string string Domain // Omission from JSON document implies empty string string Tenant // Omission from JSON document implies empty string string TenantDomain // Omission from JSON document implies empty string string TenantID // Omission from JSON document implies empty string string TrustID // Omission from JSON document implies empty string string AuthToken // Omission from JSON document implies empty string string Prefix // Omission from JSON document implies empty string string Container // Omission from JSON document implies empty string string DefaultContainerPolicy // Omission from JSON document implies empty string }
TestResponse
class TestResponse extends CometAPIResponseMessage { bool Exists }
TotpRegeneratedResponse
class TotpRegeneratedResponse extends CometAPIResponseMessage { string Image string URL string ProfileHash }
U2FRegisterRequest
This type has been deprecated since Comet version 21.12.0
class U2FRegisterRequest { string Challenge string Version }
U2FRegisteredKey
This type has been deprecated since Comet version 21.12.0
class U2FRegisteredKey { string AppID string KeyHandle string Version }
U2FRegistrationChallengeResponse
This type has been deprecated since Comet version 21.12.0
class U2FRegistrationChallengeResponse extends CometAPIResponseMessage { string ChallengeID string AppID List<U2FRegisteredKey> RegisteredKeys List<U2FRegisterRequest> RegisterRequests }
U2FSignRequest
This type has been deprecated since Comet version 21.12.0
class U2FSignRequest { string ChallengeID string ChallengeData string AppID List<U2FRegisteredKey> RegisteredKeys }
U2FSignResponse
This type has been deprecated since Comet version 21.12.0
class U2FSignResponse { string ChallengeID string KeyHandle string Signature string ClientData }
UninstallConfig
class UninstallConfig { bool UninstallFlag bool RemoveConfigFile }
UpdateCampaignDeviceStatus
class UpdateCampaignDeviceStatus { int Status }
UpdateCampaignOptions
class UpdateCampaignOptions { bool Active bool UpgradeOlder bool ReinstallCurrentVer bool DowngradeNewer }
UpdateCampaignProperties
class UpdateCampaignProperties extends UpdateCampaignOptions { int StartTime string TargetVersion }
UpdateCampaignStatus
class UpdateCampaignStatus extends UpdateCampaignProperties { List<UpdateCampaignStatusDeviceEntry> Devices }
UpdateCampaignStatusDeviceEntry
class UpdateCampaignStatusDeviceEntry extends UpdateCampaignDeviceStatus { string Username string DeviceID }
UserCustomEmailSettings
class UserCustomEmailSettings { List<EmailReportConfig> Reports }
UserOnServer
class UserOnServer { int ServerID string Username }
UserPolicy
class UserPolicy { bool PreventRequestStorageVault bool PreventAddCustomStorageVault bool PreventEditStorageVault bool HideCloudStorageBranding bool PreventDeleteStorageVault StorageVaultProviderPolicy StorageVaultProviders bool PreventNewProtectedItem bool PreventEditProtectedItem bool PreventDeleteProtectedItem ProtectedItemEngineTypePolicy ProtectedItemEngineTypes List<ExtraFileExclusion> FileAndFolderMandatoryExclusions // Omission from JSON document implies an empty array int ModeScheduleSkipAlreadyRunning // Omission from JSON document implies 0 int ModeAdminResetPassword // Omission from JSON document implies 0 int ModeAdminViewFilenames // Omission from JSON document implies 0 int ModeRequireUserResetPassword // Omission from JSON document implies 0 bool PreventDeleteSingleSnapshots bool PreventChangeAccountPassword bool PreventChangeEmailSettings bool PreventChangeAccountName bool PreventOpenAppUI bool RequirePasswordOpenAppUI bool HideAppImport bool HideAppVersion bool PreventOpenWebUI bool PreventViewDeviceNames DefaultEmailReportPolicy DefaultEmailReports RetentionPolicy DefaultStorageVaultRetention bool EnforceStorageVaultRetention bool PreventProtectedItemRetention Dictionary<string, SourceConfig> DefaultSources Dictionary<string, BackupRuleConfig> DefaultSourcesBackupRules Dictionary<string, DefaultSourceWithOSRestriction> DefaultSourcesWithOSRestriction Dictionary<string, BackupRuleConfig> DefaultBackupRules }
UserProfileConfig
class UserProfileConfig { string Username string AccountName string LocalTimezone string LanguageCode string OrganizationID // Omission from JSON document implies empty string List<string> Emails Dictionary<string, UserCustomEmailSettings> OverrideEmailSettings bool SendEmailReports Dictionary<string, DestinationConfig> Destinations Dictionary<string, SourceConfig> Sources Dictionary<string, BackupRuleConfig> BackupRules Dictionary<string, DeviceConfig> Devices bool IsSuspended bool AllProtectedItemsQuotaEnabled int AllProtectedItemsQuotaBytes int MaximumDevices string PolicyID UserPolicy Policy int PasswordFormat string PasswordHash string PasswordRecovery // Omission from JSON document implies empty string bool AllowPasswordLogin bool AllowPasswordAndTOTPLogin int TOTPKeyEncryptionFormat string TOTPKey bool RequirePasswordChange int CreateTime string CreationGUID }
UserProfileFragment
class UserProfileFragment { string Username }
VSSComponent
class VSSComponent { string Path string Name string CType bool Selectable }
VSSWriterInfo
class VSSWriterInfo { string DisplayName List<VSSComponent> Components }
VaultSnapshot
class VaultSnapshot { string Snapshot string Source int CreateTime bool HasOriginalPathInfo }
WasabiVirtualStorageRoleSettings
class WasabiVirtualStorageRoleSettings { string MasterBucket string AccessKey string SecretKey }
WebAuthnAuthenticatorSelection
class WebAuthnAuthenticatorSelection { string authenticatorAttachment // Omission from JSON document implies empty string bool requireResidentKey // Omission from JSON document implies false string userVerification // Omission from JSON document implies empty string }
WebAuthnCredential
class WebAuthnCredential { List<byte> PublicKey string AttestationType List<byte> AAGUID int SignCount bool CloneWarning }
WebAuthnCredentialAssertion
class WebAuthnCredentialAssertion { WebAuthnPublicKeyCredentialRequestOptions publicKey }
WebAuthnCredentialDescriptor
class WebAuthnCredentialDescriptor { string type List<byte> id List<string> transports // Omission from JSON document implies an empty array }
WebAuthnCredentialEntity
class WebAuthnCredentialEntity { string name string icon // Omission from JSON document implies empty string }
WebAuthnCredentialParameter
class WebAuthnCredentialParameter { string type int alg }
WebAuthnPublicKeyCredentialCreationOptions
class WebAuthnPublicKeyCredentialCreationOptions { List<byte> challenge WebAuthnRelyingPartyEntity rp WebAuthnUserEntity user List<WebAuthnCredentialParameter> pubKeyCredParams // Omission from JSON document implies an empty array WebAuthnAuthenticatorSelection authenticatorSelection // Omission from JSON document implies zero-initialised WebAuthnAuthenticatorSelection class instance int timeout // Omission from JSON document implies 0 List<WebAuthnCredentialDescriptor> excludeCredentials // Omission from JSON document implies an empty array Dictionary<string, any> extensions // Omission from JSON document implies an empty Dictionary string attestation // Omission from JSON document implies empty string }
WebAuthnPublicKeyCredentialRequestOptions
class WebAuthnPublicKeyCredentialRequestOptions { List<byte> challenge int timeout // Omission from JSON document implies 0 string rpId // Omission from JSON document implies empty string List<WebAuthnCredentialDescriptor> allowCredentials // Omission from JSON document implies an empty array string userVerification // Omission from JSON document implies empty string Dictionary<string, any> extensions // Omission from JSON document implies an empty Dictionary }
WebAuthnRegistrationChallengeResponse
class WebAuthnRegistrationChallengeResponse extends CometAPIResponseMessage { string ChallengeID WebAuthnPublicKeyCredentialCreationOptions CredentialCreationOptions }
WebAuthnRelyingPartyEntity
class WebAuthnRelyingPartyEntity extends WebAuthnCredentialEntity { string id }
WebAuthnSignRequest
class WebAuthnSignRequest { string ChallengeID WebAuthnCredentialAssertion Assertion }
WebAuthnSignResponse
class WebAuthnSignResponse { string ChallengeID string CredentialJSON }
WebAuthnUserEntity
class WebAuthnUserEntity extends WebAuthnCredentialEntity { string displayName // Omission from JSON document implies empty string List<byte> id }
WebInterfaceBrandingProperties
class WebInterfaceBrandingProperties { string BrandName string LogoImage string TopColor string Favicon bool HideNewsArea }
WebhookOption
class WebhookOption { string URL List<int> WhiteListedEventTypes Dictionary<string, string> CustomHeaders }
WinSMBAuth
class WinSMBAuth { string SharePath string Username string Password int PasswordFormat }
WindowsCodeSignProperties
class WindowsCodeSignProperties { string WindowsCodeSignPKCS12FilePath int WindowsCodeSignPKCS12PasswordFormat string WindowsCodeSignPKCS12Password string WindowsCodeSignPKCS11Engine string WindowsCodeSignPKCS11Module string WindowsCodeSignPKCS11Certfile string WindowsCodeSignPKCS11KeyID int WindowsCodeSignPKCS11PasswordFormat string WindowsCodeSignPKCS11Password }