API Methods

AdminAccountProperties: Retrieve properties about the current admin account

Some key parameters are obscured, but the obscured values are safely recognised by the corresponding AdminAccountSetProperties API.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/properties
• Return type: AdminAccountPropertiesResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/account/regenerate-totp
• Return type: TotpRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminAccountSessionRevoke: Revoke a session key (log out)

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/session-revoke
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminAccountSessionStart: Generate a session key (log in)

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/session-start
• Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SelfAddress	string	External URL of this server (Optional)

AdminAccountSessionStartAsUser: Generate a session key for an end-user (log in as end-user)

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/session-start-as-user (>= 19.6.8)
• Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Target account username

AdminAccountSessionUpgrade: Upgrade a session key which is pending an MFA upgrade to a full session key

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/session-upgrade (>= 23.6.7)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SessionKey	string	The session key to upgrade

AdminAccountSetProperties: Update settings for your own admin account

Updating your account password requires you to supply your current password. To set a new plaintext password, use a password format of 0 (PASSWORD_FORMAT_PLAINTEXT). This API does not currently allow you to modify your TOTP secret or IP whitelist.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/set-properties (>= 18.9.9)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Security	AdminSecurityOptions (JSON)	Updated account properties

AdminAccountU2fRequestRegistrationChallenge: Register a new FIDO U2F token

Browser support for U2F is ending in February 2022. WebAuthn is backwards compatible with U2F keys, and Comet will automatically migrate existing U2F keys to allow their use with the WebAuthn endpoints.

You must supply administrator authentication credentials to use this API.

This API has no maintained endpoints.

• Return type: U2FRegistrationChallengeResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SelfAddress	string	External URL of this server, used as U2F AppID and Facet

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/account/u2f/request-registration-challenge (>= 21.12.0) ("AdminAccountU2fRequestRegistrationChallenge")

AdminAccountU2fSubmitChallengeResponse: Register a new FIDO U2F token

Browser support for U2F is ending in February 2022. WebAuthn is backwards compatible with U2F keys, and Comet will automatically migrate existing U2F keys to allow their use with the WebAuthn endpoints.

You must supply administrator authentication credentials to use this API.

This API has no maintained endpoints.

• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
U2FChallengeID	string	Associated value from AdminAccountU2fRequestRegistrationChallenge API
U2FClientData	string	U2F response data supplied by hardware token
U2FRegistrationData	string	U2F response data supplied by hardware token
U2FVersion	string	U2F response data supplied by hardware token
Description	string	Description of the token (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/account/u2f/submit-challenge-response (>= 21.12.0) ("AdminAccountU2fSubmitChallengeResponse")

AdminAccountValidateTotp: Validate the TOTP code before turning 2fa(TOTP) on

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/validate-totp
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TOTPCode	string	Six-digit code after scanning barcode image

AdminAccountWebauthnRequestRegistrationChallenge: Register a new FIDO2 WebAuthn token

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/webauthn/request-registration-challenge
• Return type: WebAuthnRegistrationChallengeResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SelfAddress	string	External URL of this server, used as WebAuthn ID

AdminAccountWebauthnSubmitChallengeResponse: Register a new FIDO2 WebAuthn token

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/account/webauthn/submit-challenge-response
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SelfAddress	string	External URL of this server, used as WebAuthn ID
ChallengeID	string	Associated value from AdminAccountWebAuthnRequestRegistrationChallenge API
Credential	string	JSON-encoded credential

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.

• Endpoint: POST /api/v1/admin/add-user
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	New account username
TargetPassword	string	New account password
StoreRecoveryCode	int	If set to 1, store and keep a password recovery code for the generated user (>= 18.3.9) (Optional)
RequirePasswordChange	int	If set to 1, require to reset password at the first login for the generated user (>= 20.3.4) (Optional)
TargetOrganization	string	If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7) (Optional)

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

This allows you to create a new account and set all its properties at once (e.g. during account replication). Developers creating a signup form may find it simpler to use the AdminAddUser and AdminGetUserProfile / AdminSetUserProfile APIs separately.

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

• Endpoint: POST /api/v1/admin/add-user-from-profile
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	New account username
ProfileData	UserProfileConfig (JSON)	New account profile
TargetOrganization	string	If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7) (Optional)

AdminAdminUserDelete: Delete an administrator

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/admin-user/delete (>= 20.9.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	the username of the admin to be deleted

AdminAdminUserList: List administrators

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/admin-user/list (>= 20.9.0)
• Return type: List<AllowedAdminUser> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminAdminUserNew: Add a new administrator

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/admin-user/new (>= 20.9.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	the username for this new admin
TargetPassword	string	the password for this new admin user
TargetOrgID	string	provide the organization ID for this user, it will default to the org of the authenticating user otherwise (Optional)

AdminBrandingAvailablePlatforms: List available software download platforms

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/available-platforms (>= 18.12.2)
• Return type: Dictionary<int, AvailableDownload> (JSON), or CometAPIResponseMessage (JSON) on failure

AdminBrandingGenerateClientByPlatform: Download software

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/by-platform (>= 18.12.2)
• Return type: Body in application/octet-stream encoding, or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Platform	int	The selected download platform, from the AdminBrandingAvailablePlatforms API
SelfAddress	string	The external URL of this server, used to resolve conflicts (Optional)

AdminBrandingGenerateClientLinuxDeb: Download software (Linux Debian Package)

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/linux-deb
• Return type: Body in application/octet-stream encoding, or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
SelfAddress	string	The external URL of this server, used to resolve conflicts (Optional)

AdminBrandingGenerateClientLinuxgeneric: Download software (Linux Server .run)

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/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/update-software/linuxgeneric ("UpdateSoftwareLinuxgeneric")

AdminBrandingGenerateClientMacosArm64: Download software (macOS arm64 pkg)

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/macos-arm64
• Return type: Body in application/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/update-software/macos-arm64 ("UpdateSoftwareMacosArm64")

AdminBrandingGenerateClientMacosX8664: Download software (macOS x86_64 pkg)

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/macos-x86_64
• Return type: Body in application/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/update-software/macos-x86_64 ("UpdateSoftwareMacosX8664")

AdminBrandingGenerateClientSpkDsm6: Download software (Synology SPK for DSM 6)

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/spk-dsm6
• Return type: Body in application/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/update-software/spk-dsm6 ("UpdateSoftwareSpkDsm6")

AdminBrandingGenerateClientSpkDsm7: Download software (Synology SPK for DSM 7)

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/spk-dsm7
• Return type: Body in application/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/update-software/spk-dsm7 ("UpdateSoftwareSpkDsm7")

AdminBrandingGenerateClientTest: Check if a software download is available

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/test (>= 19.12.2)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Platform	int	The selected download platform, from the AdminBrandingAvailablePlatforms API
SelfAddress	string	The external URL of this server, used to resolve conflicts (Optional)

AdminBrandingGenerateClientWindowsAnycpuExe: Download software update (Windows AnyCPU exe)

The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

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-anycpu-exe
• Return type: Body in application/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 2 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.

• POST /api/v1/update-software/windows ("UpdateSoftwareWindows")
• POST /api/v1/update-software ("UpdateSoftware")

AdminBrandingGenerateClientWindowsAnycpuZip: Download software (Windows AnyCPU zip)

The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

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-anycpu-zip
• Return type: Body in application/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 2 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/windows ("AdminBrandingGenerateClientWindows")
• POST /api/v1/admin/branding/generate-client ("AdminBrandingGenerateClient")

AdminBrandingGenerateClientWindowsX8632Exe: Download software update (Windows x86_32 exe)

The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

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-exe
• Return type: Body in application/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/update-software/windows-x86_32 ("UpdateSoftwareWindowsX8632")

AdminBrandingGenerateClientWindowsX8632Zip: Download software (Windows x86_32 zip)

The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

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-zip
• Return type: Body in application/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/windows-x86_32 ("AdminBrandingGenerateClientWindowsX8632")

AdminBrandingGenerateClientWindowsX8664Exe: Download software update (Windows x86_64 exe)

The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.

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-exe
• Return type: Body in application/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/update-software/windows-x86_64 ("UpdateSoftwareWindowsX8664")

AdminBrandingGenerateClientWindowsX8664Zip: Download software (Windows x86_64 zip)

The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.

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-zip
• Return type: Body in application/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/windows-x86_64 ("AdminBrandingGenerateClientWindowsX8664")

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.

• Endpoint: POST /api/v1/admin/bulletin/submit
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/constellation/last-report
• Return type: ConstellationCheckReport (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 ("AdminOverseerLastReport")

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.

• Endpoint: POST /api/v1/admin/constellation/new-report
• Return type: ConstellationCheckReport (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 ("AdminOverseerNewReport")

AdminConstellationPruneNow: Prune unused buckets

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts. This API requires the Constellation Role to be enabled.

• Endpoint: POST /api/v1/admin/constellation/prune-now
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 ("AdminOverseerPruneNow")

AdminConstellationStatus: Get Constellation status

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

• Endpoint: POST /api/v1/admin/constellation/status
• Return type: ConstellationStatusAPIResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 ("AdminOverseerStatus")

AdminConvertStorageRole: Convert IAM Storage Role vault to its underlying S3 type

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/convert-storage-role (>= 24.6.3)
• Return type: RequestStorageVaultResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	The user to receive the new Storage Vault
DestinationId	string	The id of the old storage role destination to convert

AdminCountJobsForCustomSearch: Count jobs (for custom search)

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

• Endpoint: POST /api/v1/admin/count-jobs-for-custom-search (>= 22.12.0)
• Return type: CountJobsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Query	SearchClause (JSON)	(No description available)

AdminCreateInstallToken: Create token for silent installation

Currently only supported for Windows & macOS only Provide the installation token to silently install the client on windows install.exe /TOKEN=<installtoken> Provide the installation token to silently install the client on Mac OS sudo launchctl setenv BACKUP_APP_TOKEN "installtoken" && sudo /usr/sbin/installer -allowUntrusted -pkg "Comet Backup.pkg" -target /

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

• Endpoint: POST /api/v1/admin/create-install-token (>= 20.9.0)
• Return type: InstallTokenResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Selected account username
TargetPassword	string	Selected account password
Server	string	External URL of the authentication server that is different from the current server (Optional)

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! This also allows to uninstall software from active devices under the user account This also removes all job history for the user account.

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

• Endpoint: POST /api/v1/admin/delete-user
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Selected account username
UninstallConfig	UninstallConfig (JSON)	Uninstall software configuration (>= 20.3.5) (Optional)

AdminDisableUserTotp: Disable user account 2FA(TOTP) authentication

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

• Endpoint: POST /api/v1/admin/disable-user-totp (>= 20.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/dispatcher/apply-retention-rules (>= 17.6.9)
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherDeepverifyStorageVault: Instruct a live connected device to deeply verify Storage Vault content

This command is understood by Comet Backup 18.8.2 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/deepverify-storage-vault (>= 18.8.2)
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherDeleteSnapshot: Instruct a live connected device to delete a stored snapshot

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

• Endpoint: POST /api/v1/admin/dispatcher/delete-snapshot (>= 19.12.2)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotID	string	The backup job snapshot ID to delete

AdminDispatcherDeleteSnapshots: Instruct a live connected device to delete multiple stored snapshots

The target device must be running Comet 20.9.10 or later.

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

• Endpoint: POST /api/v1/admin/dispatcher/delete-snapshots (>= 20.9.10)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotIDs	List<string> (JSON)	The backup job snapshot IDs to delete

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.

• Endpoint: POST /api/v1/admin/dispatcher/drop-connection
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherEmailPreview: Request HTML content of an email

The remote device must have given consent for an MSP to browse their mail

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

• Endpoint: POST /api/v1/admin/dispatcher/email-preview (>= 21.9.5)
• Return type: EmailReportGeneratedPreview (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Snapshot	string	where the email belongs to
Destination	string	The Storage Vault ID
Path	string	of the email to view

AdminDispatcherGetDefaultLoginUrl: Get the default login URL for a tenant

You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/dispatcher/get-default-login-url (>= 22.9.3)
• Return type: OrganizationLoginURLResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
OrganizationID	string	Target organization

AdminDispatcherImportApply: Instruct a live connected device to import settings from an installed product

This command is understood by Comet Backup 17.12.0 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/import-apply (>= 17.12.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
ImportSourceID	string	The selected import source, as found by the AdminDispatcherRequestImportSources API

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.

• Endpoint: POST /api/v1/admin/dispatcher/kill-process
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/dispatcher/list-active
• Return type: Dictionary<string, LiveUserConnection> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
UserNameFilter	string	User name filter string (Optional)

AdminDispatcherOffice365ListVirtualAccounts: Request a list of Office365 Resources (groups, sites, teams groups and users)

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/office365-list-virtual-accounts (>=21.9.12)
• Return type: BrowseOffice365ListVirtualAccountsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

AdminDispatcherPingDestination: Test the connection to the storage bucket

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

• Endpoint: POST /api/v1/admin/dispatcher/ping-destination (>= 21.6.11)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
ExtraData	DestinationLocation (JSON)	The destination location settings

AdminDispatcherRefetchProfile: Instruct a live connected device to refresh their profile

This command is understood by Comet Backup 17.12.0 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/refetch-profile (>= 17.12.0)
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherRegisterOfficeApplicationBegin: Begin the process of registering a new Azure AD application that can access Office 365 for backup

After calling this API, you should supply the login details to the end-user, and then begin polling the AdminDispatcherRegisterOfficeApplicationCheck with the supplied "Continuation" parameter to check on the registration process.

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

• Endpoint: POST /api/v1/admin/dispatcher/register-office-application/begin (>= 21.3.8)
• Return type: RegisterOfficeApplicationBeginResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
EmailAddress	string	The email address of the Azure AD administrator

AdminDispatcherRegisterOfficeApplicationCheck: Check the process of registering a new Azure AD application that can access Office 365 for backup

You should begin the process by calling AdminDispatcherRegisterOfficeApplicationBegin and asking the end-user to complete the Azure authentication steps.

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

• Endpoint: POST /api/v1/admin/dispatcher/register-office-application/check (>= 21.3.8)
• Return type: RegisterOfficeApplicationCheckResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Continuation	string	The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint

AdminDispatcherReindexStorageVault: Instruct a live connected device to rebuild Storage Vault indexes now

This command is understood by Comet Backup 18.6.9 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/reindex-storage-vault (>= 18.6.9)
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherRequestBrowseDiskDrives: Request a list of physical disk drive information from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-disk-drives (>= 20.6.1)
• Return type: BrowseDiskDrivesResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestBrowseExchangeEdb: Request a list of Exchange EDB databases from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-exchange-edb (>= 20.6.1)
• Return type: BrowseEDBResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestBrowseHyperv: Request a list of Hyper-V virtual machines from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-hyperv (>= 20.6.1)
• Return type: BrowseHVResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestBrowseMongodb: Request a list of tables in MongoDB database

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-mongodb (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	MongoDBConnection (JSON)	The Mongo database authentication settings

AdminDispatcherRequestBrowseMssql: Request a list of tables in MSSQL database

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-mssql (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	MSSQLConnection (JSON)	The MSSQL database authentication settings

AdminDispatcherRequestBrowseMysql: Request a list of tables in MySQL database

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-mysql (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	MySQLConnection (JSON)	The MySQL database authentication settings

AdminDispatcherRequestBrowseVmware: Request a list of VMware vSphere virtual machines

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-vmware
• Return type: BrowseVMwareResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	VMwareConnection (JSON)	The VMware vSphere connection settings

AdminDispatcherRequestBrowseVssAaw: Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-browse-vss-aaw (>= 20.6.1)
• Return type: BrowseVSSResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestFilesystemObjects: Request a list of filesystem objects from a live connected device

The device must have granted the administrator permission to view its filenames.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-filesystem-objects (>= 20.3.2)
• Return type: DispatcherStoredObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Path	string	Browse objects inside this path. If empty or not present, returns the top-level device paths (Optional)

AdminDispatcherRequestImportSources: Request a list of import sources from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-import-sources
• Return type: DispatcherAdminSourcesResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestOffice365Accounts: Request a list of Office365 mailbox accounts

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-office365-accounts (>= 21.3.5)
• Return type: BrowseOffice365ObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

AdminDispatcherRequestOffice365Sites: Request a list of Office365 sites

The remote device must have given consent for an MSP to browse their files.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-office365-sites (>= 21.3.5)
• Return type: BrowseOffice365ObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

AdminDispatcherRequestStoredObjects: Request a list of stored objects inside an existing backup job

The remote device must have given consent for an MSP to browse their files. To service this request, the remote device must connect to the Storage Vault and load index data. There may be a small delay. If the remote device is running Comet 20.12.0 or later, the necessary index data is cached when this API is first called, for 15 minutes after the last repeated call. This can improve performance for interactively browsing an entire tree of stored objects.

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

• Endpoint: POST /api/v1/admin/dispatcher/request-stored-objects (>= 19.3.0)
• Return type: DispatcherStoredObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Destination	string	The Storage Vault ID
SnapshotID	string	The selected backup job snapshot
TreeID	string	Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID. (Optional)
Options	VMDKSnapshotViewOptions (JSON)	Request a list of stored objects in vmdk file (Optional)

AdminDispatcherRequestVaultSnapshots: Request a list of Storage Vault snapshots from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-vault-snapshots
• Return type: DispatcherVaultSnapshotsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminDispatcherRequestWindiskSnapshot: Request a Disk Image snapshot with the windiskbrowse-style from a live connected device

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

• Endpoint: POST /api/v1/admin/dispatcher/request-windisk-snapshot (>= 21.9.3)
• Return type: DispatcherWindiskSnapshotResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Destination	string	The Storage Vault ID
SnapshotID	string	The Snapshot ID

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.

• Endpoint: POST /api/v1/admin/dispatcher/run-backup
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
BackupRule	string	The schedule 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.

• Endpoint: POST /api/v1/admin/dispatcher/run-backup-custom
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Source	string	The Protected Item GUID
Destination	string	The Storage Vault GUID
Options	BackupJobAdvancedOptions (JSON)	Extra job parameters (>= 19.3.6) (Optional)

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.

• Endpoint: POST /api/v1/admin/dispatcher/run-restore (>= 17.9.3)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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)
Paths	List<string> (JSON)	If present, restore these paths only. Otherwise, restore all data (>= 19.3.0) (Optional)

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

This command is understood by Comet Backup 18.6.0 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/run-restore-custom (>= 18.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Source	string	The Protected Item ID
Destination	string	The Storage Vault ID
Options	RestoreJobAdvancedOptions (JSON)	Restore targets
Snapshot	string	If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair (Optional)
Paths	List<string> (JSON)	If present, restore these paths only. Otherwise, restore all data (Optional)
KnownFileCount	int	The number of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the file count and will speed up the restoration process. (Optional)
KnownByteCount	int	The total size in bytes of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the total file size and will speed up the restoration process. (Optional)
KnownDirCount	int	The number of directories to restore, if known. Supplying this means we don't need to walk the entire tree just to find the number of directories and will speed up the restoration process. (Optional)

AdminDispatcherSearchSnapshots: Search storage vault snapshots

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

• Endpoint: POST /api/v1/admin/dispatcher/search-snapshots
• Return type: SearchSnapshotsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotIDs	List<string> (JSON)	Snapshots to search
Filter	SearchClause (JSON)	The search filter

AdminDispatcherTestSmbAuth: Test a set of Windows SMB credentials

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

• Endpoint: POST /api/v1/admin/dispatcher/test-smb-auth (>= 24.9.3)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
Wsa	WinSMBAuth (JSON)	The target credentials to test

AdminDispatcherUninstallSoftware: Instruct a live connected device to self-uninstall the software

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

• Endpoint: POST /api/v1/admin/dispatcher/uninstall-software (>= 20.3.5)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
RemoveConfigFile	bool (JSON)	Determine if the config.dat file will be deleted at the same time

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

Misuse can cause data loss! This command is understood by Comet Backup 17.9.4 and newer.

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

• Endpoint: POST /api/v1/admin/dispatcher/unlock (>= 17.9.4)
• Return type: CometAPIResponseMessage (JSON)

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

AdminDispatcherUpdateLoginUrl: Instruct a live connected device to update its login server URL

The device will attempt to connect to the new Auth Role Comet Server using its current username and password. If the test connection succeeds, the device migrates its saved connection settings and live connections to the new server. If the device is not registered on the new URL, or if the credentials are incorrect, the device remains on the current Auth Role server.

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

• Endpoint: POST /api/v1/admin/dispatcher/update-login-url (>= 20.3.8)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
NewURL	string	The new external URL of this server
Force	bool (JSON)	No checks will be done using previous URL (Optional)

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.

• Endpoint: POST /api/v1/admin/dispatcher/update-software
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetID	string	The live connection GUID
SelfAddress	string	The external URL of this server, used to resolve conflicts (>= 19.3.11) (Optional)

AdminExternalAuthSourcesDelete: Delete an external admin authentication source

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/external-auth-sources/delete (>= 23.6.7)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SourceID	string	(No description available)

AdminExternalAuthSourcesGet: Get a map of all external admin authentication sources

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/external-auth-sources/get (>= 23.6.7)
• Return type: Dictionary<string, ExternalAuthenticationSource> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminExternalAuthSourcesNew: Create an external admin authentication source

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/external-auth-sources/new (>= 23.6.7)
• Return type: ExternalAuthenticationSourceResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Source	ExternalAuthenticationSource (JSON)	(No description available)
SourceID	string	(No description available) (Optional)

AdminExternalAuthSourcesSet: Updates the current tenant's external admin authentication sources. This will set all

sources for the tenant; none will be preserved.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/external-auth-sources/set (>= 23.6.7)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Sources	Dictionary<string, ExternalAuthenticationSource> (JSON)	(No description available)

AdminGetJobLog: Get the report log entries for a single job, in plaintext format

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', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
JobID	string	Selected job ID

AdminGetJobLogEntries: 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-entries (>= 20.6.8)
• Return type: List<JobEntry> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
JobID	string	Selected job ID
MinSeverity	string	Return only job log entries with equal or higher severity (Optional)
MessageContains	string	Return only job log entries that contain exact string (Optional)

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.

• Endpoint: POST /api/v1/admin/get-job-properties
• Return type: BackupJobDetail (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/get-jobs-all
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminGetJobsForCustomSearch: Get jobs (for custom search)

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.

• Endpoint: POST /api/v1/admin/get-jobs-for-custom-search (>= 18.9.2)
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Query	SearchClause (JSON)	(No description available)

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 only incomplete jobs by setting both Start and End to 0.

Prior to Comet Server 22.6.0, additional Incomplete jobs may have been returned if you specified non-zero arguments for both Start and End.

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-jobs-for-date-range
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Start	int	Timestamp (Unix)
End	int	Timestamp (Unix)

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 ("AdminGetJobsForDaterange")

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.

• Endpoint: POST /api/v1/admin/get-jobs-for-user
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/get-jobs-recent
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/get-user-profile
• Return type: UserProfileConfig (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/get-user-profile-and-hash
• Return type: GetProfileAndHashResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/get-user-profile-hash
• Return type: GetProfileHashResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

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

AdminInstallationDispatchDropConnection: 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.

• Endpoint: POST /api/v1/admin/installation/dispatch/drop-connection
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
DeviceID	string	The live connection Device GUID

AdminInstallationDispatchRegisterDevice: Instruct an unregistered device to authenticate with a given user

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

• Endpoint: POST /api/v1/admin/installation/dispatch/register-device
• Return type: string (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
DeviceID	string	The live connection Device GUID
TargetUser	string	Selected account username
TargetPassword	string	Selected account password
TargetTOTPCode	string	Selected account TOTP code (Optional)

AdminInstallationListActive: List live connected devices in lobby mode

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

• Endpoint: POST /api/v1/admin/installation/list-active
• Return type: Dictionary<string, RegistrationLobbyConnection> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminJobAbandon: Mark a running job as abandoned

This will change the status of a running job to abandoned. This is intended to be used on jobs which are definitely no longer running but are stuck in the running state; it will not attempt to cancel the job. If the job is detected to still be running after being marked as abandoned, it will be revived.

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

• Endpoint: POST /api/v1/admin/job/abandon (>= 23.9.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Username
JobID	string	Job ID

AdminJobCancel: Cancel a running job

A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection. Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties. If the device is running Comet 21.9.5 or later, this API will wait up to ten seconds for a confirmation from the client.

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

• Endpoint: POST /api/v1/admin/job/cancel (>= 18.3.5)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Username
JobID	string	Job ID

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', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/list-users-full
• Return type: Dictionary<string, UserProfileConfig> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaBrandingConfigGet: Get Branding 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/branding-config/get (>= 20.6.0)
• Return type: ServerConfigOptionsBrandingFragment (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaBrandingConfigSet: Set Branding configuration

Note that file resources must be provided using a resource URI, i.e "resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57". See AdminMetaResourceNew for the API documentation to create new file resources.

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/branding-config/set (>= 20.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
BrandingConfig	BrandingOptions (JSON)	Updated configuration content

AdminMetaBuildConfigGet: Get Software Build Role 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/build-config/get (>= 20.6.0)
• Return type: ServerConfigOptionsSoftwareBuildRoleFragment (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaBuildConfigSet: Set Build Role 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/build-config/set (>= 20.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SoftwareBuildRoleConfig	SoftwareBuildRoleOptions (JSON)	Updated configuration content

AdminMetaConstellationConfigGet: Get Constellation configuration for the current organization

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

• Endpoint: POST /api/v1/admin/meta/constellation/config/get (>= 22.9.0)
• Return type: ConstellationRoleOptions (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaConstellationConfigSet: Set Constellation configuration for the current organization

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

• Endpoint: POST /api/v1/admin/meta/constellation/config/set (>= 22.9.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
ConstellationRoleOptions	ConstellationRoleOptions (JSON)	Constellation role options to set

AdminMetaEmailOptionsGet: Get the email options

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/email-options/get (>= 22.12.0)
• Return type: EmailOptions (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaEmailOptionsSet: Set the email options

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/email-options/set (>= 22.12.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
EmailOptions	EmailOptions (JSON)	The replacement email reporting options.

AdminMetaListAvailableLogDays: Get log files

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• 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', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaPsaConfigListGet: Get the server PSA configuration

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/psa-config-list/get
• Return type: List<PSAConfig> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaPsaConfigListSet: Update the server PSA configuration

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/psa-config-list/set
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
PSAConfigList	List<PSAConfig> (JSON)	The replacement PSA configuration list

AdminMetaPsaConfigListSyncNow: Synchronize all PSA services now

This API applies to the current Organization's PSAConfig's only.

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

• Endpoint: POST /api/v1/admin/meta/psa-config-list/sync-now
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaReadAllLogs: Get a ZIP file of all of the server's log files

On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2. This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/meta/read-all-logs (>= 21.9.7)
• Return type: Body in application/zip encoding, or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaReadLogs: Get log file content

On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2. This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• 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', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Log	int	A log day, selected from the options returned by the Get Log Files API

AdminMetaReadSelectLogs: Get logs file content

On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2. This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/meta/read-select-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', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Logs	List<int> (JSON)	An array of log days, selected from the options returned by the Get Log Files API

AdminMetaRemoteStorageVaultGet: Get Requesting Remote Storage Vault Config

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/remote-storage-vault/get (>= 20.6.0)
• Return type: List<RemoteStorageOption> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaRemoteStorageVaultSet: Set Storage template vault options

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/remote-storage-vault/set (>= 20.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
RemoteStorageOptions	List<RemoteStorageOption> (JSON)	Updated configuration content

AdminMetaRemoteStorageVaultTest: Test the connection to the storage template

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/remote-storage-vault/test
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TemplateOptions	RemoteStorageOption (JSON)	Storage Template Vault Options

AdminMetaResourceGet: Get a resource file

Resources are used to upload files within the server configuration.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/resource/get
• Return type: Body in application/octet-stream encoding, or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Hash	string	The resource identifier

AdminMetaResourceNew: Upload a resource file

Resources are used to upload files within the server configuration. The resulting resource ID is autogenerated. The lifespan of an uploaded resource is undefined. Resources may be deleted automatically, but it should remain available until the next call to AdminMetaServerConfigSet, and will remain available for as long as it is referenced by the server configuration.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/resource/new
• Encoding: multipart/form-data
• Return type: AdminResourceResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Header X-Comet-Admin-Username	string	Admin account name
Header X-Comet-Admin-AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey' (Optional)
Header X-Comet-Admin-Password	string	Admin account password (Optional)
Header X-Comet-Admin-SessionKey	string	Admin session key (Optional)
Header X-Comet-Admin-TOTP	string	Admin current TOTP code (Optional)
Header X-Comet-Admin-WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
upload	string	The uploaded file contents, as a multipart/form-data part.

AdminMetaRestartService: Restart server

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

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts. Access to this API may be prevented on a per-administrator basis.

• Endpoint: POST /api/v1/admin/meta/restart-service
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaSendTestEmail: Send a test email message

This allows the Comet Server web interface to support testing different email credentials during setup.

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/send-test-email
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
EmailOptions	EmailOptions (JSON)	Updated configuration content
Recipient	string	Target email address to send test email

AdminMetaSendTestReport: Send a test admin email report

This allows a user to send a test email report

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/send-test-report
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
EmailReportingOption	EmailReportingOption (JSON)	Test email reporting option for sending
TargetOrganization	string	If present, Testing email with a target organization. Only allowed for top-level admins. (>= 24.3.0) (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. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/meta/server-config/get
• Return type: ServerConfigOptions (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaServerConfigNetworkInterfaces: List the available network interfaces on the PC running Comet Server

Any IPv6 addresses are listed in compressed form without square-brackets.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/meta/server-config/network-interfaces (>= 19.6.0)
• Return type: List<string> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaServerConfigSet: Set server configuration

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

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/meta/server-config/set
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Config	ServerConfigOptions (JSON)	Updated configuration content

AdminMetaShutdownService: Shut down server

The Comet Server process will exit.

Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts. Access to this API may be prevented on a per-administrator basis.

• Endpoint: POST /api/v1/admin/meta/shutdown-service
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaSoftwareUpdateNews: Get software update news from the software provider

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/software-update-news
• Return type: SoftwareUpdateNewsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaStats: Get Comet Server historical statistics

The returned key-value map is not necessarily ordered. Client-side code should sort the result before display.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/stats
• Return type: Dictionary<int, StatResult> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Simple	bool (JSON)	Remove redundant statistics

AdminMetaVersion: Get server properties

Retrieve the version number and basic properties about the server.

You must supply administrator authentication credentials to use this API.

• Endpoint: POST /api/v1/admin/meta/version
• Return type: ServerMetaVersionInfo (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaWebhookOptionsGet: Get the server webhook 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/webhook-options/get (>= 20.6.1)
• Return type: Dictionary<string, WebhookOption> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminMetaWebhookOptionsSet: Update the server webhook configuration

Calling this endpoint will interrupt any messages currently queued for existing webhook destinations.

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/webhook-options/set (>= 20.6.1)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
WebhookOptions	Dictionary<string, WebhookOption> (JSON)	The replacement webhook target options.

AdminNewsGetAll: Get News entries (Admin)

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

• Endpoint: POST /api/v1/admin/news/get-all
• Return type: Dictionary<string, NewsEntry> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminNewsRemove: Remove news item

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

• Endpoint: POST /api/v1/admin/news/remove
• Return type: CometAPIResponseMessage (JSON)

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

AdminNewsSubmit: Submit news item

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

• Endpoint: POST /api/v1/admin/news/submit
• Return type: CometAPIResponseMessage (JSON)

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

AdminOrganizationDelete: Delete an organization and all related users

Prior to Comet 22.6.0, this API was documented as returning the OrganizationResponse type. However, it always has returned only a CometAPIResponseMessage.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/organization/delete (>= 20.9.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
OrganizationID	string	(No description available) (Optional)
UninstallConfig	UninstallConfig (JSON)	Uninstall software configuration (Optional)

AdminOrganizationExport: Run self-backup for a specific tenant

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/organization/export
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Options	SelfBackupExportOptions (JSON)	The export config options

AdminOrganizationList: List Organizations

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/organization/list (>= 20.9.0)
• Return type: Dictionary<string, Organization> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminOrganizationSet: Create or Update an Organization

Prior to Comet 22.6.0, the 'ID' and 'Organization' fields were not present in the response.

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/organization/set (>= 20.9.0)
• Return type: OrganizationResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
OrganizationID	string	(No description available) (Optional)
Organization	Organization (JSON)	(No description available) (Optional)

AdminPoliciesDelete: Delete an existing policy object

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

• Endpoint: POST /api/v1/admin/policies/delete (>= 18.3.11)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
PolicyID	string	The policy ID to update or create

AdminPoliciesGet: Retrieve a single policy object

A hash is also returned, to allow atomic modification operations.

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

• Endpoint: POST /api/v1/admin/policies/get (>= 18.3.11)
• Return type: GetGroupPolicyResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
PolicyID	string	The policy ID to retrieve

AdminPoliciesList: List all policy object names

For the top-level organization, the API result includes all policies for all organizations, unless the TargetOrganization parameter is present.

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

• Endpoint: POST /api/v1/admin/policies/list (>= 18.3.11)
• Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetOrganization	string	If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7) (Optional)

AdminPoliciesListFull: Get all policy objects

For the top-level organization, the API result includes all policies for all organizations, unless the TargetOrganization parameter is present.

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

• Endpoint: POST /api/v1/admin/policies/list-full (>= 18.3.11)
• Return type: Dictionary<string, GroupPolicy> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetOrganization	string	If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7) (Optional)

AdminPoliciesNew: Create a new policy object

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

• Endpoint: POST /api/v1/admin/policies/new (>= 18.3.11)
• Return type: CreateGroupPolicyResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
Policy	GroupPolicy (JSON)	The policy data

AdminPoliciesSet: Update an existing policy object

An optional hash may be used, to ensure the modification was atomic. This API can also be used to create a new policy object with a specific hash.

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

• Endpoint: POST /api/v1/admin/policies/set (>= 18.3.11)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
PolicyID	string	The policy ID to update or create
Policy	GroupPolicy (JSON)	The policy data
CheckPolicyHash	string	An atomic verification hash as supplied by the AdminPoliciesGet API (Optional)

AdminPreviewUserEmailReport: Preview an email report for a customer

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

• Endpoint: POST /api/v1/admin/preview-user-email-report
• Return type: EmailReportGeneratedPreview (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Selected account username
EmailReportConfig	EmailReportConfig (JSON)	Email report configuration to preview
EmailAddress	string	Email address that may be included in the report body (>= 20.3.3) (Optional)

AdminReplicationState: Get Replication status

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/replication/state
• Return type: List<ReplicatorStateAPIResponse> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 ("AdminStorageReplicationState")

AdminRequestStorageVault: 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. Prior to Comet 19.8.0, the response type was CometAPIResponseMessage (i.e. no DestinationID field in response). The StorageProvider must exist for the target user account's organization.

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-storage-vault (>= 18.6.2)
• Return type: RequestStorageVaultResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	The user to receive the new Storage Vault
StorageProvider	string	ID for the storage template destination
SelfAddress	string	The external URL for 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/request-bucket (>= 1.0.0) ("AdminRequestBucket")

AdminRequestStorageVaultProviders: 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-storage-vault-providers (>= 18.6.2)
• Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetOrganization	string	If present, list the storage template options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7) (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/request-bucket-options (>= 1.0.0) ("AdminRequestBucketOptions")

AdminResetUserPassword: Reset user account password

The user account must have a recovery code present. A new replacement recovery code will be generated automatically.

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

• Endpoint: POST /api/v1/admin/reset-user-password
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
TargetUser	string	Selected account username
NewPassword	string	New account password
OldPassword	string	Old account password. Required if no recovery code is present for the user account. (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.

• Endpoint: POST /api/v1/admin/revoke-device
• Return type: CometAPIResponseMessage (JSON)

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

AdminSelfBackupStart: Run self-backup on all targets

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/self-backup/start
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminSetUserProfile: Modify user account profile

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

• Endpoint: POST /api/v1/admin/set-user-profile
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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.

• Endpoint: POST /api/v1/admin/set-user-profile-hash
• Return type: CometAPIResponseMessage (JSON)

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

AdminStorageBucketProperties: Retrieve properties for a single bucket

This API can also be used to refresh the size measurement for a single bucket by passing a valid AfterTimestamp parameter.

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

• Endpoint: POST /api/v1/admin/storage/bucket-properties (>= 20.9.4)
• Return type: BucketProperties (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
BucketID	string	Bucket ID
AfterTimestamp	int	Allow a stale size measurement if it is at least as new as the supplied Unix timestamp. Timestamps in the future may produce a result clamped down to the Comet Server's current time. If not present, the size measurement may be arbitrarily stale. (Optional)

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.

• Endpoint: POST /api/v1/admin/storage/delete-bucket
• Return type: CometAPIResponseMessage (JSON)

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

AdminStorageFreeSpace: Retrieve available space metrics

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API requires the Storage Role to be enabled. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/storage/free-space (>= 19.12.4)
• Return type: StorageFreeSpaceInfo (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
BucketID	string	(This parameter is not used) (Optional)

AdminStorageListBuckets: List all buckets

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

• Endpoint: POST /api/v1/admin/storage/list-buckets
• Return type: Dictionary<string, BucketProperties> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

AdminStoragePingDestination: Ping a storage destination

You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for top-level administrator accounts, not for Tenant administrator accounts.

• Endpoint: POST /api/v1/admin/storage/ping-destination
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
ExtraData	DestinationLocation (JSON)	The destination location settings

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.

• Endpoint: POST /api/v1/admin/storage/register-bucket
• Return type: AddBucketResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)
SetBucketValue	string	Bucket ID (Optional)
SetKeyHashFormat	string	Bucket key hashing format (Optional)
SetKeyHashValue	string	Bucket key hash (Optional)
SetOrganizationID	string	Target organization ID (>= 20.9.0) (Optional)

AdminUpdateCampaignStart: Start a new software update campaign

You must supply administrator authentication credentials to use this API. This API is only available for top-level administrator accounts, not for Tenant administrator accounts. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/admin/update-campaign/start (>= 17.9.6)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (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 is only available for top-level administrator accounts, not for Tenant administrator accounts. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/admin/update-campaign/status (>= 17.9.6)
• Return type: UpdateCampaignStatus (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	Admin account name
AuthType	string	Either 'Password', 'PasswordTOTP', 'PasswordWebAuthn', 'TOTP', or 'SessionKey'
Password	string	Admin account password (Optional)
SessionKey	string	Admin session key (Optional)
TOTP	string	Admin current TOTP code (Optional)
WebAuthnSign	WebAuthnSignResponse (JSON)	Admin WebAuthn challenge signature (Optional)

BrandingProps: Retrieve basic information about this Comet Server

• Endpoint: GET /gen/branding.props
• Return type: ServerMetaBrandingProperties (JSON), or CometAPIResponseMessage (JSON) on failure

HybridSessionStart: Generate a session key (log in)

This hybrid API allows you to log in to the Comet Server as either an administrator or end-user account. This API behaves like either AdminAccountSessionStart or UserWebSessionStart, depending on what the supplied credentials were valid for.

• Endpoint: POST /api/v1/hybrid/session/start (>= 18.12.3)
• Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

UserDispatcherEmailPreview: Request HTML content of an email

The remote device must have given consent for an MSP to browse their mail

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/dispatcher/email-preview (>= 21.9.5)
• Return type: EmailReportGeneratedPreview (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Snapshot	string	where the email belongs to
Destination	string	The Storage Vault ID
Path	string	of the email to view

UserWebAccountRegenerateTotp: Generate a new TOTP secret for user (web)

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 user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/account/regenerate-totp
• Return type: TotpRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
ProfileHash	string	Previous account profile hash

UserWebAccountResetPassword: Reset the password for your own user account (web)

A new replacement recovery code will be generated if the present recovery code is not empty

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/account/reset-password
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
ProfileHash	string	Previous account profile hash
OldPassword	string	Current account password
NewPassword	string	New account password

UserWebAccountValidateTotp: Validate the TOTP code before turning 2fa(TOTP) on

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/account/validate-totp
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
ProfileHash	string	Previous account profile hash
TOTPCode	string	Six-digit code after scanning barcode image

UserWebDispatcherDeleteSnapshot: Instruct a live connected device to delete a stored snapshot

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/delete-snapshot (>= 19.12.2)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotID	string	The backup job snapshot ID to delete

UserWebDispatcherDeleteSnapshots: Instruct a live connected device to delete multiple stored snapshots

The target device must be running Comet 20.9.10 or later.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/delete-snapshots (>= 20.9.10)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotIDs	List<string> (JSON)	The backup job snapshot IDs to delete

UserWebDispatcherListActive: List live connected devices in my account

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/list-active
• Return type: Dictionary<string, LiveUserConnection> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)

UserWebDispatcherOffice365ListVirtualAccounts: Request a list of Office365 Resources (groups, sites, teams groups and users)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/office365-list-virtual-accounts (>=21.9.12)
• Return type: BrowseOffice365ListVirtualAccountsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

UserWebDispatcherPingDestination: Test the connection to the storage bucket

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/ping-destination (>= 21.6.11)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
ExtraData	DestinationLocation (JSON)	The destination location settings

UserWebDispatcherRegisterOfficeApplicationBegin: Begin the process of registering a new Azure AD application that can access Office 365 for backup

After calling this API, you should supply the login details to the end-user, and then begin polling the AdminDispatcherRegisterOfficeApplicationCheck with the supplied "Continuation" parameter to check on the registration process.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/register-office-application/begin (>= 21.3.8)
• Return type: RegisterOfficeApplicationBeginResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
EmailAddress	string	The email address of the Azure AD administrator

UserWebDispatcherRegisterOfficeApplicationCheck: Check the process of registering a new Azure AD application that can access Office 365 for backup

You should begin the process by calling AdminDispatcherRegisterOfficeApplicationBegin and asking the end-user to complete the Azure authentication steps.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/register-office-application/check (>= 21.3.8)
• Return type: RegisterOfficeApplicationCheckResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Continuation	string	The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint

UserWebDispatcherRequestBrowseDiskDrives: Request a list of physical disk drive information from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-disk-drives (>= 20.6.1)
• Return type: BrowseDiskDrivesResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID

UserWebDispatcherRequestBrowseExchangeEdb: Request a list of Exchange EDB databases from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-exchange-edb (>= 20.6.1)
• Return type: BrowseEDBResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID

UserWebDispatcherRequestBrowseHyperv: Request a list of Hyper-V virtual machines from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-hyperv (>= 20.6.1)
• Return type: BrowseHVResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID

UserWebDispatcherRequestBrowseMongodb: Request a list of tables in MongoDB database

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-mongodb (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	MongoDBConnection (JSON)	The MongoDB database authentication settings

UserWebDispatcherRequestBrowseMssql: Request a list of tables in MSSQL database

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-mssql (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	MSSQLConnection (JSON)	The MSSQL database authentication settings

UserWebDispatcherRequestBrowseMysql: Request a list of tables in MySQL database

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-mysql (>= 21.3.5)
• Return type: BrowseSQLServerResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	MySQLConnection (JSON)	The MySQL database authentication settings

UserWebDispatcherRequestBrowseVmware: Request a list of VMware vSphere virtual machines

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-vmware
• Return type: BrowseVMwareResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	VMwareConnection (JSON)	The VMWare ESXi connection settings

UserWebDispatcherRequestBrowseVssAaw: Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-browse-vss-aaw (>= 20.6.1)
• Return type: BrowseVSSResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID

UserWebDispatcherRequestOffice365Accounts: Request a list of Office365 mailbox accounts

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-office365-accounts (>= 21.3.5)
• Return type: BrowseOffice365ObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

UserWebDispatcherRequestOffice365Sites: Request a list of Office365 sites

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-office365-sites (>= 21.3.5)
• Return type: BrowseOffice365ObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Credentials	Office365Credential (JSON)	The Office365 account credential

UserWebDispatcherRequestStoredObjects: Request a list of stored objects inside an existing backup job

The remote device must have given consent for an MSP to browse their files.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-stored-objects (>= 19.3.0)
• Return type: DispatcherStoredObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Destination	string	The Storage Vault ID
SnapshotID	string	The selected backup job snapshot
TreeID	string	Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID. (Optional)
Options	VMDKSnapshotViewOptions (JSON)	Request a list of stored objects in vmdk file (Optional)

UserWebDispatcherRequestVaultSnapshots: Request a list of Storage Vault snapshots from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-vault-snapshots
• Return type: DispatcherVaultSnapshotsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Destination	string	The Storage Vault ID

UserWebDispatcherRequestWindiskSnapshot: Request a Disk Image snapshot with the windiskbrowse-style from a live connected device

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/request-windisk-snapshot (>= 21.9.3)
• Return type: DispatcherWindiskSnapshotResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Destination	string	The Storage Vault ID
SnapshotID	string	The Snapshot ID

UserWebDispatcherRunBackup: Instruct a live connected device in my account to run a scheduled backup

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/run-backup (>= 18.3.13)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
BackupRule	string	The schedule GUID

UserWebDispatcherRunBackupCustom: Instruct a live connected device to run a backup

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/run-backup-custom (>= 18.3.13)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Source	string	The Protected Item GUID
Destination	string	The Storage Vault GUID
Options	BackupJobAdvancedOptions (JSON)	Extra job parameters (>= 19.3.6) (Optional)

UserWebDispatcherRunRestore: Instruct a live connected device in my account to perform a local restore

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/run-restore (>= 18.3.13)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (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)
Paths	List<string> (JSON)	If present, restore these paths only. Otherwise, restore all data (>= 19.3.0) (Optional)

UserWebDispatcherRunRestoreCustom: Instruct a live connected device in my account to perform a local restore

This command is understood by Comet Backup 18.6.0 and newer.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/run-restore-custom (>= 18.6.0)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Source	string	The Protected Item ID
Destination	string	The Storage Vault ID
Options	RestoreJobAdvancedOptions (JSON)	Restore targets
Snapshot	string	If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair (Optional)
Paths	List<string> (JSON)	If present, restore these paths only. Otherwise, restore all data (>= 19.3.0) (Optional)
KnownFileCount	int	The number of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the file count and will speed up the restoration process. (Optional)
KnownByteCount	int	The total size in bytes of files to restore, if known. Supplying this means we don't need to walk the entire tree just to find the total file size and will speed up the restoration process. (Optional)
KnownDirCount	int	The number of directories to restore, if known. Supplying this means we don't need to walk the entire tree just to find the number of directories and will speed up the restoration process. (Optional)

UserWebDispatcherSearchSnapshots: Search storage vault snapshots

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/search-snapshots
• Return type: SearchSnapshotsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
DestinationID	string	The Storage Vault GUID
SnapshotIDs	List<string> (JSON)	Snapshots to search
Filter	SearchClause (JSON)	The search filter

UserWebDispatcherTestSmbAuth: Test a set of Windows SMB credentials

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/dispatcher/test-smb-auth (>= 24.9.3)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Wsa	WinSMBAuth (JSON)	The target credentials to test

UserWebGetJobLog: Get backup job report log, in plaintext format (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-job-log
• Return type: Body in text/plain encoding, or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
JobID	string	Selected job GUID

UserWebGetJobLogEntries: Get backup job report log (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-job-log-entries (>= 20.6.8)
• Return type: List<JobEntry> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
JobID	string	Selected job GUID
MinSeverity	string	Return only job log entries with equal or higher severity (Optional)
MessageContains	string	Return only job log entries that contain exact string (Optional)

UserWebGetJobProperties: Get backup job properties (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-job-properties
• Return type: BackupJobDetail (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
JobID	string	Selected job GUID

UserWebGetJobs: List all backup jobs (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-jobs
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)

UserWebGetJobsForCustomSearch: List all backup jobs (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-jobs-for-custom-search (>= 18.12.2)
• Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)

UserWebGetUserProfileAndHash: Get user account profile (atomic)

(Web interface version)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/get-user-profile-and-hash
• Return type: GetProfileAndHashResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)

UserWebJobCancel: Cancel a running job

A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection. Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties. If the device is running Comet 21.9.5 or later, this API will wait up to ten seconds for a confirmation from the client.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/job/cancel (>= 19.6.3)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
JobID	string	Job ID

UserWebNewsGetAll: Get News entries (Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/news/get-all
• Return type: Dictionary<string, NewsEntry> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)

UserWebRequestFilesystemObjects: Request a list of filesystem objects from the device

The device must have granted the administrator permission to view its filenames.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/request-filesystem-objects (>= 20.6.1)
• Return type: DispatcherStoredObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
TargetID	string	The live connection GUID
Path	string	Browse objects inside this path. If empty or not present, returns the top-level device paths (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/user/request-filesystem-objects (>= 20.3.2) ("UserRequestFilesystemObjects")

UserWebRequestStorageVault: Request a new Storage Vault (Web)

This action can be prevented via policy. Prior to Comet 19.8.0, the response type was CometAPIResponseMessage (i.e. no DestinationID field in response). The StorageProvider must exist for the target user account's organization.

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/request-storage-vault (>= 18.6.2)
• Return type: RequestStorageVaultResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
StorageProvider	string	ID for the storage template destination
SelfAddress	string	The external URL for 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/user/web/request-bucket ("UserWebRequestBucket")

UserWebRequestStorageVaultProviders: Get the available options for Requesting a Storage Vault (User Web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/request-storage-vault-providers (>= 18.6.2)
• Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (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/user/web/request-bucket-options ("UserWebRequestBucketOptions")

UserWebSessionRevoke: Revoke a session key (log out)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/session/revoke (>= 19.6.3)
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (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/user/session/revoke ("UserSessionRevoke")

UserWebSessionStart: Generate a session key (log in)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/session/start (>= 19.6.3)
• Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (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/user/session/start ("UserSessionStart")

UserWebSetProfileHash: Set account profile (atomic, web)

You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.

• Endpoint: POST /api/v1/user/web/set-profile-hash
• Return type: CometAPIResponseMessage (JSON)

Parameter	Type	Description
Username	string	User account name
AuthType	string	Either 'Password', 'LKey', or 'SessionKey'
Password	string	User account password (Optional)
LKey	string	User account L-key (Optional)
SessionKey	string	User session key (Optional)
ProfileData	UserProfileConfig (JSON)	Updated account profile
ProfileHash	string	Previous account profile hash