API Reference 

API Methods 

AdminAccountProperties: Retrieve properties about the current admin account 

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminAccountRegenerateTotp: Generate a new TOTP secret 

The secret is returned as a data-uri image of a QR code. The new secret is immediately applied to the current admin account.

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminAccountSessionRevoke: Revoke a session key (log out) 

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminAccountSessionStart: Generate a session key (log in) 

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminAddUser: Add a new user account 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string New account username
TargetPassword string New account password

AdminAddUserFromProfile: Add a new user account (with all information) 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string New account username
ProfileData UserProfileConfig (JSON) New account profile

AdminBrandingGenerateClientLinuxgeneric: Download software (Linux Server tar.gz) 

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/branding/generate-client/linuxgeneric
  • Return type: Body in application/x-octet-stream encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
SelfAddress string The external URL of this server, used to resolve conflicts (Optional)

AdminBrandingGenerateClientWindows: Download software (Windows AnyCPU) 

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/branding/generate-client/windows
  • Return type: Body in application/x-octet-stream encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
SelfAddress string The external URL of this server, used to resolve conflicts (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/branding/generate-client

AdminBrandingGenerateClientWindowsX8632: Download software (Windows x86_32) 

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/branding/generate-client/windows-x86_32
  • Return type: Body in application/x-octet-stream encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
SelfAddress string The external URL of this server, used to resolve conflicts (Optional)

AdminBrandingGenerateClientWindowsX8664: Download software (Windows x86_64) 

This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/branding/generate-client/windows-x86_64
  • Return type: Body in application/x-octet-stream encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
SelfAddress string The external URL of this server, used to resolve conflicts (Optional)

AdminBulletinSubmit: Send an email bulletin to all users 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
Subject string Bulletin subject line
Content string Bulletin message content

AdminConstellationLastReport: Get Constellation bucket usage report (cached) 

You must supply administrator authentication credentials to use this API. This API requires the Constellation Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/overseer/last-report

AdminConstellationNewReport: Get Constellation bucket usage report (regenerate) 

You must supply administrator authentication credentials to use this API. This API requires the Constellation Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/overseer/new-report

AdminConstellationPruneNow: Prune unused buckets 

You must supply administrator authentication credentials to use this API. This API requires the Constellation Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/overseer/prune-now

AdminConstellationStatus: Get Constellation status 

You must supply administrator authentication credentials to use this API. This API requires the Constellation Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/overseer/status

AdminDeleteUser: Delete user account 

This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role. Any stored data can not be decrypted without the user profile. Misuse can cause data loss!

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username

AdminDispatcherApplyRetentionRules: Instruct a live connected device to apply retention rules now 

This command is understood by Comet Backup 17.6.9 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID
Destination string The Storage Vault GUID

AdminDispatcherDropConnection: Disconnect a live connected device 

The device will almost certainly attempt to reconnect.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID

AdminDispatcherKillProcess: Instruct a live connected device to disconnect 

The device will terminate its live-connection process and will not reconnect.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID

AdminDispatcherListActive: List live connected devices 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminDispatcherRefetchProfile: Instruct a live connected device to refresh their profile 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID

AdminDispatcherRunBackup: Instruct a live connected device to run a scheduled backup 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID

AdminDispatcherRunBackupCustom: Instruct a live connected device to run a backup 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID
Source string The Protected Item GUID
Destination string The Storage Vault GUID

AdminDispatcherRunRestore: Instruct a live connected device to perform a local restore 

This command is understood by Comet Backup 17.9.3 and newer.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID
Path string The local path to restore to
Source string The Protected Item ID
Destination string The Storage Vault ID
Snapshot string If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair (Optional)

AdminDispatcherUnlock: Instruct a live connected device to remove lock files from a Storage Vault 

Misuse can cause data loss!

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID
Destination string The Storage Vault GUID

AdminDispatcherUpdateSoftware: Instruct a live connected device to download a software update 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled. This API requires the Software Build Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetID string The live connection GUID

AdminGetJobLog: Get the report log entries for a single job 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/get-job-log
  • Return type: Body in text/plain encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
JobID string Selected job ID

AdminGetJobProperties: Get properties of a single job 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
JobID string Selected job ID

AdminGetJobsAll: Get jobs (All) 

The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminGetJobsForDateRange: Get jobs (for date range) 

The jobs are returned in an unspecified order.

If the Start parameter is later than End, they will be swapped.

This API will return all jobs that either started or ended within the supplied range.

Incomplete jobs have an end time of 0. You can use this API to find incomplete jobs by setting both Start and End to 0.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
Start int Timestamp
End int Timestamp

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/get-jobs-for-daterange

AdminGetJobsForUser: Get jobs (for user) 

The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected username

AdminGetJobsRecent: Get jobs (Recent and incomplete) 

The jobs are returned in an unspecified order.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminGetUserProfile: Get user account profile 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username

AdminGetUserProfileAndHash: Get user account profile (atomic) 

The resulting hash parameter can be passed to the corresponding update API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username

AdminGetUserProfileHash: Get user account profile (hash) 

The profile hash can be used to determine if a user account profile has changed. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username

AdminListUsers: List all user accounts 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/list-users
  • Return type: List<string> (JSON), or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminListUsersFull: List all user account profiles 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminMetaListAvailableLogDays: Get log files 

You must supply administrator authentication credentials to use this API.

  • Endpoint: POST /api/v1/admin/meta/list-available-log-days
  • Return type: List<int> (JSON), or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminMetaReadLogs: Get log file content 

You must supply administrator authentication credentials to use this API.

  • Endpoint: POST /api/v1/admin/meta/read-logs
  • Return type: Body in text/plain encoding, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
Log int A log day, selected from the options returned by the Get Log Files API

AdminMetaRestartService: Restart server 

The Comet Server process will exit. The service manager should restart the server automatically.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

  • Endpoint: POST /api/v1/admin/meta/restart-service
  • Return type: No return value, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminMetaServerConfigGet: Get server configuration 

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

  • Endpoint: POST /api/v1/admin/meta/server-config/get
  • Return type: No return value, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminMetaServerConfigSet: Set server configuration 

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

  • Endpoint: POST /api/v1/admin/meta/server-config/set
  • Return type: No return value, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
Config ServerConfigOptions (JSON) Updated configuration content

AdminMetaShutdownService: Shut down server 

The Comet Server process will immediately exit.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.

  • Endpoint: POST /api/v1/admin/meta/shutdown-service
  • Return type: No return value, or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminMetaVersion: Get server properties 

Retrieve the version number and basic properties about the server.

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminNewsGetAll: Get News entries (Admin) 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminNewsRemove: Remove news entry 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
NewsItem string Selected news item GUID

AdminNewsSubmit: Submit news entry 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
NewsContent string Content of news item

AdminReplicationState: Get Replication status 

You must supply administrator authentication credentials to use this API.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

  • POST /api/v1/admin/storage/replication/state

AdminRequestBucket: Request a new Storage Vault on behalf of a user 

This action does not respect the "Prevent creating new Storage Vaults (via Request)" policy setting. New Storage Vaults can be requested regardless of the policy setting.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string The user to recieve the new Storage Vault
StorageProvider string ID for the Requestable destination
SelfAddress string The external URL for this server. Used to resolve conflicts (Optional)

AdminRequestBucketOptions: Get the available options for Requesting a Storage Vault 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

  • Endpoint: POST /api/v1/admin/request-bucket-options
  • Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure
Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminRevokeDevice: Revoke device from user account 

It's possible to simply remove the Device section from the user's profile, however, using this dedicated API will also gracefully handle live connections.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username
TargetDevice string Selected Device ID

AdminSetUserProfile: Modify user account profile 

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username
ProfileData UserProfileConfig (JSON) Modified user profile

AdminSetUserProfileHash: Modify user account profile (atomic) 

The hash parameter can be determined from the corresponding API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
TargetUser string Selected account username
ProfileData UserProfileConfig (JSON) Modified user profile
RequireHash string Previous hash parameter

AdminStorageDeleteBucket: Delete a bucket 

All data will be removed from the server. Misuse can cause data loss!

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
BucketID string Selected bucket name

AdminStorageListBuckets: List all buckets 

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

AdminStorageRegisterBucket: Create a new bucket 

Leave the Set* parameters blank to generate a bucket with random credentials, or, supply a pre-hashed password for zero-knowledge operations. Any auto-generated credentials are returned in the response message.

You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
SetBucketValue string Bucket name (Optional)
SetKeyHashFormat string Bucket key hashing format (Optional)
SetKeyHashValue string Bucket key hash (Optional)

AdminUpdateCampaignStart: Start a new software update campaign 

You must supply administrator authentication credentials to use this API. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)
Options UpdateCampaignOptions (JSON) Configure targets for the software update campaign

AdminUpdateCampaignStatus: Get current campaign status 

You must supply administrator authentication credentials to use this API. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

Parameter Type Description
Username string Admin account name
AuthType string Either 'Password', 'PasswordTOTP', 'TOTP', or 'SessionKey'
Password string Admin account password (Optional)
SessionKey string Admin session key (Optional)
TOTP string Admin current TOTP code (Optional)

Constant values 

APPLICATION 

Name Type Value Comment
APPLICATION_VERSION string "17.9.6"
APPLICATION_VERSION_MAJOR int 17
APPLICATION_VERSION_MINOR int 9
APPLICATION_VERSION_REVISION int 6

DESTINATION 

Name Type Value Comment
DESTINATION_SFTP_AUTHMODE_NATIVE int 0 SftpAuthMode
DESTINATION_SFTP_AUTHMODE_PASSWORD int 1 SftpAuthMode
DESTINATION_SFTP_AUTHMODE_PRIVATEKEY int 2 SftpAuthMode

DESTINATIONTYPE 

Name Type Value Comment
DESTINATIONTYPE___INVALID int 0
DESTINATIONTYPE_S3 int 1000
DESTINATIONTYPE_SFTP int 1001
DESTINATIONTYPE_LOCALCOPY int 1002
DESTINATIONTYPE_COMET int 1003
DESTINATIONTYPE_FTP int 1004
DESTINATIONTYPE_AZUREBLOB int 1005
DESTINATIONTYPE_SPANNED int 1006
DESTINATIONTYPE_SWIFT int 1007
DESTINATIONTYPE_B2 int 1008

ENCRYPTIONMETHOD 

Name Type Value Comment
ENCRYPTIONMETHOD_UNCONFIGURED int 0

ENGINE 

Name Type Value Comment
ENGINE_BUILTIN_FILE string "engine1/file"
ENGINE_BUILTIN_STDOUT string "engine1/stdout"
ENGINE_BUILTIN_MYSQL string "engine1/mysql"
ENGINE_BUILTIN_SYSTEMSTATE string "engine1/systemstate"
ENGINE_BUILTIN_MSSQL string "engine1/mssql"
ENGINE_BUILTIN_WINDOWSSYSTEM string "engine1/windowssystem"
ENGINE_BUILTIN_EXCHANGEEDB string "engine1/exchangeedb"
ENGINE_BUILTIN_VSSWRITER string "engine1/vsswriter"

JOB 

Name Type Value Comment
JOB_CLASSIFICATION__MIN int 4000 JobClassification
JOB_CLASSIFICATION_UNKNOWN int 4000 JobClassification
JOB_CLASSIFICATION_BACKUP int 4001 JobClassification
JOB_CLASSIFICATION_RESTORE int 4002 JobClassification
JOB_CLASSIFICATION_RETENTION int 4003 JobClassification: Automatic or manual retention cleaning pass.
JOB_CLASSIFICATION_UNLOCK int 4004 JobClassification: Another process needed exclusive Vault access (e.g. for retention) but the process died. This task cleans up exclusive lockfiles.
JOB_CLASSIFICATION_DELETE_CUSTOM int 4005 JobClassification: A specific snapshot has been deleted via the Restore wizard.
JOB_CLASSIFICATION_REMEASURE int 4006 JobClassification: Explicitly re-measuring the size of a Vault (right-click > Advanced menu).
JOB_CLASSIFICATION_UPDATE int 4007 JobClassification: Software update
JOB_CLASSIFICATION_IMPORT int 4008 JobClassification
JOB_CLASSIFICATION__MAX int 4999 JobClassification
JOB_STATUS_STOP_SUCCESS__MIN int 5000 JobStatus
JOB_STATUS_STOP_SUCCESS int 5000 JobStatus
JOB_STATUS_STOP_SUCCESS__MAX int 5999 JobStatus
JOB_STATUS_RUNNING__MIN int 6000 JobStatus
JOB_STATUS_RUNNING_INDETERMINATE int 6000 JobStatus
JOB_STATUS_RUNNING_ACTIVE int 6001 JobStatus
JOB_STATUS_RUNNING__MAX int 6999 JobStatus
JOB_STATUS_FAILED__MIN int 7000 JobStatus
JOB_STATUS_FAILED_TIMEOUT int 7000 JobStatus
JOB_STATUS_FAILED_WARNING int 7001 JobStatus
JOB_STATUS_FAILED_ERROR int 7002 JobStatus
JOB_STATUS_FAILED_QUOTA int 7003 JobStatus
JOB_STATUS_FAILED_SCHEDULEMISSED int 7004 JobStatus
JOB_STATUS_FAILED_CANCELLED int 7005 JobStatus
JOB_STATUS_FAILED_SKIPALREADYRUNNING int 7006 JobStatus
JOB_STATUS_FAILED__MAX int 7999 JobStatus

PASSWORD 

Name Type Value Comment
PASSWORD_FORMAT_PLAINTEXT int 0

RELEASE 

Name Type Value Comment
RELEASE_CODENAME string "Voyager"

REPLICATOR 

Name Type Value Comment
REPLICATOR_STATE_NONE int 0 ReplicatorState
REPLICATOR_STATE_FILE_LIST_WORKER_STARTED int 1 ReplicatorState
REPLICATOR_STATE_FILE_LIST_SYNC_RUNNING int 2 ReplicatorState
REPLICATOR_STATE_FILE_LIST_SYNC_FINISHED int 4 ReplicatorState
REPLICATOR_STATE_WORKERS_STARTED int 8 ReplicatorState
REPLICATOR_DISPLAYCLASS_STORAGE int 100 ReplicatorDisplayClass
REPLICATOR_DISPLAYCLASS_USER int 101 ReplicatorDisplayClass

RETENTIONMODE 

Name Type Value Comment
RETENTIONMODE_KEEP_EVERYTHING int 801 RetentionMode: If this mode is set in a RetentionPolicy, then RetentionPolicy.Ranges should be ignored.
RETENTIONMODE_DELETE_EXCEPT int 802 RetentionMode: Delete everything except for jobs matching the ranges in RetentionPolicy.Ranges.

RETENTIONRANGE 

Name Type Value Comment
RETENTIONRANGE__LOWEST int 900 RetentionRangeType
RETENTIONRANGE_MOST_RECENT_X_JOBS int 900 RetentionRangeType: Uses Jobs
RETENTIONRANGE_NEWER_THAN_X int 901 RetentionRangeType: Uses Timestamp
RETENTIONRANGE_JOBS_SINCE int 902 RetentionRangeType: Uses Days, Weeks, Months
RETENTIONRANGE_FIRST_JOB_FOR_EACH_LAST_X_DAYS int 903 RetentionRangeType: Uses Days
RETENTIONRANGE__RESERVED904 int 904 RetentionRangeType: Removed
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_MONTHS int 905 RetentionRangeType: Uses Months, MonthOffset
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKS int 906 RetentionRangeType: Uses Weeks, WeekOffset
RETENTIONRANGE__HIGHEST int 906 RetentionRangeType

SCHEDULE 

Name Type Value Comment
SCHEDULE_FREQUENCY_ONCEONLY int 8010 epoch time
SCHEDULE_FREQUENCY_DAILY int 8011 seconds past 00:00 local time
SCHEDULE_FREQUENCY_HOURLY int 8012 seconds past *:00 local time
SCHEDULE_FREQUENCY_WEEKLY int 8013 seconds past 00:00 Sunday, local time
SCHEDULE_FREQUENCY_MONTHLY int 8014 seconds past 00:00 1st, local time

SEVERITY 

Name Type Value Comment
SEVERITY_INFO char 'I' Severity
SEVERITY_WARNING char 'W' Severity
SEVERITY_ERROR char 'E' Severity

UPDATESTATUS 

Name Type Value Comment
UPDATESTATUS_NOT_SEEN int 0 UpdateStatus
UPDATESTATUS_INELIGIBLE int 1 UpdateStatus
UPDATESTATUS_PENDING int 2 UpdateStatus
UPDATESTATUS_REQUEST_MADE int 3 UpdateStatus
UPDATESTATUS_UPDATE_FAILED int 4 UpdateStatus: Device reconnected with bad version
UPDATESTATUS_UPDATE_CONFIRMED int 5 UpdateStatus

UnknownDeviceError 

Name Type Value Comment
UnknownDeviceError string "ERR_UNKNOWN_DEVICE"

Data structures 

AddBucketResponseMessage 

class AddBucketResponseMessage extends CometAPIResponseMessageNewBucketDetail {
}

AdminAccountPropertiesResponse 

class AdminAccountPropertiesResponse {
    AdminUserPermissions Permissions
}

AdminUserPermissions 

class AdminUserPermissions {
    bool PreventEditServerSettings // Can be omitted in JSON
    bool PreventServerShutdown // Can be omitted in JSON
}

B2DestinationLocation 

class B2DestinationLocation {
    string AccountID // Can be omitted in JSON
    string Key // Can be omitted in JSON
    string Bucket // Can be omitted in JSON
    string Prefix // Can be omitted in JSON
    int    MaxConnections // Can be omitted in JSON
}

BackupJobDetail 

class BackupJobDetail {
    string            GUID
    string            Username
    int               Classification
    int               Status
    int               StartTime
    int               EndTime
    string            SourceGUID
    string            DestinationGUID
    string            DeviceID
    string            ClientVersion
    int               TotalDirectories
    int               TotalFiles
    int               TotalSize
    int               TotalChunks
    int               UploadSize
    int               DownloadSize
    BackupJobProgress Progress // Can be omitted in JSON
}

BackupJobProgress 

class BackupJobProgress {
    int Counter
    int SentTime
    int RecievedTime
    int BytesDone
    int ItemsDone
}

BackupRuleConfig 

class BackupRuleConfig {
    string               Description
    int                  CreateTime
    int                  ModifyTime
    List<string>         PreExec
    List<string>         PostExec
    string               Source
    string               Destination
    bool                 SkipAlreadyRunning
    List<ScheduleConfig> Schedules
}

BucketProperties 

class BucketProperties {
    int             CreateTime
    int             ReadWriteKeyFormat
    string          ReadWriteKey
    SizeMeasurement Size
}

CometAPIResponseMessage 

class CometAPIResponseMessage {
    int    Status
    string Message
}

ContentMeasurement 

class ContentMeasurement {
    int                               MeasureStarted
    int                               MeasureCompleted
    List<ContentMeasurementComponent> Components
}

ContentMeasurementComponent 

class ContentMeasurementComponent {
    int          Bytes
    List<string> UsedBy
}

DestinationConfig 

class DestinationConfig extends DestinationLocation {
    string                Description
    int                   CreateTime
    int                   ModifyTime
    List<string>          PreExec
    List<string>          PostExec
    int                   EncryptionKeyEncryptionMethod
    string                EncryptedEncryptionKey
    int                   RepoInitTimestamp
    bool                  StorageLimitEnabled
    int                   StorageLimitBytes
    DestinationStatistics Statistics // Can be omitted in JSON
    RetentionPolicy       DefaultRetention
}

DestinationLocation 

class DestinationLocation extends SFTPDestinationLocation {
    int                       DestinationType
    string                    CometServer
    string                    CometBucket
    string                    CometBucketKey
    string                    S3Server
    bool                      S3UsesTLS
    string                    S3AccessKey
    string                    S3SecretKey
    string                    S3BucketName
    string                    S3Subdir
    string                    FTPServer
    string                    FTPUsername
    string                    FTPPassword
    bool                      FTPBaseUseHomeDirectory
    string                    FTPCustomBaseDirectory
    string                    AZBAccountName
    string                    AZBAccountKey
    string                    AZBContainer
    string                    AZBRealm
    string                    AZBPrefix
    string                    LocalcopyPath
    SwiftDestinationLocation  Swift
    B2DestinationLocation     B2
    List<DestinationLocation> SpanTargets
}

DestinationStatistics 

class DestinationStatistics {
    SizeMeasurement    ClientProvidedSize
    ContentMeasurement ClientProvidedContent
}

DeviceConfig 

class DeviceConfig {
    string                              FriendlyName
    Dictionary<string, SourceBasicInfo> Sources // Can be omitted in JSON
}

GetProfileAndHashResponseMessage 

class GetProfileAndHashResponseMessage extends CometAPIResponseMessage {
    string            ProfileHash
    UserProfileConfig Profile
}

GetProfileHashResponseMessage 

class GetProfileHashResponseMessage extends CometAPIResponseMessage {
    string ProfileHash
}

LiveUserConnection 

class LiveUserConnection {
    string Username
    string DeviceID
    string ReportedVersion
    string ReportedPlatform
    int    ConnectionTime
}

NewBucketDetail 

class NewBucketDetail {
    string NewBucketID
    string NewBucketKey
}

NewsEntry 

class NewsEntry {
    int    DateTime
    string TextContent
}

ProtectedItemEngineTypePolicy 

class ProtectedItemEngineTypePolicy {
    bool         ShouldRestrictEngineTypeList
    List<string> AllowedEngineTypeWhenRestricted
}

PublicBrandingProperties 

class PublicBrandingProperties {
    string ProductName
    string CompanyName
    string HelpURL
    string DefaultLoginServerURL
    string TileBackgroundColor
    string AccountRegisterURL
    bool   HideBackgroundLogo
}

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
}

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
}

SFTPDestinationLocation 

class SFTPDestinationLocation {
    string SFTPServer
    string SFTPUsername
    string SFTPRemotePath
    int    SFTPAuthMode
    string SFTPPassword
    string SFTPPrivateKey
    bool   SFTPCustomAuth_UseKnownHostsFile
    string SFTPCustomAuth_KnownHostsFile
}

ScheduleConfig 

class ScheduleConfig {
    int FrequencyType
    int SecondsPast
}

ServerMetaVersionInfo 

class ServerMetaVersionInfo {
    string Version
    string VersionCodename
    bool   StorageRole
    bool   AuthenticationRole
    bool   SoftwareBuildRole
    bool   OverseerRole
    bool   ConstellationRole
    int    ServerStartTime
    string ServerStartHash
    int    CurrentTime
    string ServerLicenseHash
    int    LicenseValidUntil
}

SessionKeyRegeneratedResponse 

class SessionKeyRegeneratedResponse extends CometAPIResponseMessage {
    string SessionKey
}

SizeMeasurement 

class SizeMeasurement {
    int Size
    int MeasureStarted
    int MeasureCompleted
}

SourceBasicInfo 

class SourceBasicInfo {
    string Description
    int    Size
}

SourceConfig 

class SourceConfig {
    string                              Engine
    string                              Description
    string                              OwnerDevice
    int                                 CreateTime
    int                                 ModifyTime
    List<string>                        PreExec
    List<string>                        PostExec
    Dictionary<string, string>          EngineProps
    Dictionary<string, RetentionPolicy> OverrideDestinationRetention // Can be omitted in JSON
    SourceStatistics                    Statistics // Can be omitted in JSON
}

SourceStatistics 

class SourceStatistics {
    BackupJobDetail LastBackupJob
}

StorageVaultProviderPolicy 

class StorageVaultProviderPolicy {
    bool      ShouldRestrictProviderList
    List<int> AllowedProvidersWhenRestricted
}

SwiftDestinationLocation 

class SwiftDestinationLocation {
    string Username // Can be omitted in JSON
    string APIKey // Can be omitted in JSON
    string Region // Can be omitted in JSON
    string AuthURL // Can be omitted in JSON
    string Domain // Can be omitted in JSON
    string Tenant // Can be omitted in JSON
    string TenantDomain // Can be omitted in JSON
    string TenantID // Can be omitted in JSON
    string TrustID // Can be omitted in JSON
    string AuthToken // Can be omitted in JSON
    string Prefix // Can be omitted in JSON
    string Container // Can be omitted in JSON
    string DefaultContainerPolicy // Can be omitted in JSON
}

TestResponse 

class TestResponse extends CometAPIResponseMessage {
    bool Exists
}

TotpRegeneratedResponse 

class TotpRegeneratedResponse extends CometAPIResponseMessage {
    string Image
}

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
}

UserPolicy 

class UserPolicy {
    bool                          PreventRequestStorageVault
    bool                          PreventAddCustomStorageVault
    bool                          PreventEditStorageVault
    bool                          PreventDeleteStorageVault
    StorageVaultProviderPolicy    StorageVaultProviders
    bool                          PreventNewProtectedItem
    bool                          PreventEditProtectedItem
    bool                          PreventDeleteProtectedItem
    ProtectedItemEngineTypePolicy ProtectedItemEngineTypes
    bool                          PreventDeleteSingleSnapshots
    bool                          PreventChangeAccountPassword
    bool                          PreventChangeEmailSettings
    bool                          PreventOpenAppUI
    bool                          PreventViewDeviceNames
}

UserProfileConfig 

class UserProfileConfig {
    string                                Username
    string                                LocalTimezone
    string                                LanguageCode
    List<string>                          Emails
    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
    UserPolicy                            Policy
    int                                   PasswordFormat
    string                                PasswordHash
    int                                   CreateTime
    string                                CreationGUID
}