Skip to main content

API Constants

APPLICATION

NameTypeValueComment
APPLICATION_VERSIONstring"23.12.6"
APPLICATION_VERSION_MAJORint23
APPLICATION_VERSION_MINORint12
APPLICATION_VERSION_REVISIONint6

BACKUPJOBAUTORETENTION

NameTypeValueComment
BACKUPJOBAUTORETENTION_AUTOMATICint0AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
BACKUPJOBAUTORETENTION_IMMEDIATEint1AutoRetentionLevel: The system will run a Retention Pass after every single backup job. This is more system-intensive, but is the most responsive at freeing storage space.
BACKUPJOBAUTORETENTION_MORE_OFTENint2AutoRetentionLevel: The system will follow the automatic ruleset for a 'High Power' device.
BACKUPJOBAUTORETENTION_LESS_OFTENint3AutoRetentionLevel: The system will follow the automatic ruleset for a 'Low Power' device.

BRANDINGSTYLETYPE

NameTypeValueComment
BRANDINGSTYLETYPE_AUTO_LEGACYint0If set, will be automatically replaced with one of the other BRANDINGSTYLETYPE_ constants after next server upgrade.
BRANDINGSTYLETYPE_DEFAULTint1Use Comet company branding and colours for all web interface branding
BRANDINGSTYLETYPE_CUSTOM_TEXTint2Use custom branding and colours, with text in the main logo area.
BRANDINGSTYLETYPE_CUSTOM_LOGOint3Use custom branding and colours, with a supplied image in the main logo area.

CLIENTBRANDINGBUILD

NameTypeValueComment
CLIENTBRANDINGBUILD_CUSTOMint0ClientBrandingBuildMode: The software client will be custom-built by this Comet Server, allowing custom branding, default server URL, and codesigning.
CLIENTBRANDINGBUILD_PREBUILTint1ClientBrandingBuildMode: A pre-built software client will be served, with Comet-branding, no server URL, and Comet codesigning.

COMPRESS

NameTypeValueComment
COMPRESS_INVALIDint0CompressMode
COMPRESS_LVL_1int1CompressMode
COMPRESS_LVL_2int2CompressMode
COMPRESS_LVL_3int3CompressMode
COMPRESS_LVL_4int4CompressMode
COMPRESS_LVL_5int5CompressMode
COMPRESS_MAXintCOMPRESS_LVL_5CompressMode
COMPRESS_DEFAULTintCOMPRESS_LVL_4CompressMode

DEFAULT

NameTypeValueComment
DEFAULT_LANGUAGEstring"en_US"LanguageCode
DEFAULT_TIMEZONEstring"UTC"

DESTINATION

NameTypeValueComment
DESTINATION_SFTP_AUTHMODE_NATIVEint0SftpAuthMode
DESTINATION_SFTP_AUTHMODE_PASSWORDint1SftpAuthMode
DESTINATION_SFTP_AUTHMODE_PRIVATEKEYint2SftpAuthMode

DESTINATIONTYPE

NameTypeValueComment
DESTINATIONTYPE___INVALIDint0
DESTINATIONTYPE_S3int1000S3-compatible, or a specific S3 service such as AWS S3, Wasabi, or iDrive e2
DESTINATIONTYPE_SFTPint1001SFTP protocol
DESTINATIONTYPE_LOCALCOPYint1002Local Path
DESTINATIONTYPE_COMETint1003The Comet Server Storage Role protocol
DESTINATIONTYPE_FTPint1004FTP protocol
DESTINATIONTYPE_AZUREBLOBint1005Azure Blob Storage
DESTINATIONTYPE_SPANNEDint1006Spanned
DESTINATIONTYPE_SWIFTint1007Openstack Swift
DESTINATIONTYPE_B2int1008Backblaze B2 (Native API)
DESTINATIONTYPE_STORJint1009Storj
DESTINATIONTYPE_WEBDAVint1010
DESTINATIONTYPE_LATESTint1100When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.
DESTINATIONTYPE_ALLint1101When defining a schedule via policy, use this option to create a schedule for each Storage Vault in the user's profile.

EMAIL

NameTypeValueComment
EMAIL_WORKER_STATE_NOT_STARTEDint0The Comet Server is still starting up and has not yet checked whether any email reports are due to be sent.
EMAIL_WORKER_STATE_STARTEDint1The Comet Server is still starting up and has not yet checked whether any email reports are due to be sent.
EMAIL_WORKER_STATE_CALCULATINGint2The Comet Server is currently searching through email report configuration, to determine when the next email report is due to be sent.
EMAIL_WORKER_STATE_WAITINGint3The Comet Server knows when the next scheduled email report is due to be sent, and is waiting until that time.
EMAIL_WORKER_STATE_SENDINGint4The Comet Server is currently sending a scheduled email report.
EMAIL_DELIVERY_INHERITstring""EmailDeliveryType: If this is for the top-level Organization, email is disabled. If this is for an Organization, use the parent's email settings.
EMAIL_DELIVERY_MX_DIRECTstring"builtin"EmailDeliveryType
EMAIL_DELIVERY_SMTPstring"smtp"EmailDeliveryType
EMAIL_DELIVERY_SMTP_SSLstring"smtp-ssl"EmailDeliveryType
EMAIL_DELIVERY_DISABLEDstring"disabled"EmailDeliveryType
EMAIL_DELIVERY_BUILTINstringEMAIL_DELIVERY_MX_DIRECTEmailDeliveryType: Legacy alias for EMAIL_DELIVERY_MX_DIRECT
EMAIL_DELIVERY_NONEstringEMAIL_DELIVERY_INHERITDeprecated since Comet version 22.12.1
EmailDeliveryType: Legacy alias for EMAIL_DELIVERY_INHERIT

EMAILREPORTTYPE

NameTypeValueComment
EMAILREPORTTYPE_IMMEDIATEint0EmailReportType
EMAILREPORTTYPE_SUMMARYint1EmailReportType
EMAILREPORTTYPE_GROUPED_STATUSint2EmailReportType
EMAILREPORTTYPE_RECENT_ACTIVITYint3EmailReportType

ENCRYPTIONMETHOD

NameTypeValueComment
ENCRYPTIONMETHOD_UNCONFIGUREDint0

ENGINE

NameTypeValueComment
ENGINE_BUILTIN_FILEstring"engine1/file"Files and Folders
ENGINE_BUILTIN_STDOUTstring"engine1/stdout"Program Output
ENGINE_BUILTIN_MYSQLstring"engine1/mysql"MySQL
ENGINE_BUILTIN_SYSTEMSTATEstring"engine1/systemstate"Windows Server System State
ENGINE_BUILTIN_MSSQLstring"engine1/mssql"Microsoft SQL Server
ENGINE_BUILTIN_WINDOWSSYSTEMstring"engine1/windowssystem"Windows System Backup
ENGINE_BUILTIN_EXCHANGEEDBstring"engine1/exchangeedb"Microsoft Exchange Server
ENGINE_BUILTIN_VSSWRITERstring"engine1/vsswriter"Application-Aware Writer
ENGINE_BUILTIN_HYPERVstring"engine1/hyperv"Microsoft Hyper-V
ENGINE_BUILTIN_WINDISKstring"engine1/windisk"Disk Image
ENGINE_BUILTIN_MONGODBstring"engine1/mongodb"MongoDB
ENGINE_BUILTIN_MSOFFICEstring"engine1/winmsofficemail"Office 365
ENGINE_BUILTIN_VMWAREstring"engine1/vmware"VMware

FTPS

NameTypeValueComment
FTPS_MODE_PLAINTEXTint0FtpsModeType: Use plain FTP, do not use FTPS.
FTPS_MODE_IMPLICITint1FtpsModeType: Use implicit FTPS, immediately creating a secure SSL/TLS channel before any data is sent. This usually requires a different port on the FTP server. It is generally advised to use explicit mode instead.
FTPS_MODE_EXPLICITint2FtpsModeType: Use explicit FTPS, first creating an insecure connection and then upgrading to SSL/TLS using AUTH TLS (like STARTTLS).

HYPERV

NameTypeValueComment
HYPERV_METHOD_VSSstring"vss"Back up Hyper-V virtual machines using VSS mode. This includes all previous snapshots.
HYPERV_METHOD_WMI_COPYstring"copy"This const is available in Comet 23.9.8 and later.
Back up Hyper-V virtual machines using WMI mode. This includes the latest snapshot data only.
HYPERV_METHOD_WMI_CBTstring"wmi"This const is available in Comet 23.9.8 and later.
Back up Hyper-V virtual machines using WMI mode with RCT acceleration. This includes the latest snapshot data only.

JOB

NameTypeValueComment
JOB_CLASSIFICATION__MINint4000JobClassification: All BackupJobDetail.Classification fields will fall in the 4xxx range.
JOB_CLASSIFICATION_UNKNOWNint4000JobClassification
JOB_CLASSIFICATION_BACKUPint4001JobClassification: This is a backup job.
JOB_CLASSIFICATION_RESTOREint4002JobClassification: This is a restore job.
JOB_CLASSIFICATION_RETENTIONint4003JobClassification: Automatic or manual retention cleaning pass.
JOB_CLASSIFICATION_UNLOCKint4004JobClassification: Another process needed exclusive Vault access (e.g. for retention) but the process died. This task cleans up exclusive lockfiles.
JOB_CLASSIFICATION_DELETE_CUSTOMint4005JobClassification: A specific snapshot has been deleted via the Restore wizard.
JOB_CLASSIFICATION_REMEASUREint4006JobClassification: Explicitly re-measuring the size of a Vault (right-click > Advanced menu).
JOB_CLASSIFICATION_UPDATEint4007JobClassification: Software update
JOB_CLASSIFICATION_IMPORTint4008JobClassification: Importing settings from another installed product
JOB_CLASSIFICATION_REINDEXint4009JobClassification: Repair indexes
JOB_CLASSIFICATION_DEEPVERIFYint4010JobClassification: Deep Verify
JOB_CLASSIFICATION_UNINSTALLint4011JobClassification: Software uninstall
JOB_CLASSIFICATION__MAXint4999JobClassification
JOB_STATUS_STOP_SUCCESS__MINint5000JobStatus: If the BackupJobDetail.Status field is a 5xxx code, the job has stopped for a successful reason.
JOB_STATUS_STOP_SUCCESSint5000JobStatus: The job is complete and was successful.
JOB_STATUS_STOP_SUCCESS__MAXint5999JobStatus
JOB_STATUS_RUNNING__MINint6000JobStatus: If the BackupJobDetail.Status field is a 6xxx code, the job is still running.
JOB_STATUS_RUNNING_INDETERMINATEint6000JobStatus: Unused
JOB_STATUS_RUNNING_ACTIVEint6001JobStatus: The last information the server received from the device is that the job is currently running.
JOB_STATUS_RUNNING_REVIVEDint6002JobStatus: The job was thought to have been in an Abandoned state but updated the Comet Server with a running status.
JOB_STATUS_RUNNING__MAXint6999JobStatus
JOB_STATUS_FAILED__MINint7000JobStatus: If the BackupJobDetail.Status field is a 7xxx code, the job has stopped for an unsuccessful reason.
JOB_STATUS_FAILED_TIMEOUTint7000JobStatus
JOB_STATUS_FAILED_WARNINGint7001JobStatus: The job is complete but there was a problem that may have resulted in issues with the expected result.
JOB_STATUS_FAILED_ERRORint7002JobStatus: There was an error during the job and it did not fully complete.
JOB_STATUS_FAILED_QUOTAint7003JobStatus: During a backup job either the "All protected items" quota or "Storage Vault" quota was exceeded.
JOB_STATUS_FAILED_SCHEDULEMISSEDint7004JobStatus: The job did not start at its scheduled time.
JOB_STATUS_FAILED_CANCELLEDint7005JobStatus: The job was cancelled manually, a device shutdown was detected, or the backup time limit was reached.
JOB_STATUS_FAILED_SKIPALREADYRUNNINGint7006JobStatus: The backup job was skipped as there was already a backup running and the "Skip if already running" option was enabled.
JOB_STATUS_FAILED_ABANDONEDint7007JobStatus: The job has stopped unexpectedly or has been manually marked as abandoned by an admin.
JOB_STATUS_FAILED__MAXint7999JobStatus

LDAPSECURITYMETHOD

NameTypeValueComment
LDAPSECURITYMETHOD_PLAINstring"plain"LDAPSecurityMethod
LDAPSECURITYMETHOD_LDAPSstring"ldaps"LDAPSecurityMethod
LDAPSECURITYMETHOD_STARTTLSstring"starttls"LDAPSecurityMethod

MACOSCODESIGN

NameTypeValueComment
MACOSCODESIGN_LEVEL_SIGNint0MacOSCodesignLevel: Sign only
MACOSCODESIGN_LEVEL_SIGN_NOTARISEint1MacOSCodesignLevel: Sign and notarize
MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLEint2MacOSCodesignLevel: Sign, notarize, and staple

MIXED

NameTypeValueComment
MIXED_VIRTUAL_ACCOUNT_TYPE_USERint1
MIXED_VIRTUAL_ACCOUNT_TYPE_GROUPint2
MIXED_VIRTUAL_ACCOUNT_TYPE_TEAM_GROUPint3
MIXED_VIRTUAL_ACCOUNT_TYPE_SHAREPOINT_ONLYint4

MONGODB

NameTypeValueComment
MONGODB_DEFAULT_PORTint27017

MSSQL

NameTypeValueComment
MSSQL_AUTH_WINDOWSstring"windows"MSSQLAuthMode
MSSQL_AUTH_NATIVEstring"native"MSSQLAuthMode
MSSQL_METHOD_OLEDB_NATIVEstring"OLEDB_NATIVE"MSSQLMethod: On Windows x86_64, use the native x86_64 driver.
MSSQL_METHOD_OLEDB_32string"OLEDB_32"MSSQLMethod: On Windows x86_64, use an x86_32 OLEDB driver.
MSSQL_RESTORE_RECOVERYstring"RECOVERY"MSSQLRestoreOpt
MSSQL_RESTORE_NORECOVERYstring"NO_RECOVERY"MSSQLRestoreOpt

OBJECT

NameTypeValueComment
OBJECT_LOCK_LEGACYint0
OBJECT_LOCK_ONint1
OBJECT_LOCK_OFFint2

OFFICE365

NameTypeValueComment
OFFICE365_REGION_PUBLICstring"GlobalPublicCloud"
OFFICE365_REGION_CHINAstring"ChinaCloud"
OFFICE365_REGION_GERMANYstring"GermanCloud"
OFFICE365_REGION_US_GOVTstring"USGovtGccCloud"
OFFICE365_REGION_US_DODstring"USGovtGccDoDCloud"

OS

NameTypeValueComment
OS_ANYint0ExtraFileExclusionOSRestriction: Applies to any device
OS_ONLY_WINDOWSint1ExtraFileExclusionOSRestriction: Applies to all Windows devices, regardless of CPU type
OS_ONLY_WINDOWS_X8632int2ExtraFileExclusionOSRestriction: Applies to Windows devices with x86_32 CPU
OS_ONLY_WINDOWS_X8664int3ExtraFileExclusionOSRestriction: Applies to Windows devices with x86_64 CPU
OS_ONLY_MACOSint4ExtraFileExclusionOSRestriction: Applies to macOS devices, regardless of CPU type
OS_ONLY_LINUXint5ExtraFileExclusionOSRestriction: Applies to Linux devices (including Synology DSM), regardless of CPU type

PASSWORD

NameTypeValueComment
PASSWORD_FORMAT_PLAINTEXTint0When resetting a password with the API, set the PasswordFormat to this value. The Comet Server will re-hash the credential automatically.

PROVIDER

NameTypeValueComment
PROVIDER_GENERICstring"oidc"OidcProvider
PROVIDER_AZUREADV2string"azure-ad-v2"OidcProvider
PROVIDER_GOOGLEstring"google"OidcProvider
PROVIDER_DASHBOARDstring"dashboard"OidcProvider

PSA

NameTypeValueComment
PSA_TYPE_GENERICint0PSAType
PSA_TYPE_GRADIENTint1PSAType
PSA_TYPE_SYNCROint2PSAType

RELEASE

NameTypeValueComment
RELEASE_CODENAMEstring"Voyager"

REMOTESERVER

NameTypeValueComment
REMOTESERVER_COMETstring"comet"RemoteServerType
REMOTESERVER_COMET_STORAGEstring"cometstorage"RemoteServerType: Comet Storage powered by Wasabi
REMOTESERVER_LDAPstring"ldap"RemoteServerType
REMOTESERVER_OIDCstring"oidc"RemoteServerType: OpenID Connect
REMOTESERVER_B2string"b2"RemoteServerType: Backblaze B2
REMOTESERVER_WASABIstring"wasabi"RemoteServerType
REMOTESERVER_CUSTOMstring"custom"RemoteServerType: Custom Remote Bucket HTTP protocol
REMOTESERVER_S3_GENERICstring"s3"RemoteServerType: Custom IAM-Compatible
REMOTESERVER_AWSstring"aws"RemoteServerType
REMOTESERVER_STORJstring"storj"RemoteServerType
REMOTESERVER_IDRIVEE2string"idrivee2"RemoteServerType: IDrive e2

REPLICATOR

NameTypeValueComment
REPLICATOR_STATE_NONEint0ReplicatorState
REPLICATOR_STATE_FILE_LIST_WORKER_STARTEDint1ReplicatorState
REPLICATOR_STATE_FILE_LIST_SYNC_RUNNINGint2ReplicatorState
REPLICATOR_STATE_FILE_LIST_SYNC_FINISHEDint4ReplicatorState
REPLICATOR_STATE_WORKERS_STARTEDint8ReplicatorState
REPLICATOR_DISPLAYCLASS_STORAGEint100ReplicatorDisplayClass
REPLICATOR_DISPLAYCLASS_USERint101ReplicatorDisplayClass

RESTOREARCHIVEFORMAT

NameTypeValueComment
RESTOREARCHIVEFORMAT_TARint0RestoreArchiveFormat: Tar file format
RESTOREARCHIVEFORMAT_TARGZint1RestoreArchiveFormat: Compressed Tar.gz (.tgz) file format
RESTOREARCHIVEFORMAT_ZIPint2RestoreArchiveFormat: Zip file format
RESTOREARCHIVEFORMAT_SQFSint3RestoreArchiveFormat: SquashFS container
RESTOREARCHIVEFORMAT_TARZSTDint4RestoreArchiveFormat: Compressed Tar.zstd (.tzst) file format

RESTORETYPE

NameTypeValueComment
RESTORETYPE_INVALIDint-1RestoreType
RESTORETYPE_FILEint0RestoreType: Restore as files and folders
RESTORETYPE_NULLint1RestoreType: Download and reconstruct files, but do not save them (for test purposes)
RESTORETYPE_PROCESS_PERFILEint2RestoreType: Stream each restored file into the target command stdin. The target command may be executed multiple times, once for each restored file.
RESTORETYPE_PROCESS_ARCHIVEint3RestoreType: Stream an archive of each restored file into the target command stdin. The target command will be executed only once.
RESTORETYPE_WINDISKint4RestoreType: Restore partitions back to the physical disk
RESTORETYPE_FILE_ARCHIVEint5RestoreType: Restore selected files and folders as a single compressed archive
RESTORETYPE_OFFICE365_CLOUDint6RestoreType: Restore selected Office 365 emails, contacts, calendars, and SharePoint/OneDrive data directly to the Office 365 cloud service
RESTORETYPE_VMDK_FILEint7RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup
RESTORETYPE_VMDK_FILE_NULLint8RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, downloading and reconstructing files, but without saving them (for test purposes)
RESTORETYPE_VMDK_FILE_ARCHIVEint9RestoreType: Granular restore of single files from within a Disk Image or Hyper-V backup, creating an archive file of all selected files
RESTORETYPE_MYSQLint10RestoreType: Stream restore as SQL statements into a target MySQL server
RESTORETYPE_MSSQLint11RestoreType: Stream restore as T-SQL BACKUP output into a target Microsoft SQL Server
RESTORETYPE_WINDISK_ESXIint12RestoreType: Restore disk image backup as VMware-compatible virtual disks
RESTORETYPE_PROCESS_TARBALLint3RestoreType: Legacy name alias - Prefer to use RESTORETYPEPROCESS_ARCHIVE since multiple archive file formats are supported within this single RESTORETYPE

RETENTIONMODE

NameTypeValueComment
RETENTIONMODE_KEEP_EVERYTHINGint801RetentionMode: If this mode is set in a RetentionPolicy, then RetentionPolicy.Ranges should be ignored.
RETENTIONMODE_DELETE_EXCEPTint802RetentionMode: Delete everything except for jobs matching the ranges in RetentionPolicy.Ranges.

RETENTIONRANGE

NameTypeValueComment
RETENTIONRANGE__LOWESTint900RetentionRangeType
RETENTIONRANGE_MOST_RECENT_X_JOBSint900RetentionRangeType: Uses Jobs
RETENTIONRANGE_NEWER_THAN_Xint901RetentionRangeType: Uses Timestamp
RETENTIONRANGE_JOBS_SINCEint902RetentionRangeType: Uses Days, Weeks, Months
RETENTIONRANGE_FIRST_JOB_FOR_EACH_LAST_X_DAYSint903RetentionRangeType: Uses Days
RETENTIONRANGE__RESERVED904int904Deprecated since Comet version 17.2.0
RetentionRangeType
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_MONTHSint905RetentionRangeType: Uses Months, MonthOffset
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKSint906RetentionRangeType: Uses Weeks, WeekOffset
RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAYint907RetentionRangeType: Uses Jobs
RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEKint908RetentionRangeType: Uses Jobs
RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTHint909RetentionRangeType: Uses Jobs
RETENTIONRANGE__HIGHESTint909RetentionRangeType
RETENTIONRANGE_MAXINTint1125899906842624

SCHEDULE

NameTypeValueComment
SCHEDULE_FREQUENCY_LOWESTint8010
SCHEDULE_FREQUENCY_ONCEONLYint8010SecondsPast should be a Unix timestamp, in seconds
SCHEDULE_FREQUENCY_DAILYint8011SecondsPast is the number of seconds past 00:00, in the device's local timezone.
SCHEDULE_FREQUENCY_HOURLYint8012SecondsPast is the number of seconds past *:00, in the device's local timezone.
SCHEDULE_FREQUENCY_WEEKLYint8013SecondsPast is the number of seconds past 00:00 Sunday, in the device's local timezone.
SCHEDULE_FREQUENCY_MONTHLYint8014SecondsPast is the number of seconds past 00:00 1st, in the device's local timezone.
SCHEDULE_FREQUENCY_PERIODICint8015SecondsPast is the number of seconds per period. Offset: Shunt seconds after unix epoch
SCHEDULE_FREQUENCY_HIGHESTint8015
SCHEDULE_MAX_RANDOM_DELAY_SECSint18000Maximum random delay (5 hours)
SCHEDULE_MAXINTint1125899906842624

SEARCHCLAUSE

NameTypeValueComment
SEARCHCLAUSE_RULEstring""SearchClauseType: The search clause is an explicit rule
SEARCHCLAUSE_ANDstring"and"SearchClauseType: All of the ClauseChildren must match
SEARCHCLAUSE_ORstring"or"SearchClauseType: At least one of the ClauseChildren must match
SEARCHCLAUSE_NOT_ANDstring"not_and"SearchClauseType
SEARCHCLAUSE_NOT_ORstring"not_or"SearchClauseType

SEARCHOPERATOR

NameTypeValueComment
SEARCHOPERATOR_STRING_EQstring"str_eq"String equals (case sensitive)
SEARCHOPERATOR_STRING_NEQstring"str_neq"String does not equal (case sensitive)
SEARCHOPERATOR_STRING_CONTAINSstring"str_contains"String contains anywhere (case sensitive)
SEARCHOPERATOR_STRING_NCONTAINSstring"str_ncontains"String does not contain anywhere (case sensitive)
SEARCHOPERATOR_STRING_STARTSWITHstring"str_startswith"String starts with prefix (case sensitive)
SEARCHOPERATOR_STRING_NSTARTSWITHstring"str_nstartswith"String does not start with prefix (case sensitive)
SEARCHOPERATOR_STRING_ENDSWITHstring"str_endswith"String ends with suffix (case sensitive)
SEARCHOPERATOR_STRING_NENDSWITHstring"str_nendswith"String does not end with suffix (case sensitive)
SEARCHOPERATOR_STRING_EQ_CIstring"str_eq_ci"String equals (case insensitive)
SEARCHOPERATOR_STRING_NEQ_CIstring"str_neq_ci"String does not equal (case insensitive)
SEARCHOPERATOR_STRING_CONTAINS_CIstring"str_contains_ci"String contains anywhere (case sensitive)
SEARCHOPERATOR_STRING_NCONTAINS_CIstring"str_ncontains_ci"String does not contain anywhere (case sensitive)
SEARCHOPERATOR_STRING_STARTSWITH_CIstring"str_startswith_ci"String starts with prefix (case sensitive)
SEARCHOPERATOR_STRING_NSTARTSWITH_CIstring"str_nstartswith_ci"String does not start with (case sensitive)
SEARCHOPERATOR_STRING_ENDSWITH_CIstring"str_endswith_ci"String ends with suffix (case sensitive)
SEARCHOPERATOR_STRING_NENDSWITH_CIstring"str_nendswith_ci"String does not end with suffix (case sensitive)
SEARCHOPERATOR_STRING_REGEXMATCHstring"str_regexmatch"String matches provided regular expression (using Go regex syntax)
SEARCHOPERATOR_STRING_NREGEXMATCHstring"str_nregexmatch"String does not match provided regular expression (using Go regex syntax)
SEARCHOPERATOR_INT_EQstring"int_eq"Integer field is equal to value
SEARCHOPERATOR_INT_NEQstring"int_neq"Integer field is not equal to value
SEARCHOPERATOR_INT_GTstring"int_gt"Integer field is greater than value
SEARCHOPERATOR_INT_GTEstring"int_gte"Integer field is greater than or equal to value
SEARCHOPERATOR_INT_LTstring"int_lt"Integer field is less than value
SEARCHOPERATOR_INT_LTEstring"int_lte"Integer field is less than or equal to value
SEARCHOPERATOR_BOOL_ISstring"bool_is"Boolean field matches value
SEARCHOPERATOR_BOOL_NISstring"bool_nis"Boolean field does not match value

SERVICE

NameTypeValueComment
SERVICE_CALENDARint10000 0001. If this value is present in the bitset, then the Calendar service is selected for backup.
SERVICE_CONTACTint20000 0010. If this value is present in the bitset, then the Contact service is selected for backup.
SERVICE_MAILint40000 0100. If this value is present in the bitset, then the Mail service is selected for backup.
SERVICE_SHAREPOINTint80000 1000. If this value is present in the bitset, then the SharePoint service is selected for backup.
SERVICE_ONEDRIVEint160001 0000. If this value is present in the bitset, then the OneDrive service is selected for backup.

SETTING

NameTypeValueComment
SETTING_SYSTEM_DEFAULTint0DefaultSettingMode
SETTING_OPTIONAL_DEFAULT_ONint1DefaultSettingMode
SETTING_OPTIONAL_DEFAULT_OFFint2DefaultSettingMode
SETTING_ENFORCED_ONint3DefaultSettingMode
SETTING_ENFORCED_OFFint4DefaultSettingMode

SEVERITY

NameTypeValueComment
SEVERITY_INFOstring"I"Severity
SEVERITY_WARNINGstring"W"Severity
SEVERITY_ERRORstring"E"Severity

SEVT

NameTypeValueComment
SEVT__MINint4000StreamableEventType
SEVT_META_HELLOint4000StreamableEventType: New event stream connection. Data is typically ServerMetaVersionInfo
SEVT_ACCOUNT_NEWint4100StreamableEventType: User created. Data is the profile object
SEVT_ACCOUNT_REMOVEDint4101StreamableEventType: User deleted
SEVT_ACCOUNT_UPDATEDint4102StreamableEventType: User updated. Data is the profile object
SEVT_ACCOUNT_LOGINint4103StreamableEventType: User authentication succeeded. Only emitted for non-session requests. Resource is the requested path
SEVT_ACCOUNT_LOGIN_FAILEDint4104StreamableEventType: User authentication failed. Only emitted if the user exists. Resource is the requested path
SEVT_ACCOUNT_SESSION_STARTint4105StreamableEventType: User session token created. Data is the session object
SEVT_ACCOUNT_SESSION_REVOKEint4106StreamableEventType: User session token deleted
SEVT_ACCOUNT_SESSION_EXPIREint4107StreamableEventType: User session token expired
SEVT_ACCOUNT_ADMIN_NEWint4150StreamableEventType: Admin created. Data is the profile object
SEVT_ACCOUNT_ADMIN_REMOVEDint4151StreamableEventType: Admin deleted
SEVT_ACCOUNT_ADMIN_UPDATEDint4152StreamableEventType: Admin updated
SEVT_ACCOUNT_ADMIN_LOGINint4153StreamableEventType: Admin authentication succeeded. Only emitted for non-session requests. Resource is the requested path
SEVT_ACCOUNT_ADMIN_LOGIN_FAILEDint4154StreamableEventType: Admin authentication failed. Only emitted if the admin exists. Resource is the request path
SEVT_ACCOUNT_ADMIN_SESSION_STARTint4155StreamableEventType: Admin session token created. Data is the session object
SEVT_ACCOUNT_ADMIN_SESSION_REVOKEint4156StreamableEventType: Admin session token deleted
SEVT_ACCOUNT_ADMIN_SESSION_EXPIREint4157StreamableEventType: Admin session token expired
SEVT_JOB_NEWint4200StreamableEventType: New backup job started. Data is the job object
SEVT_JOB_COMPLETEDint4201StreamableEventType: Backup job completed. Data is the job object
SEVT_BUCKET_NEWint4300StreamableEventType: New bucket created
SEVT_BUCKET_REMOVEDint4301StreamableEventType: Bucket deleted
SEVT_SERVER_STARTEDint4400StreamableEventType: Server started
SEVT_SERVER_RESTARTEDint4401StreamableEventType: Server restarting (pending)
SEVT_SERVER_SHUTDOWNint4402StreamableEventType: Server shutting down (pending)
SEVT_SERVER_UPDATEDint4403StreamableEventType: Server configuration has been updated. Data is the server config object
SEVT_TENANT_NEWint4500StreamableEventType: Tenant created. Data is the tenant object
SEVT_TENANT_REMOVEDint4501StreamableEventType: Tenant deleted
SEVT_TENANT_UPDATEDint4502StreamableEventType: Tenant updated. Data is the tenant object
SEVT_POLICY_NEWint4600StreamableEventType: Policy created. Data is the policy object
SEVT_POLICY_REMOVEDint4601StreamableEventType: Policy deleted
SEVT_POLICY_UPDATEDint4602StreamableEventType: Policy updated. Data is the policy object
SEVT_DEVICE_NEWint4700StreamableEventType: Device created. Data is device object
SEVT_DEVICE_REMOVEDint4701StreamableEventType: Device deleted
SEVT_DEVICE_LIVE_CONNECTint4702StreamableEventType: Device live connection started
SEVT_DEVICE_LIVE_DISCONNECTint4703StreamableEventType: Device live connection ended
SEVT_DEVICE_LOBBY_CONNECTint4704StreamableEventType: Device connected to registration lobby
SEVT_DEVICE_LOBBY_DISCONNECTint4705StreamableEventType: Device disconnected from registration lobby
SEVT__MAXint4999StreamableEventType

SSHCONNECTION

NameTypeValueComment
SSHCONNECTION_AUTHMODE__INVALIDint0SSHAuthMode
SSHCONNECTION_AUTHMODE_PASSWORDint1SSHAuthMode
SSHCONNECTION_AUTHMODE_PRIVATEKEYint2SSHAuthMode

STOREDOBJECTTYPE

NameTypeValueComment
STOREDOBJECTTYPE_FILEstring"file"StoredObjectType
STOREDOBJECTTYPE_DIRECTORYstring"dir"StoredObjectType
STOREDOBJECTTYPE_SYMLINKstring"symlink"StoredObjectType
STOREDOBJECTTYPE_UNIXBLOCKDEVICEstring"dev"StoredObjectType
STOREDOBJECTTYPE_UNIXCHARDEVICEstring"chardev"StoredObjectType
STOREDOBJECTTYPE_UNIXFIFOstring"fifo"StoredObjectType
STOREDOBJECTTYPE_UNIXSOCKETstring"socket"StoredObjectType
STOREDOBJECTTYPE_WINEFSstring"winefs"StoredObjectType
STOREDOBJECTTYPE_EMAILMESSAGEstring"emailmessage"StoredObjectType
STOREDOBJECTTYPE_EMAILFOLDERstring"mailfolder"StoredObjectType
STOREDOBJECTTYPE_OFFICECONTACTstring"contact"StoredObjectType
STOREDOBJECTTYPE_OFFICECONTACTFOLDERstring"contactfolder"StoredObjectType
STOREDOBJECTTYPE_OFFICECALENDAREVENTstring"calendarevent"StoredObjectType
STOREDOBJECTTYPE_OFFICECALENDARstring"calendar"StoredObjectType
STOREDOBJECTTYPE_MSSITEstring"mssite"StoredObjectType
STOREDOBJECTTYPE_MSSITE_TEAMstring"mssiteteam"StoredObjectType
STOREDOBJECTTYPE_MSSITELISTENTITYstring"mssitelistentity"StoredObjectType
STOREDOBJECTTYPE_MSSITEITEMENTITYstring"mssiteitementity"StoredObjectType
STOREDOBJECTTYPE_MSSITELISTDRIVEENTITYstring"mssitelistdriveentity"StoredObjectType
STOREDOBJECTTYPE_VMDK_FILEstring"vmdkfile"StoredObjectType
STOREDOBJECTTYPE_VMDK_DIRECTORYstring"vmdkdir"StoredObjectType
STOREDOBJECTTYPE_VMDK_WINEFSstring"vmdkwinefs"StoredObjectType
STOREDOBJECTTYPE_VMDK_SYMLINKstring"vmdksymlink"StoredObjectType
STOREDOBJECTTYPE_VIRTUALIMAGE_DISKstring"virtualimagedisk"StoredObjectType
STOREDOBJECTTYPE_VHDX_GPT_PARTITIONstring"vhdxpartitiongpt"StoredObjectType
STOREDOBJECTTYPE_VHDX_MBR_PARTITIONstring"vhdxpartitionmbr"StoredObjectType

STREAM

NameTypeValueComment
STREAM_LEVEL_FULLstring"full"StreamLevel: Event data contains full data types
STREAM_LEVEL_NONEstring"none"StreamLevel: Event data contains nothing

STREAMER

NameTypeValueComment
STREAMER_TYPE_INTERNALstring"internal"StreamerType
STREAMER_TYPE_WEBHOOKstring"webhook"StreamerType
STREAMER_TYPE_WEBSOCKETstring"websocket"StreamerType
STREAMER_TYPE_FILEstring"file"StreamerType

TOTPRequiredError

NameTypeValueComment
TOTPRequiredErrorstring"ERR_TOTP_REQUIRED"If an API response returns in failure, but it includes this value in the CometAPIResponseMessage->Message parameter, it indicates that your supplied authentication was insufficient, and you must supply additional two-factor authentication credentials.

UPDATESTATUS

NameTypeValueComment
UPDATESTATUS_NOT_SEENint0UpdateStatus
UPDATESTATUS_INELIGIBLEint1UpdateStatus: The selected device does not meet the filter criteria from the Bulk Update Campaign's configuration.
UPDATESTATUS_PENDINGint2UpdateStatus
UPDATESTATUS_REQUEST_MADEint3UpdateStatus: The device has made a live connection and it meets the filter criteria. A live connection message has been sent asking it to perform the software upgrade.
UPDATESTATUS_UPDATE_FAILEDint4UpdateStatus: An update signal was sent to the device, but when it reconnected, it did not advertise the target software version. It's likely that the update failed - please check the device's Update log for more information.
UPDATESTATUS_UPDATE_CONFIRMEDint5UpdateStatus: The device has successfully updated to the target version.

USERNAME

NameTypeValueComment
USERNAME_MAX_LENGTHint255

UnknownDeviceError

NameTypeValueComment
UnknownDeviceErrorstring"ERR_UNKNOWN_DEVICE"If an API response returns in failure, but it includes this value in the CometAPIResponseMessage->Message parameter, it indicates that the specified Device ID was invalid or not found.

UnsupportVhdxFileSystem

NameTypeValueComment
UnsupportVhdxFileSystemstring"ERR_UNSUPPORT_VHDX_FILE_SYSTEM"

UnsupportVmdkFileSystem

NameTypeValueComment
UnsupportVmdkFileSystemstring"ERR_UNSUPPORT_VMDK_FILE_SYSTEM"

VMWARE

NameTypeValueComment
VMWARE_CONNECTION_SSHstring"ssh"Deprecated since Comet version 23.9.11
VMwareConnectionType
VMWARE_CONNECTION_VSPHEREstring"vsphere"VMwareConnectionType
VMWARE_SNAPSHOT_FASTstring""VmwareSnapshotType
VMWARE_SNAPSHOT_QUIESCEstring"quiesce"VmwareSnapshotType
VMWARE_SNAPSHOT_MEMORYstring"memory"VmwareSnapshotType
VMWARE_BACKUP_FULLstring"full"VmwareBackupType
VMWARE_BACKUP_CBTstring"cbt"VmwareBackupType
VMWARE_BACKUP_COPYstring"copy"Deprecated since Comet version 23.9.11
VmwareBackupType

VhdxPartitonReadErrMsg

NameTypeValueComment
VhdxPartitonReadErrMsgstring"ERR_VHDX_PARTITION"

WEBAUTHN

NameTypeValueComment
WEBAUTHN_DEVICE_TYPE__UNKNOWNint0WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__HARDWARE_TOKENint1WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__ANDROIDint2WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__APPLEint3WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__TPM_GENERICint4WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__TPM_WINDOWSint5WebAuthnDeviceType
WEBAUTHN_DEVICE_TYPE__TPM_LINUXint6WebAuthnDeviceType

WINDOWSCODESIGN

NameTypeValueComment
WINDOWSCODESIGN_METHOD_AUTOint0Deprecated since Comet version 23.3.0
WindowsCodesignMethod: When upgrading from a version of Comet Server prior to 23.3.0, this option will be automatically converted to a more specific type.
WINDOWSCODESIGN_METHOD_DISABLEDint1WindowsCodesignMethod: Do not perform Authenticode codesigning
WINDOWSCODESIGN_METHOD_PKCS12FILEint2WindowsCodesignMethod: Use a configured PKCS#12 key file for Authenticode codesigning
WINDOWSCODESIGN_METHOD_PKCS11HSMint3WindowsCodesignMethod: Use a configured PKCS#11 hardware security module (HSM) for Authenticode codesigning
WINDOWSCODESIGN_METHOD_AZUREKEYVAULTint4WindowsCodesignMethod: Use a configured Azure Key Vault for Authenticode codesigning