cometsdk

func (*CometAPIClient) AdminAccountProperties ¶

func (this *CometAPIClient) AdminAccountProperties() (*AdminAccountPropertiesResponse, error)

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.

func (*CometAPIClient) AdminAccountRegenerateTotp ¶

func (this *CometAPIClient) AdminAccountRegenerateTotp() (*TotpRegeneratedResponse, error)

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.

func (*CometAPIClient) AdminAccountSessionRevoke ¶

func (this *CometAPIClient) AdminAccountSessionRevoke() (*CometAPIResponseMessage, error)

AdminAccountSessionRevoke: Revoke a session key (log out)

You must supply administrator authentication credentials to use this API.

func (*CometAPIClient) AdminAccountSessionStart ¶

func (this *CometAPIClient) AdminAccountSessionStart(SelfAddress *string) (*SessionKeyRegeneratedResponse, error)

AdminAccountSessionStart: Generate a session key (log in)

You must supply administrator authentication credentials to use this API.

- Params SelfAddress: (Optional) External URL of this server

func (*CometAPIClient) AdminAccountSessionStartAsUser ¶

func (this *CometAPIClient) AdminAccountSessionStartAsUser(TargetUser string) (*SessionKeyRegeneratedResponse, error)

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

You must supply administrator authentication credentials to use this API.

- Params TargetUser: Target account username

func (*CometAPIClient) AdminAccountSetProperties ¶

func (this *CometAPIClient) AdminAccountSetProperties(Security AdminSecurityOptions) (*CometAPIResponseMessage, error)

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.

- Params Security: Updated account properties

func (*CometAPIClient) AdminAccountU2fRequestRegistrationChallenge ¶

func (this *CometAPIClient) AdminAccountU2fRequestRegistrationChallenge(SelfAddress string) (*U2FRegistrationChallengeResponse, error)

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.

- Params SelfAddress: External URL of this server, used as U2F AppID and Facet

func (*CometAPIClient) AdminAccountU2fSubmitChallengeResponse ¶

func (this *CometAPIClient) AdminAccountU2fSubmitChallengeResponse(U2FChallengeID string, U2FClientData string, U2FRegistrationData string, U2FVersion string, Description string) (*CometAPIResponseMessage, error)

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.

- Params U2FChallengeID: Associated value from AdminAccountU2fRequestRegistrationChallenge API U2FClientData: U2F response data supplied by hardware token U2FRegistrationData: U2F response data supplied by hardware token U2FVersion: U2F response data supplied by hardware token Description: Optional description of the token

func (*CometAPIClient) AdminAccountValidateTotp ¶

func (this *CometAPIClient) AdminAccountValidateTotp(TOTPCode string) (*CometAPIResponseMessage, error)

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

You must supply administrator authentication credentials to use this API.

- Params TOTPCode: Six-digit code after scanning barcode image

func (*CometAPIClient) AdminAccountWebauthnRequestRegistrationChallenge ¶

func (this *CometAPIClient) AdminAccountWebauthnRequestRegistrationChallenge(SelfAddress string) (*WebAuthnRegistrationChallengeResponse, error)

AdminAccountWebauthnRequestRegistrationChallenge: Register a new FIDO2 WebAuthn token

You must supply administrator authentication credentials to use this API.

- Params SelfAddress: External URL of this server, used as WebAuthn ID

func (*CometAPIClient) AdminAccountWebauthnSubmitChallengeResponse ¶

func (this *CometAPIClient) AdminAccountWebauthnSubmitChallengeResponse(SelfAddress string, ChallengeID string, Credential string) (*CometAPIResponseMessage, error)

AdminAccountWebauthnSubmitChallengeResponse: Register a new FIDO2 WebAuthn token

You must supply administrator authentication credentials to use this API.

- Params SelfAddress: External URL of this server, used as WebAuthn ID ChallengeID: Associated value from AdminAccountWebAuthnRequestRegistrationChallenge API Credential: JSON-encoded credential

func (*CometAPIClient) AdminAddUser ¶

func (this *CometAPIClient) AdminAddUser(TargetUser string, TargetPassword string, StoreRecoveryCode *int, RequirePasswordChange *int, TargetOrganization *string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: New account username TargetPassword: New account password StoreRecoveryCode: (Optional) If set to 1, store and keep a password recovery code for the generated user (>= 18.3.9) RequirePasswordChange: (Optional) If set to 1, require to reset password at the first login for the generated user (>= 20.3.4) TargetOrganization: (Optional) If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

func (*CometAPIClient) AdminAddUserFromProfile ¶

func (this *CometAPIClient) AdminAddUserFromProfile(TargetUser string, ProfileData UserProfileConfig, TargetOrganization *string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: New account username ProfileData: New account profile TargetOrganization: (Optional) If present, create the user account on behalf of another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

func (*CometAPIClient) AdminAdminUserDelete ¶

func (this *CometAPIClient) AdminAdminUserDelete(TargetUser string) (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params TargetUser: the username of the admin to be deleted

func (*CometAPIClient) AdminAdminUserList ¶

func (this *CometAPIClient) AdminAdminUserList() ([]AllowedAdminUser, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminAdminUserNew ¶

func (this *CometAPIClient) AdminAdminUserNew(TargetUser string, TargetPassword string, TargetOrgID *string) (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params TargetUser: the username for this new admin TargetPassword: the password for this new admin user TargetOrgID: (Optional) provide the organization ID for this user, it will default to the org of the authenticating user otherwise

func (*CometAPIClient) AdminBrandingAvailablePlatforms ¶

func (this *CometAPIClient) AdminBrandingAvailablePlatforms() (map[int]AvailableDownload, error)

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.

func (*CometAPIClient) AdminBrandingGenerateClientByPlatform ¶

func (this *CometAPIClient) AdminBrandingGenerateClientByPlatform(Platform int, SelfAddress *string) ([]byte, error)

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.

- Params Platform: The selected download platform, from the AdminBrandingAvailablePlatforms API SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientLinuxgeneric ¶

func (this *CometAPIClient) AdminBrandingGenerateClientLinuxgeneric(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientMacosX8664 ¶

func (this *CometAPIClient) AdminBrandingGenerateClientMacosX8664(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientSpkDsm6 ¶

func (this *CometAPIClient) AdminBrandingGenerateClientSpkDsm6(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientSpkDsm7 ¶

func (this *CometAPIClient) AdminBrandingGenerateClientSpkDsm7(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientTest ¶

func (this *CometAPIClient) AdminBrandingGenerateClientTest(Platform int, SelfAddress *string) (*CometAPIResponseMessage, error)

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.

- Params Platform: The selected download platform, from the AdminBrandingAvailablePlatforms API SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsAnycpuExe ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsAnycpuExe(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsAnycpuZip ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsAnycpuZip(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsX8632Exe ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsX8632Exe(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsX8632Zip ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsX8632Zip(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsX8664Exe ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsX8664Exe(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBrandingGenerateClientWindowsX8664Zip ¶

func (this *CometAPIClient) AdminBrandingGenerateClientWindowsX8664Zip(SelfAddress *string) ([]byte, error)

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.

- Params SelfAddress: (Optional) The external URL of this server, used to resolve conflicts

func (*CometAPIClient) AdminBulletinSubmit ¶

func (this *CometAPIClient) AdminBulletinSubmit(Subject string, Content string) (*CometAPIResponseMessage, error)

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.

- Params Subject: Bulletin subject line Content: Bulletin message content

func (*CometAPIClient) AdminConstellationLastReport ¶

func (this *CometAPIClient) AdminConstellationLastReport() (*ConstellationCheckReport, error)

AdminConstellationLastReport: Get Constellation bucket usage report (cached)

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

func (*CometAPIClient) AdminConstellationNewReport ¶

func (this *CometAPIClient) AdminConstellationNewReport() (*ConstellationCheckReport, error)

AdminConstellationNewReport: Get Constellation bucket usage report (regenerate)

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

func (*CometAPIClient) AdminConstellationPruneNow ¶

func (this *CometAPIClient) AdminConstellationPruneNow() (*CometAPIResponseMessage, error)

AdminConstellationPruneNow: Prune unused buckets

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

func (*CometAPIClient) AdminConstellationStatus ¶

func (this *CometAPIClient) AdminConstellationStatus() (*ConstellationStatusAPIResponse, error)

AdminConstellationStatus: Get Constellation status

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

func (*CometAPIClient) AdminCreateInstallToken ¶

func (this *CometAPIClient) AdminCreateInstallToken(TargetUser string, TargetPassword string, Server *string) (*InstallTokenResponse, error)

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.

- Params TargetUser: Selected account username TargetPassword: Selected account password Server: (Optional) External URL of the authentication server that is different from the current server

func (*CometAPIClient) AdminDeleteUser ¶

func (this *CometAPIClient) AdminDeleteUser(TargetUser string, UninstallConfig *UninstallConfig) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Selected account username UninstallConfig: (Optional) Uninstall software configuration (>= 20.3.5)

func (*CometAPIClient) AdminDisableUserTotp ¶

func (this *CometAPIClient) AdminDisableUserTotp(TargetUser string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Selected account username

func (*CometAPIClient) AdminDispatcherApplyRetentionRules ¶

func (this *CometAPIClient) AdminDispatcherApplyRetentionRules(TargetID string, Destination string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault GUID

func (*CometAPIClient) AdminDispatcherDeepverifyStorageVault ¶

func (this *CometAPIClient) AdminDispatcherDeepverifyStorageVault(TargetID string, Destination string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault GUID

func (*CometAPIClient) AdminDispatcherDeleteSnapshot ¶

func (this *CometAPIClient) AdminDispatcherDeleteSnapshot(TargetID string, DestinationID string, SnapshotID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID DestinationID: The Storage Vault GUID SnapshotID: The backup job snapshot ID to delete

func (*CometAPIClient) AdminDispatcherDeleteSnapshots ¶

func (this *CometAPIClient) AdminDispatcherDeleteSnapshots(TargetID string, DestinationID string, SnapshotIDs []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID DestinationID: The Storage Vault GUID SnapshotIDs: The backup job snapshot IDs to delete

func (*CometAPIClient) AdminDispatcherDropConnection ¶

func (this *CometAPIClient) AdminDispatcherDropConnection(TargetID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherEmailPreview ¶

func (this *CometAPIClient) AdminDispatcherEmailPreview(TargetID string, Snapshot string, Destination string, Path string) (*EmailReportGeneratedPreview, error)

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.

- Params TargetID: The live connection GUID Snapshot: where the email belongs to Destination: The Storage Vault ID Path: of the email to view

func (*CometAPIClient) AdminDispatcherImportApply ¶

func (this *CometAPIClient) AdminDispatcherImportApply(TargetID string, ImportSourceID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID ImportSourceID: The selected import source, as found by the AdminDispatcherRequestImportSources API

func (*CometAPIClient) AdminDispatcherKillProcess ¶

func (this *CometAPIClient) AdminDispatcherKillProcess(TargetID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherListActive ¶

func (this *CometAPIClient) AdminDispatcherListActive(UserNameFilter *string) (LiveUserConnectionMap, error)

AdminDispatcherListActive: List live connected devices

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

- Params UserNameFilter: (Optional) User name filter string

func (*CometAPIClient) AdminDispatcherOffice365ListVirtualAccounts ¶

func (this *CometAPIClient) AdminDispatcherOffice365ListVirtualAccounts(TargetID string, Credentials Office365Credential) (*BrowseOffice365ListVirtualAccountsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) AdminDispatcherPingDestination ¶

func (this *CometAPIClient) AdminDispatcherPingDestination(TargetID string, ExtraData DestinationLocation) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID ExtraData: The destination location settings

func (*CometAPIClient) AdminDispatcherRefetchProfile ¶

func (this *CometAPIClient) AdminDispatcherRefetchProfile(TargetID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRegisterOfficeApplicationBegin ¶

func (this *CometAPIClient) AdminDispatcherRegisterOfficeApplicationBegin(TargetID string, EmailAddress string) (*RegisterOfficeApplicationBeginResponse, error)

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.

- Params TargetID: The live connection GUID EmailAddress: The email address of the Azure AD administrator

func (*CometAPIClient) AdminDispatcherRegisterOfficeApplicationCheck ¶

func (this *CometAPIClient) AdminDispatcherRegisterOfficeApplicationCheck(TargetID string, Continuation string) (*RegisterOfficeApplicationCheckResponse, error)

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.

- Params TargetID: The live connection GUID Continuation: The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint

func (*CometAPIClient) AdminDispatcherReindexStorageVault ¶

func (this *CometAPIClient) AdminDispatcherReindexStorageVault(TargetID string, Destination string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault GUID

func (*CometAPIClient) AdminDispatcherRequestBrowseDiskDrives ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseDiskDrives(TargetID string) (*BrowseDiskDrivesResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRequestBrowseExchangeEdb ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseExchangeEdb(TargetID string) (*BrowseEDBResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRequestBrowseHyperv ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseHyperv(TargetID string) (*BrowseHVResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRequestBrowseMongodb ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseMongodb(TargetID string, Credentials MongoDBConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Mongo database authentication settings

func (*CometAPIClient) AdminDispatcherRequestBrowseMssql ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseMssql(TargetID string, Credentials MSSQLConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The MSSQL database authentication settings

func (*CometAPIClient) AdminDispatcherRequestBrowseMysql ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseMysql(TargetID string, Credentials MySQLConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The MySQL database authentication settings

func (*CometAPIClient) AdminDispatcherRequestBrowseVssAaw ¶

func (this *CometAPIClient) AdminDispatcherRequestBrowseVssAaw(TargetID string) (*BrowseVSSResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRequestFilesystemObjects ¶

func (this *CometAPIClient) AdminDispatcherRequestFilesystemObjects(TargetID string, Path *string) (*DispatcherStoredObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Path: (Optional) Browse objects inside this path. If empty or not present, returns the top-level device paths

func (*CometAPIClient) AdminDispatcherRequestImportSources ¶

func (this *CometAPIClient) AdminDispatcherRequestImportSources(TargetID string) (*DispatcherAdminSourcesResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) AdminDispatcherRequestOffice365Accounts ¶

func (this *CometAPIClient) AdminDispatcherRequestOffice365Accounts(TargetID string, Credentials Office365Credential) (*BrowseOffice365ObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) AdminDispatcherRequestOffice365Sites ¶

func (this *CometAPIClient) AdminDispatcherRequestOffice365Sites(TargetID string, Credentials Office365Credential) (*BrowseOffice365ObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) AdminDispatcherRequestStoredObjects ¶

func (this *CometAPIClient) AdminDispatcherRequestStoredObjects(TargetID string, Destination string, SnapshotID string, TreeID *string, Options *VMDKSnapshotViewOptions) (*DispatcherStoredObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID SnapshotID: The selected backup job snapshot TreeID: (Optional) Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID. Options: (Optional) Request a list of stored objects in vmdk file

func (*CometAPIClient) AdminDispatcherRequestVaultSnapshots ¶

func (this *CometAPIClient) AdminDispatcherRequestVaultSnapshots(TargetID string, Destination string) (*DispatcherVaultSnapshotsResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID

func (*CometAPIClient) AdminDispatcherRequestWindiskSnapshot ¶

func (this *CometAPIClient) AdminDispatcherRequestWindiskSnapshot(TargetID string, Destination string, SnapshotID string) (*DispatcherWindiskSnapshotResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID SnapshotID: The Snapshot ID

func (*CometAPIClient) AdminDispatcherRunBackup ¶

func (this *CometAPIClient) AdminDispatcherRunBackup(TargetID string, BackupRule string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID BackupRule: The schedule GUID

func (*CometAPIClient) AdminDispatcherRunBackupCustom ¶

func (this *CometAPIClient) AdminDispatcherRunBackupCustom(TargetID string, Source string, Destination string, Options *BackupJobAdvancedOptions) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Source: The Protected Item GUID Destination: The Storage Vault GUID Options: (Optional) Extra job parameters (>= 19.3.6)

func (*CometAPIClient) AdminDispatcherRunRestore ¶

func (this *CometAPIClient) AdminDispatcherRunRestore(TargetID string, Path string, Source string, Destination string, Snapshot *string, Paths []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Path: The local path to restore to Source: The Protected Item ID Destination: The Storage Vault ID Snapshot: (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair Paths: (Optional) If present, restore these paths only. Otherwise, restore all data (>= 19.3.0)

func (*CometAPIClient) AdminDispatcherRunRestoreCustom ¶

func (this *CometAPIClient) AdminDispatcherRunRestoreCustom(TargetID string, Source string, Destination string, Options RestoreJobAdvancedOptions, Snapshot *string, Paths []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Source: The Protected Item ID Destination: The Storage Vault ID Options: Restore targets Snapshot: (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair Paths: (Optional) If present, restore these paths only. Otherwise, restore all data

func (*CometAPIClient) AdminDispatcherUninstallSoftware ¶

func (this *CometAPIClient) AdminDispatcherUninstallSoftware(TargetID string, RemoveConfigFile bool) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID RemoveConfigFile: Determine if the config.dat file will be deleted at the same time

func (*CometAPIClient) AdminDispatcherUnlock ¶

func (this *CometAPIClient) AdminDispatcherUnlock(TargetID string, Destination string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault GUID

func (*CometAPIClient) AdminDispatcherUpdateLoginUrl ¶

func (this *CometAPIClient) AdminDispatcherUpdateLoginUrl(TargetID string, NewURL string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID NewURL: The new external URL of this server

func (*CometAPIClient) AdminDispatcherUpdateSoftware ¶

func (this *CometAPIClient) AdminDispatcherUpdateSoftware(TargetID string, SelfAddress *string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID SelfAddress: (Optional) The external URL of this server, used to resolve conflicts (>= 19.3.11)

func (*CometAPIClient) AdminGetJobLog ¶

func (this *CometAPIClient) AdminGetJobLog(JobID string) ([]byte, error)

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.

- Params JobID: Selected job ID

func (*CometAPIClient) AdminGetJobLogEntries ¶

func (this *CometAPIClient) AdminGetJobLogEntries(JobID string) ([]JobEntry, error)

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.

- Params JobID: Selected job ID

func (*CometAPIClient) AdminGetJobProperties ¶

func (this *CometAPIClient) AdminGetJobProperties(JobID string) (*BackupJobDetail, error)

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.

- Params JobID: Selected job ID

func (*CometAPIClient) AdminGetJobsAll ¶

func (this *CometAPIClient) AdminGetJobsAll() ([]BackupJobDetail, error)

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.

func (*CometAPIClient) AdminGetJobsForCustomSearch ¶

func (this *CometAPIClient) AdminGetJobsForCustomSearch(Query SearchClause) ([]BackupJobDetail, error)

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.

- Params Query: (No description available)

func (*CometAPIClient) AdminGetJobsForDateRange ¶

func (this *CometAPIClient) AdminGetJobsForDateRange(Start int, End int) ([]BackupJobDetail, error)

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.

- Params Start: Timestamp (Unix) End: Timestamp (Unix)

func (*CometAPIClient) AdminGetJobsForUser ¶

func (this *CometAPIClient) AdminGetJobsForUser(TargetUser string) ([]BackupJobDetail, error)

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.

- Params TargetUser: Selected username

func (*CometAPIClient) AdminGetJobsRecent ¶

func (this *CometAPIClient) AdminGetJobsRecent() ([]BackupJobDetail, error)

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.

func (*CometAPIClient) AdminGetUserProfile ¶

func (this *CometAPIClient) AdminGetUserProfile(TargetUser string) (*UserProfileConfig, error)

AdminGetUserProfile: Get user account profile

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

- Params TargetUser: Selected account username

func (*CometAPIClient) AdminGetUserProfileAndHash ¶

func (this *CometAPIClient) AdminGetUserProfileAndHash(TargetUser string) (*GetProfileAndHashResponseMessage, error)

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.

- Params TargetUser: Selected account username

func (*CometAPIClient) AdminGetUserProfileHash ¶

func (this *CometAPIClient) AdminGetUserProfileHash(TargetUser string) (*GetProfileHashResponseMessage, error)

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.

- Params TargetUser: Selected account username

func (*CometAPIClient) AdminJobCancel ¶

func (this *CometAPIClient) AdminJobCancel(TargetUser string, JobID string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Username JobID: Job ID

func (*CometAPIClient) AdminListUsers ¶

func (this *CometAPIClient) AdminListUsers() ([]string, error)

AdminListUsers: List all user accounts

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

func (*CometAPIClient) AdminListUsersFull ¶

func (this *CometAPIClient) AdminListUsersFull() (map[string]UserProfileConfig, error)

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.

func (*CometAPIClient) AdminMetaBrandingConfigGet ¶

func (this *CometAPIClient) AdminMetaBrandingConfigGet() (*ServerConfigOptionsBrandingFragment, error)

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.

func (*CometAPIClient) AdminMetaBrandingConfigSet ¶

func (this *CometAPIClient) AdminMetaBrandingConfigSet(BrandingConfig BrandingOptions) (*CometAPIResponseMessage, error)

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.

- Params BrandingConfig: Updated configuration content

func (*CometAPIClient) AdminMetaBuildConfigGet ¶

func (this *CometAPIClient) AdminMetaBuildConfigGet() (*ServerConfigOptionsSoftwareBuildRoleFragment, error)

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.

func (*CometAPIClient) AdminMetaBuildConfigSet ¶

func (this *CometAPIClient) AdminMetaBuildConfigSet(SoftwareBuildRoleConfig SoftwareBuildRoleOptions) (*CometAPIResponseMessage, error)

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.

- Params SoftwareBuildRoleConfig: Updated configuration content

func (*CometAPIClient) AdminMetaListAvailableLogDays ¶

func (this *CometAPIClient) AdminMetaListAvailableLogDays() ([]LogDay, error)

AdminMetaListAvailableLogDays: Get log files

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminMetaReadAllLogs ¶

func (this *CometAPIClient) AdminMetaReadAllLogs() ([]byte, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminMetaReadLogs ¶

func (this *CometAPIClient) AdminMetaReadLogs(Log int) ([]byte, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params Log: A log day, selected from the options returned by the Get Log Files API

func (*CometAPIClient) AdminMetaRemoteStorageVaultGet ¶

func (this *CometAPIClient) AdminMetaRemoteStorageVaultGet() ([]RemoteStorageOption, error)

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.

func (*CometAPIClient) AdminMetaRemoteStorageVaultSet ¶

func (this *CometAPIClient) AdminMetaRemoteStorageVaultSet(RemoteStorageOptions []RemoteStorageOption) (*CometAPIResponseMessage, error)

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.

- Params RemoteStorageOptions: Updated configuration content

func (*CometAPIClient) AdminMetaResourceGet ¶

func (this *CometAPIClient) AdminMetaResourceGet(Hash string) ([]byte, error)

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.

- Params Hash: The resource identifier

func (*CometAPIClient) AdminMetaResourceNew ¶

func (this *CometAPIClient) AdminMetaResourceNew(upload string) (*AdminResourceResponse, error)

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.

- Params upload: The uploaded file contents, as a multipart/form-data part.

func (*CometAPIClient) AdminMetaRestartService ¶

func (this *CometAPIClient) AdminMetaRestartService() (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

func (*CometAPIClient) AdminMetaSendTestEmail ¶

func (this *CometAPIClient) AdminMetaSendTestEmail(EmailOptions EmailOptions, Recipient string) (*CometAPIResponseMessage, error)

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. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

- Params EmailOptions: Updated configuration content Recipient: Target email address to send test email

func (*CometAPIClient) AdminMetaServerConfigGet ¶

func (this *CometAPIClient) AdminMetaServerConfigGet() (*ServerConfigOptions, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminMetaServerConfigNetworkInterfaces ¶

func (this *CometAPIClient) AdminMetaServerConfigNetworkInterfaces() ([]string, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminMetaServerConfigSet ¶

func (this *CometAPIClient) AdminMetaServerConfigSet(Config ServerConfigOptions) (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params Config: Updated configuration content

func (*CometAPIClient) AdminMetaShutdownService ¶

func (this *CometAPIClient) AdminMetaShutdownService() (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.

func (*CometAPIClient) AdminMetaSoftwareUpdateNews ¶

func (this *CometAPIClient) AdminMetaSoftwareUpdateNews() (*SoftwareUpdateNewsResponse, error)

AdminMetaSoftwareUpdateNews: Get software update news from the software provider

You must supply administrator authentication credentials to use this API.

func (*CometAPIClient) AdminMetaStats ¶

func (this *CometAPIClient) AdminMetaStats(Simple bool) (map[int64]StatResult, error)

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.

- Params Simple: Remove redundant statistics

func (*CometAPIClient) AdminMetaVersion ¶

func (this *CometAPIClient) AdminMetaVersion() (*ServerMetaVersionInfo, error)

AdminMetaVersion: Get server properties Retrieve the version number and basic properties about the server.

You must supply administrator authentication credentials to use this API.

func (*CometAPIClient) AdminMetaWebhookOptionsGet ¶

func (this *CometAPIClient) AdminMetaWebhookOptionsGet() (map[string]WebhookOption, error)

AdminMetaWebhookOptionsGet: Get the server webhook configuration

You must supply administrator authentication credentials to use this API.

func (*CometAPIClient) AdminMetaWebhookOptionsSet ¶

func (this *CometAPIClient) AdminMetaWebhookOptionsSet(WebhookOptions map[string]WebhookOption) (*CometAPIResponseMessage, error)

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.

- Params WebhookOptions: The replacement webhook target options.

func (*CometAPIClient) AdminNewsGetAll ¶

func (this *CometAPIClient) AdminNewsGetAll() (NewsEntries, error)

AdminNewsGetAll: Get News entries (Admin)

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

func (*CometAPIClient) AdminNewsRemove ¶

func (this *CometAPIClient) AdminNewsRemove(NewsItem string) (*CometAPIResponseMessage, error)

AdminNewsRemove: Remove news item

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

- Params NewsItem: Selected news item GUID

func (*CometAPIClient) AdminNewsSubmit ¶

func (this *CometAPIClient) AdminNewsSubmit(NewsContent string) (*CometAPIResponseMessage, error)

AdminNewsSubmit: Submit news item

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

- Params NewsContent: Content of news item

func (*CometAPIClient) AdminOrganizationDelete ¶

func (this *CometAPIClient) AdminOrganizationDelete(OrganizationID *string, UninstallConfig *UninstallConfig) (*CometAPIResponseMessage, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params OrganizationID: (Optional) (No description available) UninstallConfig: (Optional) Uninstall software configuration

func (*CometAPIClient) AdminOrganizationList ¶

func (this *CometAPIClient) AdminOrganizationList() (map[string]Organization, error)

AdminOrganizationList: List Organizations

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminOrganizationSet ¶

func (this *CometAPIClient) AdminOrganizationSet(OrganizationID *string, Organization *Organization) (*OrganizationResponse, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params OrganizationID: (Optional) (No description available) Organization: (Optional) (No description available)

func (*CometAPIClient) AdminPoliciesDelete ¶

func (this *CometAPIClient) AdminPoliciesDelete(PolicyID string) (*CometAPIResponseMessage, error)

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.

- Params PolicyID: The policy ID to update or create

func (*CometAPIClient) AdminPoliciesGet ¶

func (this *CometAPIClient) AdminPoliciesGet(PolicyID string) (*GetGroupPolicyResponse, error)

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.

- Params PolicyID: The policy ID to retrieve

func (*CometAPIClient) AdminPoliciesList ¶

func (this *CometAPIClient) AdminPoliciesList(TargetOrganization *string) (map[string]string, error)

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.

- Params TargetOrganization: (Optional) If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

func (*CometAPIClient) AdminPoliciesListFull ¶

func (this *CometAPIClient) AdminPoliciesListFull(TargetOrganization *string) (map[string]GroupPolicy, error)

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.

- Params TargetOrganization: (Optional) If present, list the policies belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

func (*CometAPIClient) AdminPoliciesNew ¶

func (this *CometAPIClient) AdminPoliciesNew(Policy GroupPolicy) (*CreateGroupPolicyResponse, error)

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.

- Params Policy: The policy data

func (*CometAPIClient) AdminPoliciesSet ¶

func (this *CometAPIClient) AdminPoliciesSet(PolicyID string, Policy GroupPolicy, CheckPolicyHash *string) (*CometAPIResponseMessage, error)

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.

- Params PolicyID: The policy ID to update or create Policy: The policy data CheckPolicyHash: (Optional) An atomic verification hash as supplied by the AdminPoliciesGet API

func (*CometAPIClient) AdminPreviewUserEmailReport ¶

func (this *CometAPIClient) AdminPreviewUserEmailReport(TargetUser string, EmailReportConfig EmailReportConfig, EmailAddress *string) (*EmailReportGeneratedPreview, error)

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.

- Params TargetUser: Selected account username EmailReportConfig: Email report configuration to preview EmailAddress: (Optional) Email address that may be included in the report body (>= 20.3.3)

func (*CometAPIClient) AdminReplicationState ¶

func (this *CometAPIClient) AdminReplicationState() ([]ReplicatorStateAPIResponse, error)

AdminReplicationState: Get Replication status

You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

func (*CometAPIClient) AdminRequestStorageVault ¶

func (this *CometAPIClient) AdminRequestStorageVault(TargetUser string, StorageProvider string, SelfAddress *string) (*RequestStorageVaultResponseMessage, error)

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.

- Params TargetUser: The user to receive the new Storage Vault StorageProvider: ID for the storage template destination SelfAddress: (Optional) The external URL for this server. Used to resolve conflicts

func (*CometAPIClient) AdminRequestStorageVaultProviders ¶

func (this *CometAPIClient) AdminRequestStorageVaultProviders(TargetOrganization *string) (map[string]string, error)

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.

- Params TargetOrganization: (Optional) If present, list the storage template options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)

func (*CometAPIClient) AdminResetUserPassword ¶

func (this *CometAPIClient) AdminResetUserPassword(TargetUser string, NewPassword string, OldPassword string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Selected account username NewPassword: New account password OldPassword: Old account password (optional)

func (*CometAPIClient) AdminRevokeDevice ¶

func (this *CometAPIClient) AdminRevokeDevice(TargetUser string, TargetDevice string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Selected account username TargetDevice: Selected Device ID

func (*CometAPIClient) AdminSetUserProfile ¶

func (this *CometAPIClient) AdminSetUserProfile(TargetUser string, ProfileData UserProfileConfig) (*CometAPIResponseMessage, error)

AdminSetUserProfile: Modify user account profile

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

- Params TargetUser: Selected account username ProfileData: Modified user profile

func (*CometAPIClient) AdminSetUserProfileHash ¶

func (this *CometAPIClient) AdminSetUserProfileHash(TargetUser string, ProfileData UserProfileConfig, RequireHash string) (*CometAPIResponseMessage, error)

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.

- Params TargetUser: Selected account username ProfileData: Modified user profile RequireHash: Previous hash parameter

func (*CometAPIClient) AdminStorageBucketProperties ¶

func (this *CometAPIClient) AdminStorageBucketProperties(BucketID string, AfterTimestamp *int) (*BucketProperties, error)

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.

- Params BucketID: Bucket ID AfterTimestamp: (Optional) 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.

func (*CometAPIClient) AdminStorageDeleteBucket ¶

func (this *CometAPIClient) AdminStorageDeleteBucket(BucketID string) (*CometAPIResponseMessage, error)

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.

- Params BucketID: Selected bucket name

func (*CometAPIClient) AdminStorageFreeSpace ¶

func (this *CometAPIClient) AdminStorageFreeSpace(BucketID *string) (*StorageFreeSpaceInfo, error)

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 administrator accounts in the top-level Organization, not in any other Organization.

- Params BucketID: (Optional) (This parameter is not used)

func (*CometAPIClient) AdminStorageListBuckets ¶

func (this *CometAPIClient) AdminStorageListBuckets() (BucketPropertyList, error)

AdminStorageListBuckets: List all buckets

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

func (*CometAPIClient) AdminStoragePingDestination ¶

func (this *CometAPIClient) AdminStoragePingDestination(ExtraData DestinationLocation) (*CometAPIResponseMessage, error)

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 requires the Storage Role to be enabled. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.

- Params ExtraData: The destination location settings

func (*CometAPIClient) AdminStorageRegisterBucket ¶

func (this *CometAPIClient) AdminStorageRegisterBucket(SetBucketValue *string, SetKeyHashFormat *string, SetKeyHashValue *string, SetOrganizationID *string) (*AddBucketResponseMessage, error)

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.

- Params SetBucketValue: (Optional) Bucket ID SetKeyHashFormat: (Optional) Bucket key hashing format SetKeyHashValue: (Optional) Bucket key hash SetOrganizationID: (Optional) Target organization ID (>= 20.9.0)

func (*CometAPIClient) AdminUpdateCampaignStart ¶

func (this *CometAPIClient) AdminUpdateCampaignStart(Options UpdateCampaignOptions) (*CometAPIResponseMessage, error)

AdminUpdateCampaignStart: Start a new software update campaign

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

- Params Options: Configure targets for the software update campaign

func (*CometAPIClient) AdminUpdateCampaignStatus ¶

func (this *CometAPIClient) AdminUpdateCampaignStatus() (*UpdateCampaignStatus, error)

AdminUpdateCampaignStatus: Get current campaign status

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

func (*CometAPIClient) BrandingProps ¶

func (this *CometAPIClient) BrandingProps() (*ServerMetaBrandingProperties, error)

BrandingProps: Retreve basic information about this Comet Server

func (*CometAPIClient) HybridSessionStart ¶

func (this *CometAPIClient) HybridSessionStart() (*SessionKeyRegeneratedResponse, error)

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.

func (*CometAPIClient) Request ¶

func (this *CometAPIClient) Request(contentType, method, path string, data map[string][]string) ([]byte, error)

Request is a convenience method wrapping a basic http request

func (*CometAPIClient) UserDispatcherEmailPreview ¶

func (this *CometAPIClient) UserDispatcherEmailPreview(TargetID string, Snapshot string, Destination string, Path string) (*EmailReportGeneratedPreview, error)

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.

- Params TargetID: The live connection GUID Snapshot: where the email belongs to Destination: The Storage Vault ID Path: of the email to view

func (*CometAPIClient) UserWebAccountRegenerateTotp ¶

func (this *CometAPIClient) UserWebAccountRegenerateTotp(ProfileHash string) (*TotpRegeneratedResponse, error)

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.

- Params ProfileHash: Previous account profile hash

func (*CometAPIClient) UserWebAccountResetPassword ¶

func (this *CometAPIClient) UserWebAccountResetPassword(ProfileHash string, OldPassword string, NewPassword string) (*CometAPIResponseMessage, error)

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.

- Params ProfileHash: Previous account profile hash OldPassword: Current account password NewPassword: New account password

func (*CometAPIClient) UserWebAccountValidateTotp ¶

func (this *CometAPIClient) UserWebAccountValidateTotp(ProfileHash string, TOTPCode string) (*CometAPIResponseMessage, error)

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.

- Params ProfileHash: Previous account profile hash TOTPCode: Six-digit code after scanning barcode image

func (*CometAPIClient) UserWebDispatcherDeleteSnapshot ¶

func (this *CometAPIClient) UserWebDispatcherDeleteSnapshot(TargetID string, DestinationID string, SnapshotID string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID DestinationID: The Storage Vault GUID SnapshotID: The backup job snapshot ID to delete

func (*CometAPIClient) UserWebDispatcherDeleteSnapshots ¶

func (this *CometAPIClient) UserWebDispatcherDeleteSnapshots(TargetID string, DestinationID string, SnapshotIDs []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID DestinationID: The Storage Vault GUID SnapshotIDs: The backup job snapshot IDs to delete

func (*CometAPIClient) UserWebDispatcherListActive ¶

func (this *CometAPIClient) UserWebDispatcherListActive() (LiveUserConnectionMap, error)

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.

func (*CometAPIClient) UserWebDispatcherOffice365ListVirtualAccounts ¶

func (this *CometAPIClient) UserWebDispatcherOffice365ListVirtualAccounts(TargetID string, Credentials Office365Credential) (*BrowseOffice365ListVirtualAccountsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) UserWebDispatcherPingDestination ¶

func (this *CometAPIClient) UserWebDispatcherPingDestination(TargetID string, ExtraData DestinationLocation) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID ExtraData: The destination location settings

func (*CometAPIClient) UserWebDispatcherRegisterOfficeApplicationBegin ¶

func (this *CometAPIClient) UserWebDispatcherRegisterOfficeApplicationBegin(TargetID string, EmailAddress string) (*RegisterOfficeApplicationBeginResponse, error)

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.

- Params TargetID: The live connection GUID EmailAddress: The email address of the Azure AD administrator

func (*CometAPIClient) UserWebDispatcherRegisterOfficeApplicationCheck ¶

func (this *CometAPIClient) UserWebDispatcherRegisterOfficeApplicationCheck(TargetID string, Continuation string) (*RegisterOfficeApplicationCheckResponse, error)

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.

- Params TargetID: The live connection GUID Continuation: The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint

func (*CometAPIClient) UserWebDispatcherRequestBrowseDiskDrives ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseDiskDrives(TargetID string) (*BrowseDiskDrivesResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) UserWebDispatcherRequestBrowseExchangeEdb ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseExchangeEdb(TargetID string) (*BrowseEDBResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) UserWebDispatcherRequestBrowseHyperv ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseHyperv(TargetID string) (*BrowseHVResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) UserWebDispatcherRequestBrowseMongodb ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseMongodb(TargetID string, Credentials MongoDBConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The MongoDB database authentication settings

func (*CometAPIClient) UserWebDispatcherRequestBrowseMssql ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseMssql(TargetID string, Credentials MSSQLConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The MSSQL database authentication settings

func (*CometAPIClient) UserWebDispatcherRequestBrowseMysql ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseMysql(TargetID string, Credentials MySQLConnection) (*BrowseSQLServerResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The MySQL database authentication settings

func (*CometAPIClient) UserWebDispatcherRequestBrowseVssAaw ¶

func (this *CometAPIClient) UserWebDispatcherRequestBrowseVssAaw(TargetID string) (*BrowseVSSResponse, error)

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.

- Params TargetID: The live connection GUID

func (*CometAPIClient) UserWebDispatcherRequestOffice365Accounts ¶

func (this *CometAPIClient) UserWebDispatcherRequestOffice365Accounts(TargetID string, Credentials Office365Credential) (*BrowseOffice365ObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) UserWebDispatcherRequestOffice365Sites ¶

func (this *CometAPIClient) UserWebDispatcherRequestOffice365Sites(TargetID string, Credentials Office365Credential) (*BrowseOffice365ObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Credentials: The Office365 account credential

func (*CometAPIClient) UserWebDispatcherRequestStoredObjects ¶

func (this *CometAPIClient) UserWebDispatcherRequestStoredObjects(TargetID string, Destination string, SnapshotID string, TreeID *string, Options *VMDKSnapshotViewOptions) (*DispatcherStoredObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID SnapshotID: The selected backup job snapshot TreeID: (Optional) Browse objects inside subdirectory of backup snapshot. If it is for VMDK single file restore, it should be the disk image's subtree ID. Options: (Optional) Request a list of stored objects in vmdk file

func (*CometAPIClient) UserWebDispatcherRequestVaultSnapshots ¶

func (this *CometAPIClient) UserWebDispatcherRequestVaultSnapshots(TargetID string, Destination string) (*DispatcherVaultSnapshotsResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID

func (*CometAPIClient) UserWebDispatcherRequestWindiskSnapshot ¶

func (this *CometAPIClient) UserWebDispatcherRequestWindiskSnapshot(TargetID string, Destination string, SnapshotID string) (*DispatcherWindiskSnapshotResponse, error)

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.

- Params TargetID: The live connection GUID Destination: The Storage Vault ID SnapshotID: The Snapshot ID

func (*CometAPIClient) UserWebDispatcherRunBackup ¶

func (this *CometAPIClient) UserWebDispatcherRunBackup(TargetID string, BackupRule string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID BackupRule: The schedule GUID

func (*CometAPIClient) UserWebDispatcherRunBackupCustom ¶

func (this *CometAPIClient) UserWebDispatcherRunBackupCustom(TargetID string, Source string, Destination string, Options *BackupJobAdvancedOptions) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Source: The Protected Item GUID Destination: The Storage Vault GUID Options: (Optional) Extra job parameters (>= 19.3.6)

func (*CometAPIClient) UserWebDispatcherRunRestore ¶

func (this *CometAPIClient) UserWebDispatcherRunRestore(TargetID string, Path string, Source string, Destination string, Snapshot *string, Paths []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Path: The local path to restore to Source: The Protected Item ID Destination: The Storage Vault ID Snapshot: (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair Paths: (Optional) If present, restore these paths only. Otherwise, restore all data (>= 19.3.0)

func (*CometAPIClient) UserWebDispatcherRunRestoreCustom ¶

func (this *CometAPIClient) UserWebDispatcherRunRestoreCustom(TargetID string, Source string, Destination string, Options RestoreJobAdvancedOptions, Snapshot *string, Paths []string) (*CometAPIResponseMessage, error)

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.

- Params TargetID: The live connection GUID Source: The Protected Item ID Destination: The Storage Vault ID Options: Restore targets Snapshot: (Optional) If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair Paths: (Optional) If present, restore these paths only. Otherwise, restore all data (>= 19.3.0)

func (*CometAPIClient) UserWebGetJobLog ¶

func (this *CometAPIClient) UserWebGetJobLog(JobID string) ([]byte, error)

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.

- Params JobID: Selected job GUID

func (*CometAPIClient) UserWebGetJobLogEntries ¶

func (this *CometAPIClient) UserWebGetJobLogEntries(JobID string) ([]JobEntry, error)

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.

- Params JobID: Selected job GUID

func (*CometAPIClient) UserWebGetJobProperties ¶

func (this *CometAPIClient) UserWebGetJobProperties(JobID string) (*BackupJobDetail, error)

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.

- Params JobID: Selected job GUID

func (*CometAPIClient) UserWebGetJobs ¶

func (this *CometAPIClient) UserWebGetJobs() ([]BackupJobDetail, error)

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.

func (*CometAPIClient) UserWebGetJobsForCustomSearch ¶

func (this *CometAPIClient) UserWebGetJobsForCustomSearch() ([]BackupJobDetail, error)

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.

func (*CometAPIClient) UserWebGetUserProfileAndHash ¶

func (this *CometAPIClient) UserWebGetUserProfileAndHash() (*GetProfileAndHashResponseMessage, error)

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.

func (*CometAPIClient) UserWebJobCancel ¶

func (this *CometAPIClient) UserWebJobCancel(JobID string) (*CometAPIResponseMessage, error)

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.

- Params JobID: Job ID

func (*CometAPIClient) UserWebNewsGetAll ¶

func (this *CometAPIClient) UserWebNewsGetAll() (NewsEntries, error)

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.

func (*CometAPIClient) UserWebRequestFilesystemObjects ¶

func (this *CometAPIClient) UserWebRequestFilesystemObjects(TargetID string, Path *string) (*DispatcherStoredObjectsResponse, error)

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.

- Params TargetID: The live connection GUID Path: (Optional) Browse objects inside this path. If empty or not present, returns the top-level device paths

func (*CometAPIClient) UserWebRequestStorageVault ¶

func (this *CometAPIClient) UserWebRequestStorageVault(StorageProvider string, SelfAddress *string) (*RequestStorageVaultResponseMessage, error)

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.

- Params StorageProvider: ID for the storage template destination SelfAddress: (Optional) The external URL for this server. Used to resolve conflicts

func (*CometAPIClient) UserWebRequestStorageVaultProviders ¶

func (this *CometAPIClient) UserWebRequestStorageVaultProviders() (map[string]string, error)

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.

func (*CometAPIClient) UserWebSessionRevoke ¶

func (this *CometAPIClient) UserWebSessionRevoke() (*CometAPIResponseMessage, error)

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.

func (*CometAPIClient) UserWebSessionStart ¶

func (this *CometAPIClient) UserWebSessionStart() (*SessionKeyRegeneratedResponse, error)

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.

func (*CometAPIClient) UserWebSetProfileHash ¶

func (this *CometAPIClient) UserWebSetProfileHash(ProfileData UserProfileConfig, ProfileHash string) (*CometAPIResponseMessage, error)

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.

- Params ProfileData: Updated account profile ProfileHash: Previous account profile hash