API Reference ¶
API Methods ¶
AdminAccountProperties: Retrieve properties about the current admin account ¶
Some key parameters are obscured, but the obscured values are safely recognised by the corresponding AdminAccountSetProperties API.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/properties - Return type: AdminAccountPropertiesResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminAccountRegenerateTotp: Generate a new TOTP secret ¶
The secret is returned as a data-uri image of a QR code. The new secret is immediately applied to the current admin account.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/regenerate-totp - Return type: TotpRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminAccountSessionRevoke: Revoke a session key (log out) ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/session-revoke - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminAccountSessionStart: Generate a session key (log in) ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/session-start - Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
SelfAddress |
string | External URL of this server (used for U2F AppID) (Optional) |
AdminAccountSessionStartAsUser: Generate a session key for an end-user (log in as end-user) ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/session-start-as-user(>= 19.6.8) - Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Target account username |
AdminAccountSetProperties: Update settings for your own admin account ¶
Updating your account password requires you to supply your current password. To set a new plaintext password, use a password format of 0 (PASSWORD_FORMAT_PLAINTEXT). This API does not currently allow you to modify your TOTP secret or IP whitelist.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/set-properties(>= 18.9.9) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Security |
AdminSecurityOptions (JSON) | Updated account properties |
AdminAccountU2fRequestRegistrationChallenge: Register a new FIDO U2F token ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/u2f/request-registration-challenge - Return type: U2FRegistrationChallengeResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
SelfAddress |
string | External URL of this server, used as U2F AppID and Facet |
AdminAccountU2fSubmitChallengeResponse: Register a new FIDO U2F token ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/u2f/submit-challenge-response - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
U2FChallengeID |
string | Associated value from AdminAccountU2fRequestRegistrationChallenge API |
U2FClientData |
string | U2F response data supplied by hardware token |
U2FRegistrationData |
string | U2F response data supplied by hardware token |
U2FVersion |
string | U2F response data supplied by hardware token |
Description |
string | Optional description of the token |
AdminAccountValidateTotp: Validate the TOTP code before turning 2fa(TOTP) on ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/account/validate-totp - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TOTPCode |
string | Six-digit code after scanning barcode image |
AdminAddUser: Add a new user account ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/add-user - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | New account username |
TargetPassword |
string | New account password |
StoreRecoveryCode |
int | If set to 1, store and keep a password recovery code for the generated user (>= 18.3.9) (Optional) |
RequirePasswordChange |
int | If set to 1, require to reset password at the first login for the generated user (>= 20.3.4) (Optional) |
AdminAddUserFromProfile: Add a new user account (with all information) ¶
This allows you to create a new account and set all its properties at once (e.g. during account replication). Developers creating a signup form may find it simpler to use the AdminAddUser and AdminGetUserProfile / AdminSetUserProfile APIs separately.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/add-user-from-profile - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | New account username |
ProfileData |
UserProfileConfig (JSON) | New account profile |
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.
- Endpoint:
POST /api/v1/admin/admin-user/delete(>= 20.9.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | the username of the admin to be deleted |
AdminAdminUserList: List administrators ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/admin-user/list(>= 20.9.0) - Return type: List<AllowedAdminUser> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminAdminUserNew: Add a new administrator ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/admin-user/new(>= 20.9.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | the username for this new admin |
TargetPassword |
string | the password for this new admin user |
TargetOrgID |
string | provide the organization ID for this user, it will default to the org of the authenticating user otherwise (Optional) |
AdminBrandingAvailablePlatforms: List available software download platforms ¶
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/available-platforms(>= 18.12.2) - Return type: Dictionary<int, AvailableDownload> (JSON), or CometAPIResponseMessage (JSON) on failure
AdminBrandingGenerateClientByPlatform: Download software ¶
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/by-platform(>= 18.12.2) - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Platform |
int | The selected download platform, from the AdminBrandingAvailablePlatforms API |
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
AdminBrandingGenerateClientLinuxgeneric: Download software (Linux Server .run) ¶
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/linuxgeneric - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/update-software/linuxgeneric("UpdateSoftwareLinuxgeneric")
AdminBrandingGenerateClientMacosX8664: Download software (macOS x86_64 pkg) ¶
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/macos-x86_64 - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/update-software/macos-x86_64("UpdateSoftwareMacosX8664")
AdminBrandingGenerateClientTest: Check if a software download is available ¶
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/test(>= 19.12.2) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Platform |
int | The selected download platform, from the AdminBrandingAvailablePlatforms API |
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
AdminBrandingGenerateClientWindowsAnycpuExe: Download software update (Windows AnyCPU exe) ¶
The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-anycpu-exe - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 2 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/update-software/windows("UpdateSoftwareWindows")POST /api/v1/update-software("UpdateSoftware")
AdminBrandingGenerateClientWindowsAnycpuZip: Download software (Windows AnyCPU zip) ¶
The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-anycpu-zip - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 2 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/branding/generate-client/windows("AdminBrandingGenerateClientWindows")POST /api/v1/admin/branding/generate-client("AdminBrandingGenerateClient")
AdminBrandingGenerateClientWindowsX8632Exe: Download software update (Windows x86_32 exe) ¶
The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-x86_32-exe - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/update-software/windows-x86_32("UpdateSoftwareWindowsX8632")
AdminBrandingGenerateClientWindowsX8632Zip: Download software (Windows x86_32 zip) ¶
The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-x86_32-zip - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/branding/generate-client/windows-x86_32("AdminBrandingGenerateClientWindowsX8632")
AdminBrandingGenerateClientWindowsX8664Exe: Download software update (Windows x86_64 exe) ¶
The exe endpoints are not recommended for end-users, as they may not be able to provide a codesigned installer if no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-x86_64-exe - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/update-software/windows-x86_64("UpdateSoftwareWindowsX8664")
AdminBrandingGenerateClientWindowsX8664Zip: Download software (Windows x86_64 zip) ¶
The zip endpoints are recommended for end-users, as they may be able to provide a codesigned installer even when no custom codesigning certificate is present.
This API requires administrator authentication credentials, unless the server is configured to allow unauthenticated software downloads. This API requires the Software Build Role to be enabled. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/branding/generate-client/windows-x86_64-zip - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
SelfAddress |
string | The external URL of this server, used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/branding/generate-client/windows-x86_64("AdminBrandingGenerateClientWindowsX8664")
AdminBulletinSubmit: Send an email bulletin to all users ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/bulletin/submit - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Subject |
string | Bulletin subject line |
Content |
string | Bulletin message content |
AdminConstellationLastReport: Get Constellation bucket usage report (cached) ¶
You must supply administrator authentication credentials to use this API. This API 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.
- Endpoint:
POST /api/v1/admin/constellation/last-report - Return type: ConstellationCheckReport (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/overseer/last-report("AdminOverseerLastReport")
AdminConstellationNewReport: Get Constellation bucket usage report (regenerate) ¶
You must supply administrator authentication credentials to use this API. This API 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.
- Endpoint:
POST /api/v1/admin/constellation/new-report - Return type: ConstellationCheckReport (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/overseer/new-report("AdminOverseerNewReport")
AdminConstellationPruneNow: Prune unused buckets ¶
You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. This API requires the Constellation Role to be enabled.
- Endpoint:
POST /api/v1/admin/constellation/prune-now - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/overseer/prune-now("AdminOverseerPruneNow")
AdminConstellationStatus: Get Constellation status ¶
You must supply administrator authentication credentials to use this API. This API 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.
- Endpoint:
POST /api/v1/admin/constellation/status - Return type: ConstellationStatusAPIResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/overseer/status("AdminOverseerStatus")
AdminCreateInstallToken: Create token for silent installation (Windows only) ¶
Provide the installation token to silently install the client on windows install.exe /TOKEN=<installtoken>
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/create-install-token(>= 20.9.0) - Return type: InstallTokenResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
TargetPassword |
string | Selected account password |
Server |
string | External URL of the authentication server that is different from the current server (Optional) |
AdminDeleteUser: Delete user account ¶
This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role. Any stored data can not be decrypted without the user profile. Misuse can cause data loss! This also allows to uninstall software from active devices under the user account
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/delete-user - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
UninstallConfig |
UninstallConfig (JSON) | Uninstall software configuration (>= 20.3.5) (Optional) |
AdminDisableUserTotp: Disable user account 2FA(TOTP) authentication ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/disable-user-totp(>= 20.6.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
AdminDispatcherApplyRetentionRules: Instruct a live connected device to apply retention rules now ¶
This command is understood by Comet Backup 17.6.9 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/apply-retention-rules(>= 17.6.9) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault GUID |
AdminDispatcherDeepverifyStorageVault: Instruct a live connected device to deeply verify Storage Vault content ¶
This command is understood by Comet Backup 18.8.2 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/deepverify-storage-vault(>= 18.8.2) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault GUID |
AdminDispatcherDeleteSnapshot: Instruct a live connected device to delete a stored snapshot ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/delete-snapshot(>= 19.12.2) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
DestinationID |
string | The Storage Vault GUID |
SnapshotID |
string | The backup job snapshot ID to delete |
AdminDispatcherDeleteSnapshots: Instruct a live connected device to delete multiple stored snapshots ¶
The target device must be running Comet 20.9.10 or later.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/delete-snapshots(>= 20.9.10) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
DestinationID |
string | The Storage Vault GUID |
SnapshotIDs |
List<string> (JSON) | The backup job snapshot IDs to delete |
AdminDispatcherDropConnection: Disconnect a live connected device ¶
The device will almost certainly attempt to reconnect.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/drop-connection - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherImportApply: Instruct a live connected device to import settings from an installed product ¶
This command is understood by Comet Backup 17.12.0 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/import-apply(>= 17.12.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
ImportSourceID |
string | The selected import source, as found by the AdminDispatcherRequestImportSources API |
AdminDispatcherKillProcess: Instruct a live connected device to disconnect ¶
The device will terminate its live-connection process and will not reconnect.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/kill-process - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherListActive: List live connected devices ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/list-active - Return type: Dictionary<string, LiveUserConnection> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminDispatcherRefetchProfile: Instruct a live connected device to refresh their profile ¶
This command is understood by Comet Backup 17.12.0 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/refetch-profile(>= 17.12.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherReindexStorageVault: Instruct a live connected device to rebuild Storage Vault indexes now ¶
This command is understood by Comet Backup 18.6.9 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/reindex-storage-vault(>= 18.6.9) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault GUID |
AdminDispatcherRequestBrowseDiskDrives: Request a list of physical disk drive information from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-browse-disk-drives(>= 20.6.1) - Return type: BrowseDiskDrivesResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherRequestBrowseExchangeEdb: Request a list of Exchange EDB databases from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-browse-exchange-edb(>= 20.6.1) - Return type: BrowseEDBResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherRequestBrowseHyperv: Request a list of Hyper-V virtual machines from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-browse-hyperv(>= 20.6.1) - Return type: BrowseHVResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherRequestBrowseVssAaw: Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-browse-vss-aaw(>= 20.6.1) - Return type: BrowseVSSResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
AdminDispatcherRequestFilesystemObjects: Request a list of filesystem objects from a live connected device ¶
The device must have granted the administrator permission to view its filenames.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-filesystem-objects(>= 20.3.2) - Return type: List<StoredObject> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Path |
string | Browse objects inside this path. If empty or not present, returns the top-level device paths (Optional) |
AdminDispatcherRequestImportSources: Request a list of import sources from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-import-sources - Return type: DispatcherAdminSourcesResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
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.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-stored-objects(>= 19.3.0) - Return type: DispatcherStoredObjectsResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault ID |
SnapshotID |
string | The selected backup job snapshot |
TreeID |
string | Browse objects inside subdirectory of backup snapshot (Optional) |
AdminDispatcherRequestVaultSnapshots: Request a list of Storage Vault snapshots from a live connected device ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/request-vault-snapshots - Return type: DispatcherVaultSnapshotsResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault ID |
AdminDispatcherRunBackup: Instruct a live connected device to run a scheduled backup ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/run-backup - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
BackupRule |
string | The schedule GUID |
AdminDispatcherRunBackupCustom: Instruct a live connected device to run a backup ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/run-backup-custom - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Source |
string | The Protected Item GUID |
Destination |
string | The Storage Vault GUID |
Options |
BackupJobAdvancedOptions (JSON) | Extra job parameters (>= 19.3.6) (Optional) |
AdminDispatcherRunRestore: Instruct a live connected device to perform a local restore ¶
This command is understood by Comet Backup 17.9.3 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/run-restore(>= 17.9.3) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Path |
string | The local path to restore to |
Source |
string | The Protected Item ID |
Destination |
string | The Storage Vault ID |
Snapshot |
string | If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair (Optional) |
Paths |
List<string> (JSON) | If present, restore these paths only. Otherwise, restore all data (>= 19.3.0) (Optional) |
AdminDispatcherRunRestoreCustom: Instruct a live connected device to perform a local restore ¶
This command is understood by Comet Backup 18.6.0 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/run-restore-custom(>= 18.6.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Source |
string | The Protected Item ID |
Destination |
string | The Storage Vault ID |
Options |
RestoreJobAdvancedOptions (JSON) | Restore targets |
Snapshot |
string | If present, restore a specific snapshot. Otherwise, restore the latest snapshot for the selected Protected Item + Storage Vault pair (Optional) |
Paths |
List<string> (JSON) | If present, restore these paths only. Otherwise, restore all data (Optional) |
AdminDispatcherUninstallSoftware: Instruct a live connected device to self-uninstall the software ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/uninstall-software(>= 20.3.5) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
RemoveConfigFile |
bool (JSON) | Determine if the config.dat file will be deleted at the same time |
AdminDispatcherUnlock: Instruct a live connected device to remove lock files from a Storage Vault ¶
Misuse can cause data loss! This command is understood by Comet Backup 17.9.4 and newer.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/unlock(>= 17.9.4) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
Destination |
string | The Storage Vault GUID |
AdminDispatcherUpdateLoginUrl: Instruct a live connected device to update its login server URL ¶
The device will attempt to connect to the new Auth Role Comet Server using its current username and password. If the test connection succeeds, the device migrates its saved connection settings and live connections to the new server. If the device is not registered on the new URL, or if the credentials are incorrect, the device remains on the current Auth Role server.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/update-login-url(>= 20.3.8) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
NewURL |
string | The new external URL of this server |
AdminDispatcherUpdateSoftware: Instruct a live connected device to download a software update ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled. This API requires the Software Build Role to be enabled.
- Endpoint:
POST /api/v1/admin/dispatcher/update-software - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetID |
string | The live connection GUID |
SelfAddress |
string | The external URL of this server, used to resolve conflicts (>= 19.3.11) (Optional) |
AdminGetJobLog: Get the report log entries for a single job, in plaintext format ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-job-log - Return type: Body in
text/plainencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
JobID |
string | Selected job ID |
AdminGetJobLogEntries: Get the report log entries for a single job ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-job-log-entries(>= 20.6.8) - Return type: List<JobEntry> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
JobID |
string | Selected job ID |
AdminGetJobProperties: Get properties of a single job ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-job-properties - Return type: BackupJobDetail (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
JobID |
string | Selected job ID |
AdminGetJobsAll: Get jobs (All) ¶
The jobs are returned in an unspecified order.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-jobs-all - Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminGetJobsForCustomSearch: Get jobs (for custom search) ¶
The jobs are returned in an unspecified order.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-jobs-for-custom-search(>= 18.9.2) - Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Query |
SearchClause (JSON) | (No description available) |
AdminGetJobsForDateRange: Get jobs (for date range) ¶
The jobs are returned in an unspecified order.
If the Start parameter is later than End, they will be swapped.
This API will return all jobs that either started or ended within the supplied range.
Incomplete jobs have an end time of 0. You can use this API to find incomplete jobs by setting both Start and End to 0.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-jobs-for-date-range - Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Start |
int | Timestamp (Unix) |
End |
int | Timestamp (Unix) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/get-jobs-for-daterange("AdminGetJobsForDaterange")
AdminGetJobsForUser: Get jobs (for user) ¶
The jobs are returned in an unspecified order.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-jobs-for-user - Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected username |
AdminGetJobsRecent: Get jobs (Recent and incomplete) ¶
The jobs are returned in an unspecified order.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-jobs-recent - Return type: List<BackupJobDetail> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminGetUserProfile: Get user account profile ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-user-profile - Return type: UserProfileConfig (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
AdminGetUserProfileAndHash: Get user account profile (atomic) ¶
The resulting hash parameter can be passed to the corresponding update API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-user-profile-and-hash - Return type: GetProfileAndHashResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
AdminGetUserProfileHash: Get user account profile (hash) ¶
The profile hash can be used to determine if a user account profile has changed. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/get-user-profile-hash - Return type: GetProfileHashResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
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.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/job/cancel(>= 18.3.5) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Username |
JobID |
string | Job ID |
AdminListUsers: List all user accounts ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/list-users - Return type: List<string> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminListUsersFull: List all user account profiles ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/list-users-full - Return type: Dictionary<string, UserProfileConfig> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaBrandingConfigGet: Get Branding configuration ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/branding-config/get(>= 20.6.0) - Return type: ServerConfigOptionsBrandingFragment (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaBrandingConfigSet: Set Branding configuration ¶
Note that file resources must be provided using a resource URI I.E "resource://05ba0b90ee66bda433169581188aba8d29faa938f9464cccd651a02fdf2e5b57". See AdminMetaResourceNew for the API documentation to create new file resources.
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/branding-config/set(>= 20.6.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
BrandingConfig |
BrandingOptions (JSON) | Updated configuration content |
AdminMetaBuildConfigGet: Get Software Build Role configuration ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/build-config/get(>= 20.6.0) - Return type: ServerConfigOptionsSoftwareBuildRoleFragment (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaBuildConfigSet: Set Build Role configuration ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/build-config/set(>= 20.6.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
SoftwareBuildRoleConfig |
SoftwareBuildRoleOptions (JSON) | Updated configuration content |
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.
- Endpoint:
POST /api/v1/admin/meta/list-available-log-days - Return type: List<int> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaReadLogs: Get log file content ¶
On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2. This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/meta/read-logs - Return type: Body in
text/plainencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Log |
int | A log day, selected from the options returned by the Get Log Files API |
AdminMetaRemoteStorageVaultGet: Get Requesting Remote Storage Vault Config ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/remote-storage-vault/get(>= 20.6.0) - Return type: List<RemoteStorageOption> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaRemoteStorageVaultSet: Set Requestable Remote Storage Vault options ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/remote-storage-vault/set(>= 20.6.0) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
RemoteStorageOptions |
List<RemoteStorageOption> (JSON) | Updated configuration content |
AdminMetaResourceGet: Get a resource file ¶
Resources are used to upload files within the server configuration.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/resource/get - Return type: Body in
application/octet-streamencoding, or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Hash |
string | The resource identifier |
AdminMetaResourceNew: Upload a resource file ¶
Resources are used to upload files within the server configuration. The resulting resource ID is autogenerated. The lifespan of an uploaded resource is undefined. Resources may be deleted automatically, but it should remain available until the next call to AdminMetaServerconfigSet, and will remain available for as long as it is referenced by the server configuration.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/resource/new - Encoding:
multipart/form-data - Return type: AdminResourceResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Header X-Comet-Admin-Username |
string | Admin account name |
Header X-Comet-Admin-AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' (Optional) |
Header X-Comet-Admin-Password |
string | Admin account password (Optional) |
Header X-Comet-Admin-SessionKey |
string | Admin session key (Optional) |
Header X-Comet-Admin-TOTP |
string | Admin current TOTP code (Optional) |
Header X-Comet-Admin-U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
upload |
string | The uploaded file contents, as a multipart/form-data part. |
AdminMetaRestartService: Restart server ¶
The Comet Server process will exit. The service manager should restart the server automatically.
Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/restart-service - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaSendTestEmail: Send a test email message ¶
This allows the Comet Server web interface to support testing different email credentials during setup.
You must supply administrator authentication credentials to use this API. 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.
- Endpoint:
POST /api/v1/admin/meta/send-test-email - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
EmailOptions |
EmailOptions (JSON) | Updated configuration content |
Recipient |
string | Target email address to send test email |
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.
- Endpoint:
POST /api/v1/admin/meta/server-config/get - Return type: ServerConfigOptions (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaServerConfigNetworkInterfaces: List the available network interfaces on the PC running Comet Server ¶
Any IPv6 addresses are listed in compressed form without square-brackets.
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/meta/server-config/network-interfaces(>= 19.6.0) - Return type: List<string> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaServerConfigSet: Set server configuration ¶
The Comet Server process will exit. The service manager should restart the server automatically.
Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/meta/server-config/set - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Config |
ServerConfigOptions (JSON) | Updated configuration content |
AdminMetaShutdownService: Shut down server ¶
The Comet Server process will exit.
Prior to 18.9.2, this API terminated the server immediately without returning a response. In 18.9.2 and later, it returns a successful response before shutting down.
You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization. Access to this API may be prevented on a per-administrator basis.
- Endpoint:
POST /api/v1/admin/meta/shutdown-service - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaSoftwareUpdateNews: Get software update news from the software provider ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/software-update-news - Return type: SoftwareUpdateNewsResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaStats: Get Comet Server historical statistics ¶
The returned key-value map is not necessarily ordered. Client-side code should sort the result before display.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/stats - Return type: Dictionary<int, StatResult> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Simple |
bool (JSON) | Remove redundant statistics |
AdminMetaVersion: Get server properties ¶
Retrieve the version number and basic properties about the server.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/version - Return type: ServerMetaVersionInfo (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaWebhookOptionsGet: Get the server webhook configuration ¶
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/webhook-options/get(>= 20.6.1) - Return type: Dictionary<string, WebhookOption> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminMetaWebhookOptionsSet: Update the server webhook configuration ¶
Calling this endpoint will interrupt any messages currently queued for existing webhook destinations.
You must supply administrator authentication credentials to use this API.
- Endpoint:
POST /api/v1/admin/meta/webhook-options/set(>= 20.6.1) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
WebhookOptions |
Dictionary<string, WebhookOption> (JSON) | The replacement webhook target options. |
AdminNewsGetAll: Get News entries (Admin) ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/news/get-all - Return type: Dictionary<string, NewsEntry> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminNewsRemove: Remove news item ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/news/remove - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
NewsItem |
string | Selected news item GUID |
AdminNewsSubmit: Submit news item ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/news/submit - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
NewsContent |
string | Content of news item |
AdminOrganizationDelete: Delete an organization and all related users ¶
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.
- Endpoint:
POST /api/v1/admin/organization/delete(>= 20.9.0) - Return type: OrganizationResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
OrganizationID |
string | (No description available) (Optional) |
UninstallConfig |
UninstallConfig (JSON) | Uninstall software configuration (Optional) |
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.
- Endpoint:
POST /api/v1/admin/organization/list(>= 20.9.0) - Return type: Dictionary<string, Organization> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminOrganizationSet: Create or Update an Organization ¶
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.
- Endpoint:
POST /api/v1/admin/organization/set(>= 20.9.0) - Return type: OrganizationResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
OrganizationID |
string | (No description available) (Optional) |
Organization |
Organization (JSON) | (No description available) (Optional) |
AdminPoliciesDelete: Delete an existing policy object ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/delete(>= 18.3.11) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
PolicyID |
string | The policy ID to update or create |
AdminPoliciesGet: Retrieve a single policy object ¶
A hash is also returned, to allow atomic modification operations.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/get(>= 18.3.11) - Return type: GetGroupPolicyResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
PolicyID |
string | The policy ID to retrieve |
AdminPoliciesList: List all policy object names ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/list(>= 18.3.11) - Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminPoliciesListFull: Get all policy objects ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/list-full(>= 18.3.11) - Return type: Dictionary<string, GroupPolicy> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminPoliciesNew: Create a new policy object ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/new(>= 18.3.11) - Return type: CreateGroupPolicyResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Policy |
GroupPolicy (JSON) | The policy data |
AdminPoliciesSet: Update an existing policy object ¶
An optional hash may be used, to ensure the modification was atomic. This API can also be used to create a new policy object with a specific hash.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/policies/set(>= 18.3.11) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
PolicyID |
string | The policy ID to update or create |
Policy |
GroupPolicy (JSON) | The policy data |
CheckPolicyHash |
string | An atomic verification hash as supplied by the AdminPoliciesGet API (Optional) |
AdminPreviewUserEmailReport: Preview an email report for a customer ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/preview-user-email-report - Return type: EmailReportGeneratedPreview (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
EmailReportConfig |
EmailReportConfig (JSON) | Email report configuration to preview |
EmailAddress |
string | Email address that may be included in the report body (>= 20.3.3) (Optional) |
AdminReplicationState: Get Replication status ¶
You must supply administrator authentication credentials to use this API. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/replication/state - Return type: List<ReplicatorStateAPIResponse> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/storage/replication/state("AdminStorageReplicationState")
AdminRequestStorageVault: Request a new Storage Vault on behalf of a user ¶
This action does not respect the "Prevent creating new Storage Vaults (via Request)" policy setting. New Storage Vaults can be requested regardless of the policy setting. Prior to Comet 19.8.0, the response type was CometAPIResponseMessage (i.e. no DestinationID field in response).
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/request-storage-vault(>= 18.6.2) - Return type: RequestStorageVaultResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | The user to receive the new Storage Vault |
StorageProvider |
string | ID for the Requestable destination |
SelfAddress |
string | The external URL for this server. Used to resolve conflicts (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/request-bucket(>= 1.0.0) ("AdminRequestBucket")
AdminRequestStorageVaultProviders: Get the available options for Requesting a Storage Vault ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/request-storage-vault-providers(>= 18.6.2) - Return type: Dictionary<string, string> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/admin/request-bucket-options(>= 1.0.0) ("AdminRequestBucketOptions")
AdminResetUserPassword: Reset user account password ¶
The user account must have a recovery code present. A new replacement recovery code will be generated automatically.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/reset-user-password - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
NewPassword |
string | New account password |
OldPassword |
string | Old account password (optional) |
AdminRevokeDevice: Revoke device from user account ¶
It's possible to simply remove the Device section from the user's profile, however, using this dedicated API will also gracefully handle live connections.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/revoke-device - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
TargetDevice |
string | Selected Device ID |
AdminSetUserProfile: Modify user account profile ¶
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/set-user-profile - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
ProfileData |
UserProfileConfig (JSON) | Modified user profile |
AdminSetUserProfileHash: Modify user account profile (atomic) ¶
The hash parameter can be determined from the corresponding API, to atomically ensure that no changes occur between get/set operations. The hash format is not publicly documented and may change in a future server version. Use server APIs to retrieve current hash values.
You must supply administrator authentication credentials to use this API. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/admin/set-user-profile-hash - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
TargetUser |
string | Selected account username |
ProfileData |
UserProfileConfig (JSON) | Modified user profile |
RequireHash |
string | Previous hash parameter |
AdminStorageBucketProperties: Retrieve properties for a single bucket ¶
This API can also be used to refresh the size measurement for a single bucket by passing a valid AfterTimestamp parameter.
You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.
- Endpoint:
POST /api/v1/admin/storage/bucket-properties(>= 20.9.4) - Return type: BucketProperties (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
BucketID |
string | Bucket ID |
AfterTimestamp |
int | Allow a stale size measurement if it is at least as new as the supplied Unix timestamp. Timestamps in the future may produce a result clamped down to the Comet Server's current time. If not present, the size measurement may be arbitrarily stale. (Optional) |
AdminStorageDeleteBucket: Delete a bucket ¶
All data will be removed from the server. Misuse can cause data loss!
You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.
- Endpoint:
POST /api/v1/admin/storage/delete-bucket - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
BucketID |
string | Selected bucket name |
AdminStorageFreeSpace: Retrieve available space metrics ¶
You must supply administrator authentication credentials to use this API. Access to this API may be prevented on a per-administrator basis. This API requires the Storage Role to be enabled. This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
- Endpoint:
POST /api/v1/admin/storage/free-space(>= 19.12.4) - Return type: StorageFreeSpaceInfo (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
BucketID |
string | (This parameter is not used) (Optional) |
AdminStorageListBuckets: List all buckets ¶
You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.
- Endpoint:
POST /api/v1/admin/storage/list-buckets - Return type: Dictionary<string, BucketProperties> (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
AdminStorageRegisterBucket: Create a new bucket ¶
Leave the Set* parameters blank to generate a bucket with random credentials, or, supply a pre-hashed password for zero-knowledge operations. Any auto-generated credentials are returned in the response message.
You must supply administrator authentication credentials to use this API. This API requires the Storage Role to be enabled.
- Endpoint:
POST /api/v1/admin/storage/register-bucket - Return type: AddBucketResponseMessage (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
SetBucketValue |
string | Bucket ID (Optional) |
SetKeyHashFormat |
string | Bucket key hashing format (Optional) |
SetKeyHashValue |
string | Bucket key hash (Optional) |
SetOrganizationID |
string | Target organization ID (>= 20.9.0) (Optional) |
AdminUpdateCampaignStart: Start a new software update campaign ¶
You must supply administrator authentication credentials to use this API. This API is only available for 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.
- Endpoint:
POST /api/v1/admin/update-campaign/start(>= 17.9.6) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
Options |
UpdateCampaignOptions (JSON) | Configure targets for the software update campaign |
AdminUpdateCampaignStatus: Get current campaign status ¶
You must supply administrator authentication credentials to use this API. This API is only available for 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.
- Endpoint:
POST /api/v1/admin/update-campaign/status(>= 17.9.6) - Return type: UpdateCampaignStatus (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | Admin account name |
AuthType |
string | Either 'Password', 'PasswordTOTP', 'PasswordU2F', 'TOTP', or 'SessionKey' |
Password |
string | Admin account password (Optional) |
SessionKey |
string | Admin session key (Optional) |
TOTP |
string | Admin current TOTP code (Optional) |
U2FSign |
U2FSignResponse (JSON) | Admin U2F challenge signature (Optional) |
HybridSessionStart: Generate a session key (log in) ¶
This hybrid API allows you to log in to the Comet Server as either an administrator or end-user account. This API behaves like either AdminAccountSessionStart or UserWebSessionStart, depending on what the supplied credentials were valid for.
- Endpoint:
POST /api/v1/hybrid/session/start(>= 18.12.3) - Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure
UserWebSessionRevoke: Revoke a session key (log out) ¶
You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/user/web/session/revoke(>= 19.6.3) - Return type: CometAPIResponseMessage (JSON)
| Parameter | Type | Description |
|---|---|---|
Username |
string | User account name |
AuthType |
string | Either 'Password', 'LKey', or 'SessionKey' |
Password |
string | User account password (Optional) |
LKey |
string | User account L-key (Optional) |
SessionKey |
string | User session key (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/user/session/revoke("UserSessionRevoke")
UserWebSessionStart: Generate a session key (log in) ¶
You must supply user authentication credentials to use this API, and the user account must be authorized for web access. This API requires the Auth Role to be enabled.
- Endpoint:
POST /api/v1/user/web/session/start(>= 19.6.3) - Return type: SessionKeyRegeneratedResponse (JSON), or CometAPIResponseMessage (JSON) on failure
| Parameter | Type | Description |
|---|---|---|
Username |
string | User account name |
AuthType |
string | Either 'Password', 'LKey', or 'SessionKey' |
Password |
string | User account password (Optional) |
LKey |
string | User account L-key (Optional) |
SessionKey |
string | User session key (Optional) |
This API can be accessed via an additional 1 endpoint(s) for backward compatibility. These aliases will be maintained indefinitely, but new applications should not use them.
POST /api/v1/user/session/start("UserSessionStart")
Constant values ¶
APPLICATION ¶
| Name | Type | Value | Comment |
|---|---|---|---|
APPLICATION_VERSION |
string | "20.9.12" |
|
APPLICATION_VERSION_MAJOR |
int | 20 |
|
APPLICATION_VERSION_MINOR |
int | 9 |
|
APPLICATION_VERSION_REVISION |
int | 12 |
DEFAULT ¶
| Name | Type | Value | Comment |
|---|---|---|---|
DEFAULT_LANGUAGE |
string | "en_US" |
LanguageCode |
DEFAULT_TIMEZONE |
string | "UTC" |
DESTINATION ¶
| Name | Type | Value | Comment |
|---|---|---|---|
DESTINATION_SFTP_AUTHMODE_NATIVE |
int | 0 |
SftpAuthMode |
DESTINATION_SFTP_AUTHMODE_PASSWORD |
int | 1 |
SftpAuthMode |
DESTINATION_SFTP_AUTHMODE_PRIVATEKEY |
int | 2 |
SftpAuthMode |
DESTINATIONTYPE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
DESTINATIONTYPE___INVALID |
int | 0 |
|
DESTINATIONTYPE_S3 |
int | 1000 |
|
DESTINATIONTYPE_SFTP |
int | 1001 |
|
DESTINATIONTYPE_LOCALCOPY |
int | 1002 |
|
DESTINATIONTYPE_COMET |
int | 1003 |
|
DESTINATIONTYPE_FTP |
int | 1004 |
|
DESTINATIONTYPE_AZUREBLOB |
int | 1005 |
|
DESTINATIONTYPE_SPANNED |
int | 1006 |
|
DESTINATIONTYPE_SWIFT |
int | 1007 |
|
DESTINATIONTYPE_B2 |
int | 1008 |
|
DESTINATIONTYPE_LATEST |
int | 1100 |
|
DESTINATIONTYPE_ALL |
int | 1101 |
EMAIL ¶
| Name | Type | Value | Comment |
|---|---|---|---|
EMAIL_WORKER_STATE_NOT_STARTED |
int | 0 |
|
EMAIL_WORKER_STATE_STARTED |
int | 1 |
|
EMAIL_WORKER_STATE_CALCULATING |
int | 2 |
|
EMAIL_WORKER_STATE_WAITING |
int | 3 |
|
EMAIL_WORKER_STATE_SENDING |
int | 4 |
|
EMAIL_DELIVERY_NONE |
string | "" |
EmailDeliveryType |
EMAIL_DELIVERY_MX_DIRECT |
string | "builtin" |
EmailDeliveryType |
EMAIL_DELIVERY_SMTP |
string | "smtp" |
EmailDeliveryType |
EMAIL_DELIVERY_SMTP_SSL |
string | "smtp-ssl" |
EmailDeliveryType |
EMAIL_DELIVERY_BUILTIN |
string | EMAIL_DELIVERY_MX_DIRECT |
EmailDeliveryType: Legacy alias |
EMAILREPORTTYPE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
EMAILREPORTTYPE_IMMEDIATE |
int | 0 |
EmailReportType |
EMAILREPORTTYPE_SUMMARY |
int | 1 |
EmailReportType |
ENCRYPTIONMETHOD ¶
| Name | Type | Value | Comment |
|---|---|---|---|
ENCRYPTIONMETHOD_UNCONFIGURED |
int | 0 |
ENGINE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
ENGINE_BUILTIN_FILE |
string | "engine1/file" |
|
ENGINE_BUILTIN_STDOUT |
string | "engine1/stdout" |
|
ENGINE_BUILTIN_MYSQL |
string | "engine1/mysql" |
|
ENGINE_BUILTIN_SYSTEMSTATE |
string | "engine1/systemstate" |
|
ENGINE_BUILTIN_MSSQL |
string | "engine1/mssql" |
|
ENGINE_BUILTIN_WINDOWSSYSTEM |
string | "engine1/windowssystem" |
|
ENGINE_BUILTIN_EXCHANGEEDB |
string | "engine1/exchangeedb" |
|
ENGINE_BUILTIN_VSSWRITER |
string | "engine1/vsswriter" |
|
ENGINE_BUILTIN_HYPERV |
string | "engine1/hyperv" |
|
ENGINE_BUILTIN_WINDISK |
string | "engine1/windisk" |
|
ENGINE_BUILTIN_MONGODB |
string | "engine1/mongodb" |
FTPS ¶
| Name | Type | Value | Comment |
|---|---|---|---|
FTPS_MODE_PLAINTEXT |
int | 0 |
FtpsModeType |
FTPS_MODE_IMPLICIT |
int | 1 |
FtpsModeType |
FTPS_MODE_EXPLICIT |
int | 2 |
FtpsModeType |
JOB ¶
| Name | Type | Value | Comment |
|---|---|---|---|
JOB_CLASSIFICATION__MIN |
int | 4000 |
JobClassification |
JOB_CLASSIFICATION_UNKNOWN |
int | 4000 |
JobClassification |
JOB_CLASSIFICATION_BACKUP |
int | 4001 |
JobClassification |
JOB_CLASSIFICATION_RESTORE |
int | 4002 |
JobClassification |
JOB_CLASSIFICATION_RETENTION |
int | 4003 |
JobClassification: Automatic or manual retention cleaning |
JOB_CLASSIFICATION_UNLOCK |
int | 4004 |
JobClassification: Another process needed exclusive Vault access ( for retention) but the process This task cleans up exclusive |
JOB_CLASSIFICATION_DELETE_CUSTOM |
int | 4005 |
JobClassification: A specific snapshot has been deleted via the Restore |
JOB_CLASSIFICATION_REMEASURE |
int | 4006 |
JobClassification: Explicitly re-measuring the size of a Vault (right-click > Advanced menu). |
JOB_CLASSIFICATION_UPDATE |
int | 4007 |
JobClassification: Software update |
JOB_CLASSIFICATION_IMPORT |
int | 4008 |
JobClassification |
JOB_CLASSIFICATION_REINDEX |
int | 4009 |
JobClassification: Repair indexes |
JOB_CLASSIFICATION_DEEPVERIFY |
int | 4010 |
JobClassification |
JOB_CLASSIFICATION_UNINSTALL |
int | 4011 |
JobClassification: Software uninstall |
JOB_CLASSIFICATION__MAX |
int | 4999 |
JobClassification |
JOB_STATUS_STOP_SUCCESS__MIN |
int | 5000 |
JobStatus |
JOB_STATUS_STOP_SUCCESS |
int | 5000 |
JobStatus |
JOB_STATUS_STOP_SUCCESS__MAX |
int | 5999 |
JobStatus |
JOB_STATUS_RUNNING__MIN |
int | 6000 |
JobStatus |
JOB_STATUS_RUNNING_INDETERMINATE |
int | 6000 |
JobStatus: Unused |
JOB_STATUS_RUNNING_ACTIVE |
int | 6001 |
JobStatus |
JOB_STATUS_RUNNING_REVIVED |
int | 6002 |
JobStatus: A backup job that was marked as stopped or abandoned, but has somehow continued to run |
JOB_STATUS_RUNNING__MAX |
int | 6999 |
JobStatus |
JOB_STATUS_FAILED__MIN |
int | 7000 |
JobStatus |
JOB_STATUS_FAILED_TIMEOUT |
int | 7000 |
JobStatus |
JOB_STATUS_FAILED_WARNING |
int | 7001 |
JobStatus |
JOB_STATUS_FAILED_ERROR |
int | 7002 |
JobStatus |
JOB_STATUS_FAILED_QUOTA |
int | 7003 |
JobStatus |
JOB_STATUS_FAILED_SCHEDULEMISSED |
int | 7004 |
JobStatus |
JOB_STATUS_FAILED_CANCELLED |
int | 7005 |
JobStatus |
JOB_STATUS_FAILED_SKIPALREADYRUNNING |
int | 7006 |
JobStatus |
JOB_STATUS_FAILED_ABANDONED |
int | 7007 |
JobStatus |
JOB_STATUS_FAILED__MAX |
int | 7999 |
JobStatus |
LDAPSECURITYMETHOD ¶
| Name | Type | Value | Comment |
|---|---|---|---|
LDAPSECURITYMETHOD_PLAIN |
string | "plain" |
|
LDAPSECURITYMETHOD_LDAPS |
string | "ldaps" |
|
LDAPSECURITYMETHOD_STARTTLS |
string | "starttls" |
MACOSCODESIGN ¶
| Name | Type | Value | Comment |
|---|---|---|---|
MACOSCODESIGN_LEVEL_SIGN |
int | 0 |
MacOSCodesignLevel |
MACOSCODESIGN_LEVEL_SIGN_NOTARISE |
int | 1 |
MacOSCodesignLevel |
MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE |
int | 2 |
MacOSCodesignLevel |
MONGODB ¶
| Name | Type | Value | Comment |
|---|---|---|---|
MONGODB_DEFAULT_PORT |
int | 27017 |
MSSQL ¶
| Name | Type | Value | Comment |
|---|---|---|---|
MSSQL_AUTH_WINDOWS |
string | "windows" |
MSSQLAuthMode |
MSSQL_AUTH_NATIVE |
string | "native" |
MSSQLAuthMode |
MSSQL_METHOD_OLEDB_NATIVE |
string | "OLEDB_NATIVE" |
MSSQLMethod |
MSSQL_METHOD_OLEDB_32 |
string | "OLEDB_32" |
MSSQLMethod |
OS ¶
| Name | Type | Value | Comment |
|---|---|---|---|
OS_ANY |
int | 0 |
ExtraFileExclusionOSRestriction |
OS_ONLY_WINDOWS |
int | 1 |
ExtraFileExclusionOSRestriction |
OS_ONLY_WINDOWS_X8632 |
int | 2 |
ExtraFileExclusionOSRestriction |
OS_ONLY_WINDOWS_X8664 |
int | 3 |
ExtraFileExclusionOSRestriction |
OS_ONLY_MACOS |
int | 4 |
ExtraFileExclusionOSRestriction |
OS_ONLY_LINUX |
int | 5 |
ExtraFileExclusionOSRestriction |
PASSWORD ¶
| Name | Type | Value | Comment |
|---|---|---|---|
PASSWORD_FORMAT_PLAINTEXT |
int | 0 |
RELEASE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
RELEASE_CODENAME |
string | "Voyager" |
REMOTESERVER ¶
| Name | Type | Value | Comment |
|---|---|---|---|
REMOTESERVER_COMET |
string | "comet" |
RemoteServerType |
REMOTESERVER_LDAP |
string | "ldap" |
RemoteServerType |
REMOTESERVER_B2 |
string | "b2" |
RemoteServerType |
REMOTESERVER_WASABI |
string | "wasabi" |
RemoteServerType |
REPLICATOR ¶
| Name | Type | Value | Comment |
|---|---|---|---|
REPLICATOR_STATE_NONE |
int | 0 |
ReplicatorState |
REPLICATOR_STATE_FILE_LIST_WORKER_STARTED |
int | 1 |
ReplicatorState |
REPLICATOR_STATE_FILE_LIST_SYNC_RUNNING |
int | 2 |
ReplicatorState |
REPLICATOR_STATE_FILE_LIST_SYNC_FINISHED |
int | 4 |
ReplicatorState |
REPLICATOR_STATE_WORKERS_STARTED |
int | 8 |
ReplicatorState |
REPLICATOR_DISPLAYCLASS_STORAGE |
int | 100 |
ReplicatorDisplayClass |
REPLICATOR_DISPLAYCLASS_USER |
int | 101 |
ReplicatorDisplayClass |
RESTOREARCHIVEFORMAT ¶
| Name | Type | Value | Comment |
|---|---|---|---|
RESTOREARCHIVEFORMAT_TAR |
int | 0 |
RestoreArchiveFormat |
RESTOREARCHIVEFORMAT_TARGZ |
int | 1 |
RestoreArchiveFormat |
RESTOREARCHIVEFORMAT_ZIP |
int | 2 |
RestoreArchiveFormat |
RESTOREARCHIVEFORMAT_SQFS |
int | 3 |
RestoreArchiveFormat: SquashFS container |
RESTORETYPE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
RESTORETYPE_INVALID |
int | -1 |
RestoreType |
RESTORETYPE_FILE |
int | 0 |
RestoreType |
RESTORETYPE_NULL |
int | 1 |
RestoreType |
RESTORETYPE_PROCESS_PERFILE |
int | 2 |
RestoreType |
RESTORETYPE_PROCESS_ARCHIVE |
int | 3 |
RestoreType |
RESTORETYPE_WINDISK |
int | 4 |
RestoreType |
RESTORETYPE_FILE_ARCHIVE |
int | 5 |
RestoreType |
RESTORETYPE_PROCESS_TARBALL |
int | 3 |
RestoreType: RESTORETYPE_PROCESS_ARCHIVE |
RETENTIONMODE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
RETENTIONMODE_KEEP_EVERYTHING |
int | 801 |
RetentionMode: If this mode is set in a RetentionPolicy, then Ranges should be |
RETENTIONMODE_DELETE_EXCEPT |
int | 802 |
RetentionMode: Delete everything except for jobs matching the ranges in |
RETENTIONRANGE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
RETENTIONRANGE__LOWEST |
int | 900 |
RetentionRangeType |
RETENTIONRANGE_MOST_RECENT_X_JOBS |
int | 900 |
RetentionRangeType: Uses Jobs |
RETENTIONRANGE_NEWER_THAN_X |
int | 901 |
RetentionRangeType: Uses Timestamp |
RETENTIONRANGE_JOBS_SINCE |
int | 902 |
RetentionRangeType: Uses Days, Weeks, Months |
RETENTIONRANGE_FIRST_JOB_FOR_EACH_LAST_X_DAYS |
int | 903 |
RetentionRangeType: Uses Days |
RETENTIONRANGE__RESERVED904 |
int | 904 |
RetentionRangeType: Removed |
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_MONTHS |
int | 905 |
RetentionRangeType: Uses Months, MonthOffset |
RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKS |
int | 906 |
RetentionRangeType: Uses Weeks, WeekOffset |
RETENTIONRANGE__HIGHEST |
int | 906 |
RetentionRangeType |
RETENTIONRANGE_MAXINT |
int | 1125899906842624 |
SCHEDULE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SCHEDULE_FREQUENCY_LOWEST |
int | 8010 |
|
SCHEDULE_FREQUENCY_ONCEONLY |
int | 8010 |
epoch time |
SCHEDULE_FREQUENCY_DAILY |
int | 8011 |
seconds past 00:00 local time |
SCHEDULE_FREQUENCY_HOURLY |
int | 8012 |
seconds past *:00 local time |
SCHEDULE_FREQUENCY_WEEKLY |
int | 8013 |
seconds past 00:00 Sunday, local time |
SCHEDULE_FREQUENCY_MONTHLY |
int | 8014 |
seconds past 00:00 1st, local time |
SCHEDULE_FREQUENCY_PERIODIC |
int | 8015 |
SecondsPast: number of seconds per Offset: Shunt seconds after unix epoch |
SCHEDULE_FREQUENCY_HIGHEST |
int | 8015 |
|
SCHEDULE_MAXINT |
int | 1125899906842624 |
2^50 (1 << 50) |
SEARCHCLAUSE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SEARCHCLAUSE_RULE |
string | "" |
SearchClauseType |
SEARCHCLAUSE_AND |
string | "and" |
SearchClauseType |
SEARCHCLAUSE_OR |
string | "or" |
SearchClauseType |
SEARCHCLAUSE_NOT_AND |
string | "not_and" |
SearchClauseType |
SEARCHCLAUSE_NOT_OR |
string | "not_or" |
SearchClauseType |
SEARCHOPERATOR ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SEARCHOPERATOR_STRING_EQ |
string | "str_eq" |
|
SEARCHOPERATOR_STRING_NEQ |
string | "str_neq" |
|
SEARCHOPERATOR_STRING_CONTAINS |
string | "str_contains" |
|
SEARCHOPERATOR_STRING_NCONTAINS |
string | "str_ncontains" |
|
SEARCHOPERATOR_STRING_STARTSWITH |
string | "str_startswith" |
|
SEARCHOPERATOR_STRING_NSTARTSWITH |
string | "str_nstartswith" |
|
SEARCHOPERATOR_STRING_ENDSWITH |
string | "str_endswith" |
|
SEARCHOPERATOR_STRING_NENDSWITH |
string | "str_nendswith" |
|
SEARCHOPERATOR_STRING_EQ_CI |
string | "str_eq_ci" |
|
SEARCHOPERATOR_STRING_NEQ_CI |
string | "str_neq_ci" |
|
SEARCHOPERATOR_STRING_CONTAINS_CI |
string | "str_contains_ci" |
|
SEARCHOPERATOR_STRING_NCONTAINS_CI |
string | "str_ncontains_ci" |
|
SEARCHOPERATOR_STRING_STARTSWITH_CI |
string | "str_startswith_ci" |
|
SEARCHOPERATOR_STRING_NSTARTSWITH_CI |
string | "str_nstartswith_ci" |
|
SEARCHOPERATOR_STRING_ENDSWITH_CI |
string | "str_endswith_ci" |
|
SEARCHOPERATOR_STRING_NENDSWITH_CI |
string | "str_nendswith_ci" |
|
SEARCHOPERATOR_STRING_REGEXMATCH |
string | "str_regexmatch" |
|
SEARCHOPERATOR_STRING_NREGEXMATCH |
string | "str_nregexmatch" |
|
SEARCHOPERATOR_INT_EQ |
string | "int_eq" |
|
SEARCHOPERATOR_INT_NEQ |
string | "int_neq" |
|
SEARCHOPERATOR_INT_GT |
string | "int_gt" |
|
SEARCHOPERATOR_INT_GTE |
string | "int_gte" |
|
SEARCHOPERATOR_INT_LT |
string | "int_lt" |
|
SEARCHOPERATOR_INT_LTE |
string | "int_lte" |
|
SEARCHOPERATOR_BOOL_IS |
string | "bool_is" |
|
SEARCHOPERATOR_BOOL_NIS |
string | "bool_nis" |
SETTING ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SETTING_SYSTEM_DEFAULT |
int | 0 |
DefaultSettingMode |
SETTING_OPTIONAL_DEFAULT_ON |
int | 1 |
DefaultSettingMode |
SETTING_OPTIONAL_DEFAULT_OFF |
int | 2 |
DefaultSettingMode |
SETTING_ENFORCED_ON |
int | 3 |
DefaultSettingMode |
SETTING_ENFORCED_OFF |
int | 4 |
DefaultSettingMode |
SEVERITY ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SEVERITY_INFO |
string | "I" |
Severity |
SEVERITY_WARNING |
string | "W" |
Severity |
SEVERITY_ERROR |
string | "E" |
Severity |
SEVT ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SEVT_META_HELLO |
int | 4000 |
StreamableEventType: Event is emitted when the webhook is registered, or when the server starts The Data associated is ServerMetaVersionInfo |
SEVT_ACCOUNT_NEW |
int | 4100 |
StreamableEventType: Data is the profile object |
SEVT_ACCOUNT_REMOVED |
int | 4101 |
StreamableEventType: Data is the username |
SEVT_ACCOUNT_UPDATED |
int | 4102 |
StreamableEventType: Data is the profile object |
SEVT_JOB_NEW |
int | 4200 |
StreamableEventType |
SEVT_JOB_COMPLETED |
int | 4201 |
StreamableEventType |
SEVT_BUCKET_NEW |
int | 4300 |
StreamableEventType: Data is the string bucket ref |
SSHCONNECTION ¶
| Name | Type | Value | Comment |
|---|---|---|---|
SSHCONNECTION_AUTHMODE__INVALID |
int | 0 |
SSHAuthMode |
SSHCONNECTION_AUTHMODE_PASSWORD |
int | 1 |
SSHAuthMode |
SSHCONNECTION_AUTHMODE_PRIVATEKEY |
int | 2 |
SSHAuthMode: change values |
STOREDOBJECTTYPE ¶
| Name | Type | Value | Comment |
|---|---|---|---|
STOREDOBJECTTYPE_FILE |
string | "file" |
StoredObjectType |
STOREDOBJECTTYPE_DIRECTORY |
string | "dir" |
StoredObjectType |
STOREDOBJECTTYPE_SYMLINK |
string | "symlink" |
StoredObjectType |
STOREDOBJECTTYPE_UNIXBLOCKDEVICE |
string | "dev" |
StoredObjectType |
STOREDOBJECTTYPE_UNIXCHARDEVICE |
string | "chardev" |
StoredObjectType |
STOREDOBJECTTYPE_UNIXFIFO |
string | "fifo" |
StoredObjectType |
STOREDOBJECTTYPE_UNIXSOCKET |
string | "socket" |
StoredObjectType |
STOREDOBJECTTYPE_WINEFS |
string | "winefs" |
StoredObjectType |
TOTPRequiredError ¶
| Name | Type | Value | Comment |
|---|---|---|---|
TOTPRequiredError |
string | "ERR_TOTP_REQUIRED" |
UPDATESTATUS ¶
| Name | Type | Value | Comment |
|---|---|---|---|
UPDATESTATUS_NOT_SEEN |
int | 0 |
UpdateStatus |
UPDATESTATUS_INELIGIBLE |
int | 1 |
UpdateStatus |
UPDATESTATUS_PENDING |
int | 2 |
UpdateStatus |
UPDATESTATUS_REQUEST_MADE |
int | 3 |
UpdateStatus |
UPDATESTATUS_UPDATE_FAILED |
int | 4 |
UpdateStatus: Device reconnected with bad version |
UPDATESTATUS_UPDATE_CONFIRMED |
int | 5 |
UpdateStatus |
UnknownDeviceError ¶
| Name | Type | Value | Comment |
|---|---|---|---|
UnknownDeviceError |
string | "ERR_UNKNOWN_DEVICE" |
Data structures ¶
AddBucketResponseMessage ¶
class AddBucketResponseMessage extends CometAPIResponseMessage, NewBucketDetail {
}AdminAccountPropertiesResponse ¶
class AdminAccountPropertiesResponse {
string OrganizationID
AdminUserPermissions Permissions
AdminSecurityOptions Security
}AdminEmailOptions ¶
class AdminEmailOptions {
string FromEmail
string FromName
}AdminResourceResponse ¶
class AdminResourceResponse extends CometAPIResponseMessage {
string ResourceHash
}AdminSecurityOptions ¶
class AdminSecurityOptions {
int PasswordFormat
string Password
bool AllowPasswordLogin
bool AllowPasswordAndTOTPLogin
bool AllowPasswordAndU2FLogin
List<AdminU2FRegistration> U2FRegistrations // Omission from JSON document implies an empty array
int TOTPKeyEncryptionFormat // Omission from JSON document implies 0
string TOTPKey // Omission from JSON document implies empty string
string IPWhitelist // Omission from JSON document implies empty string
}AdminU2FRegistration ¶
class AdminU2FRegistration {
string Description
int RegisterTime
List<byte> Registration
}AdminUserPermissions ¶
class AdminUserPermissions {
bool PreventEditServerSettings // Omission from JSON document implies false
bool PreventServerShutdown // Omission from JSON document implies false
bool PreventChangePassword // Omission from JSON document implies false
bool AllowEditBranding // Omission from JSON document implies false
bool AllowEditRemoteStorage // Omission from JSON document implies false
}AvailableDownload ¶
class AvailableDownload {
string Category
string Description
bool Recommended
}AzureDestinationLocation ¶
class AzureDestinationLocation {
string AZBAccountName
string AZBAccountKey
string AZBContainer
string AZBRealm
string AZBPrefix
}B2DestinationLocation ¶
class B2DestinationLocation {
string AccountID // Omission from JSON document implies empty string
string Key // Omission from JSON document implies empty string
string Bucket // Omission from JSON document implies empty string
string Prefix // Omission from JSON document implies empty string
int MaxConnections // Omission from JSON document implies 0
}B2StorageExtraInfo ¶
class B2StorageExtraInfo {
Dictionary<int, B2TransactionTotals> TotalTransactionsInTimeInterval
}B2TransactionTotals ¶
class B2TransactionTotals {
int ClassA
int ClassB
int ClassC
}B2VirtualStorageRoleSettings ¶
class B2VirtualStorageRoleSettings {
string MasterBucket
string KeyID
string AppKey
}BackupJobAdvancedOptions ¶
class BackupJobAdvancedOptions {
bool SkipAlreadyRunning
int StopAfter
int LimitVaultSpeedBps
bool ReduceDiskConcurrency
bool UseOnDiskIndexes
bool AllowZeroFilesSuccess
}BackupJobDetail ¶
class BackupJobDetail {
string GUID
string Username
int Classification
int Status
int StartTime
int EndTime
string SourceGUID
string DestinationGUID
string DeviceID
string SnapshotID // Omission from JSON document implies empty string
string ClientVersion
int TotalDirectories
int TotalFiles
int TotalSize
int TotalChunks
int UploadSize
int DownloadSize
string CancellationID // Omission from JSON document implies empty string
BackupJobProgress Progress // Omission from JSON document implies zero-initialised BackupJobProgress class instance
}BackupJobProgress ¶
class BackupJobProgress {
int Counter
int SentTime
int RecievedTime
int BytesDone
int ItemsDone
}BackupRuleConfig ¶
class BackupRuleConfig extends BackupJobAdvancedOptions {
string Description
int CreateTime
int ModifyTime
List<string> PreExec
List<string> ThawExec
List<string> PostExec
string Source
string Destination
List<ScheduleConfig> Schedules
BackupRuleEventTriggers EventTriggers
}BackupRuleEventTriggers ¶
class BackupRuleEventTriggers {
bool OnPCBoot // Omission from JSON document implies false
bool OnPCBootIfLastJobMissed // Omission from JSON document implies false
}BrandingOptions ¶
class BrandingOptions extends WebInterfaceBrandingProperties, BrandingProperties {
}BrandingProperties ¶
class BrandingProperties extends PublicBrandingProperties, PrivateBrandingProperties {
}BrowseDiskDrivesResponse ¶
class BrowseDiskDrivesResponse extends CometAPIResponseMessage {
List<DiskDrive> Disks
}BrowseEDBResponse ¶
class BrowseEDBResponse extends CometAPIResponseMessage {
List<EDBFileInfo> Databases
}BrowseHVResponse ¶
class BrowseHVResponse extends CometAPIResponseMessage {
List<HyperVMachineInfo> VirtualMachines
}BrowseVSSResponse ¶
class BrowseVSSResponse extends CometAPIResponseMessage {
Dictionary<string, VSSWriterInfo> VSSWriters
}BucketProperties ¶
class BucketProperties {
string OrganizationID
int CreateTime
int ReadWriteKeyFormat
string ReadWriteKey
SizeMeasurement Size
}BucketUsageInfo ¶
class BucketUsageInfo {
List<int> ExistsOnServers
List<UserOnServer> InUseBy
}CometAPIResponseMessage ¶
class CometAPIResponseMessage {
int Status
string Message
}CometDestinationLocation ¶
class CometDestinationLocation {
string CometServer
string CometBucket
string CometBucketKey
}ConstellationCheckReport ¶
class ConstellationCheckReport {
int CheckStarted
int CheckCompleted
Dictionary<string, BucketUsageInfo> Usage
}ConstellationStats ¶
class ConstellationStats {
int LastCheckStart
int TotalChecksStarted
int TotalBucketsDeleted
int ChecksCurrentlyActive
}ConstellationStatusAPIResponse ¶
class ConstellationStatusAPIResponse {
bool DeletionEnabled
List<string> Targets
List<string> TargetNames // Omission from JSON document implies an empty array
ConstellationStats Stats
}ContentMeasurement ¶
class ContentMeasurement {
int MeasureStarted
int MeasureCompleted
List<ContentMeasurementComponent> Components
}ContentMeasurementComponent ¶
class ContentMeasurementComponent {
int Bytes
List<string> UsedBy
}CreateGroupPolicyResponse ¶
class CreateGroupPolicyResponse extends CometAPIResponseMessage {
string PolicyHash
}DefaultEmailReportPolicy ¶
class DefaultEmailReportPolicy extends UserCustomEmailSettings {
bool ShouldOverrideDefaultReports
}DestinationConfig ¶
class DestinationConfig extends DestinationLocation {
string Description
int CreateTime
int ModifyTime
List<string> PreExec
List<string> ThawExec
List<string> PostExec
int EncryptionKeyEncryptionMethod
string EncryptedEncryptionKey
int RepoInitTimestamp
bool StorageLimitEnabled
int StorageLimitBytes
DestinationStatistics Statistics // Omission from JSON document implies zero-initialised DestinationStatistics class instance
RetentionPolicy DefaultRetention
bool RebrandStorage
}DestinationLocation ¶
class DestinationLocation extends CometDestinationLocation, S3DestinationLocation, SFTPDestinationLocation, FTPDestinationLocation, AzureDestinationLocation, LocalDestinationLocation, SpannedDestinationLocation {
int DestinationType
SwiftDestinationLocation Swift
B2DestinationLocation B2
}DestinationStatistics ¶
class DestinationStatistics {
SizeMeasurement ClientProvidedSize
ContentMeasurement ClientProvidedContent
string LastSuccessfulDeepVerify_GUID // Omission from JSON document implies empty string
int LastSuccessfulDeepVerify_StartTime // Omission from JSON document implies 0
int LastSuccessfulDeepVerify_EndTime // Omission from JSON document implies 0
}DeviceConfig ¶
class DeviceConfig {
string FriendlyName
OSInfo PlatformVersion // Omission from JSON document implies zero-initialised OSInfo class instance
Dictionary<string, SourceBasicInfo> Sources // Omission from JSON document implies an empty Dictionary
}DiskDrive ¶
class DiskDrive {
string ID
string DeviceName
string Caption
string Model
string SerialNumber
int Size
List<Partition> Partitions
int Flags
int Cylinders
int Heads
int Sectors
int SectorSize
}DispatcherAdminSourcesResponse ¶
class DispatcherAdminSourcesResponse extends CometAPIResponseMessage {
Dictionary<string, string> ImportSources
}DispatcherStoredObjectsResponse ¶
class DispatcherStoredObjectsResponse extends CometAPIResponseMessage {
List<StoredObject> StoredObjects
}DispatcherVaultSnapshotsResponse ¶
class DispatcherVaultSnapshotsResponse extends CometAPIResponseMessage {
List<VaultSnapshot> Snapshots
}EDBFileInfo ¶
class EDBFileInfo {
string Name
string Guid
string ServerName
bool CircularLoggingEnabled
}EmailOptions ¶
class EmailOptions extends AdminEmailOptions {
string Mode
string SMTPHost // Omission from JSON document implies empty string
int SMTPPort // Omission from JSON document implies 0
string SMTPUsername // Omission from JSON document implies empty string
string SMTPPassword // Omission from JSON document implies empty string
bool SMTPAllowInvalidCertificate // Omission from JSON document implies false
bool SMTPAllowUnencrypted // Omission from JSON document implies false
}EmailReportConfig ¶
class EmailReportConfig {
int ReportType
List<ScheduleConfig> SummaryFrequency
SearchClause Filter
}EmailReportGeneratedPreview ¶
class EmailReportGeneratedPreview extends CometAPIResponseMessage {
string EmailSubject
string EmailBodyHTML
string EmailBodyPlaintext
}ExternalLDAPAuthenticationSourceSettings ¶
class ExternalLDAPAuthenticationSourceSettings {
string Hostname
int Port
string SecurityMethod
string BindUser
}ExtraFileExclusion ¶
class ExtraFileExclusion {
string Exclude
bool Regex
int RestrictOS
}FTPDestinationLocation ¶
class FTPDestinationLocation {
string FTPServer
string FTPUsername
string FTPPassword
bool FTPBaseUseHomeDirectory
string FTPCustomBaseDirectory
int FTPSMode
int FTPPort
int FTPMaxConnections
bool FTPAcceptInvalidSSL
}GetGroupPolicyResponse ¶
class GetGroupPolicyResponse extends CometAPIResponseMessage {
GroupPolicy Policy
string PolicyHash
}GetProfileAndHashResponseMessage ¶
class GetProfileAndHashResponseMessage extends CometAPIResponseMessage {
string ProfileHash
UserProfileConfig Profile
}GetProfileHashResponseMessage ¶
class GetProfileHashResponseMessage extends CometAPIResponseMessage {
string ProfileHash
}GroupPolicy ¶
class GroupPolicy {
string Description
string OrganizationID
UserPolicy Policy
bool DefaultUserPolicy
}HyperVMachineInfo ¶
class HyperVMachineInfo {
string ID
string Name
}InstallCreds ¶
class InstallCreds {
string Username
string Password
string Server
bool AutoLogin
}InstallToken ¶
class InstallToken {
string Username
string Server
string Token
int CreateTime
bool Used
int ExpireTime
}InstallTokenResponse ¶
class InstallTokenResponse extends CometAPIResponseMessage {
InstallToken InstallToken
}JobEntry ¶
class JobEntry {
int Time
string Severity
string Message
}LiveUserConnection ¶
class LiveUserConnection {
string Username
string DeviceID
string ReportedVersion
string ReportedPlatform
OSInfo ReportedPlatformVersion // Omission from JSON document implies zero-initialised OSInfo class instance
string IPAddress // Omission from JSON document implies empty string
int ConnectionTime
bool AllowsFilenames
}LocalDestinationLocation ¶
class LocalDestinationLocation {
string LocalcopyPath
string LocalcopyWinSMBUsername
string LocalcopyWinSMBPassword
int LocalcopyWinSMBPasswordFormat
}MacOSCodeSignProperties ¶
class MacOSCodeSignProperties {
int Level
SSHConnection SSHServer
string CertificateName
string AppCertificateName
string AppleID
string AppleIDPass
int AppleIDPassFormat
}MongoDBConnection ¶
class MongoDBConnection {
string Server
int Port
string Username
string Password
string AuthenticationDB
string MongoShellPath
string MongodumpPath
string ReadPreference
bool UseReplica
string ReplicaName
List<string> ReplicaMembers
bool UseSSL
string ClientSSLPEMPath
string ServerSSLPEMPath
string SSLClientKeyPassword
bool AllowInvalidCertificate
bool AllowInvalidHostname
bool UseSSH
SSHConnection SSHConnection // Omission from JSON document implies zero-initialised SSHConnection class instance
}NewBucketDetail ¶
class NewBucketDetail {
string NewBucketID
string NewBucketKey
}NewsEntry ¶
class NewsEntry {
string OrganizationID
int DateTime
string TextContent
}OSInfo ¶
class OSInfo {
string version // Omission from JSON document implies empty string
string distribution // Omission from JSON document implies empty string
string build // Omission from JSON document implies empty string
}Organization ¶
class Organization {
string Name
List<string> Hosts
SoftwareBuildRoleOptions SoftwareBuildRole
BrandingOptions Branding
List<RemoteStorageOption> RemoteStorage
Dictionary<string, WebhookOption> WebhookOptions
AdminEmailOptions Email
}OrganizationResponse ¶
class OrganizationResponse extends CometAPIResponseMessage {
string ID
Organization Organization
}Partition ¶
class Partition {
string DeviceName
string Filesystem
string VolumeName
string VolumeGuid
string VolumeSerial
List<string> MountPoints
int ReadOffset
int Size
int UsedSize
int Flags
int BytesPerFilesystemCluster
}PrivateBrandingProperties ¶
class PrivateBrandingProperties extends WindowsCodeSignProperties {
string PathIcoFile
string PathIcnsFile
string PathEulaRtf
string PathTilePng
string PathHeaderImage
string PackageIdentifier
MacOSCodeSignProperties MacOSCodeSign
}ProtectedItemEngineTypePolicy ¶
class ProtectedItemEngineTypePolicy {
bool ShouldRestrictEngineTypeList
List<string> AllowedEngineTypeWhenRestricted
}PublicBrandingProperties ¶
class PublicBrandingProperties {
string ProductName
string CompanyName
string HelpURL
bool HelpIsPopup
string DefaultLoginServerURL
string TileBackgroundColor
string AccountRegisterURL
bool HideBackgroundLogo
}RemoteServerAddress ¶
class RemoteServerAddress {
string Type
string Description
string RemoteAddress // Omission from JSON document implies empty string
string Username // Omission from JSON document implies empty string
string Password // Omission from JSON document implies empty string
ExternalLDAPAuthenticationSourceSettings LDAP // Omission from JSON document implies zero-initialised ExternalLDAPAuthenticationSourceSettings class instance
B2VirtualStorageRoleSettings B2 // Omission from JSON document implies zero-initialised B2VirtualStorageRoleSettings class instance
WasabiVirtualStorageRoleSettings Wasabi // Omission from JSON document implies zero-initialised WasabiVirtualStorageRoleSettings class instance
}RemoteStorageOption ¶
class RemoteStorageOption extends RemoteServerAddress {
bool StorageLimitEnabled
int StorageLimitBytes
bool RebrandStorage
}ReplicatorStateAPIResponse ¶
class ReplicatorStateAPIResponse {
string Description
string RemoteServerID
int DisplayClass
int ActiveWorkers
int TotalWorkers
int State
int ItemsQueued
int BytesQueued
int LastWorkerSubmitTime
int CurrentTime
int ItemsReplicated
int BytesReplicated
}RequestStorageVaultResponseMessage ¶
class RequestStorageVaultResponseMessage extends CometAPIResponseMessage {
string DestinationID
}RestoreJobAdvancedOptions ¶
class RestoreJobAdvancedOptions {
int Type
bool OverwriteExistingFiles
string DestPath
List<string> ExactDestPaths
int ArchiveFormat
}RetentionPolicy ¶
class RetentionPolicy {
int Mode
List<RetentionRange> Ranges
}RetentionRange ¶
class RetentionRange {
int Type
int Timestamp
int Jobs
int Days
int Weeks
int Months
int WeekOffset
int MonthOffset
}S3DestinationLocation ¶
class S3DestinationLocation {
string S3Server
bool S3UsesTLS
string S3AccessKey
string S3SecretKey
string S3BucketName
string S3Subdir
bool S3UsesV2Signing
}SFTPDestinationLocation ¶
class SFTPDestinationLocation {
string SFTPServer
string SFTPUsername
string SFTPRemotePath
int SFTPAuthMode
string SFTPPassword
string SFTPPrivateKey
bool SFTPCustomAuth_UseKnownHostsFile
string SFTPCustomAuth_KnownHostsFile
}SSHConnection ¶
class SSHConnection {
string SSHServer
string SSHUsername
int SSHAuthMode
string SSHPassword
string SSHPrivateKey
bool SSHCustomAuth_UseKnownHostsFile
string SSHCustomAuth_KnownHostsFile
}ScheduleConfig ¶
class ScheduleConfig {
int FrequencyType
int SecondsPast
int Offset // Omission from JSON document implies 0
}SearchClause ¶
class SearchClause {
string ClauseType
string RuleField
string RuleOperator
string RuleValue
List<SearchClause> ClauseChildren // Omission from JSON document implies an empty array
}ServerConfigOptionsBrandingFragment ¶
class ServerConfigOptionsBrandingFragment {
BrandingOptions Branding
}ServerConfigOptionsSoftwareBuildRoleFragment ¶
class ServerConfigOptionsSoftwareBuildRoleFragment {
SoftwareBuildRoleOptions SoftwareBuildRole
}ServerMetaVersionInfo ¶
class ServerMetaVersionInfo {
string Version
string VersionCodename
bool StorageRole
bool AuthenticationRole
bool SoftwareBuildRole
bool OverseerRole
bool ConstellationRole
List<string> ExperimentalOptions // Omission from JSON document implies an empty array
int ServerStartTime
string ServerStartHash
int CurrentTime
string ServerLicenseHash
int LicenseValidUntil
int EmailsSentSuccessfully
int EmailsSentErrors
int EmailsWaitingInQueue
int ScheduledEmailThreadCurrentState
int ScheduledEmailThreadLastCalculateDurationNanos
int ScheduledEmailThreadWaitingUntil
int ScheduledEmailThreadLastWakeTime
bool ScheduledEmailThreadLastWakeSentEmails
}SessionKeyRegeneratedResponse ¶
class SessionKeyRegeneratedResponse extends CometAPIResponseMessage {
string SessionKey
string SessionType
}SizeMeasurement ¶
class SizeMeasurement {
int Size
int MeasureStarted
int MeasureCompleted
}SoftwareBuildRoleOptions ¶
class SoftwareBuildRoleOptions {
bool RoleEnabled
bool AllowUnauthenticatedDownloads
}SoftwareUpdateNewsResponse ¶
class SoftwareUpdateNewsResponse {
string latest_stable
string latest_prerelease
string downloads_url
List<string> updates_info
}SourceBasicInfo ¶
class SourceBasicInfo {
string Description
int Size
Dictionary<string, RetentionPolicy> OverrideDestinationRetention // Omission from JSON document implies an empty Dictionary
}SourceConfig ¶
class SourceConfig {
string Engine
string Description
string OwnerDevice
int CreateTime
int ModifyTime
List<string> PreExec
List<string> ThawExec
List<string> PostExec
Dictionary<string, string> EngineProps
Dictionary<string, RetentionPolicy> OverrideDestinationRetention // Omission from JSON document implies an empty Dictionary
SourceStatistics Statistics // Omission from JSON document implies zero-initialised SourceStatistics class instance
}SourceStatistics ¶
class SourceStatistics {
BackupJobDetail LastBackupJob
}SpannedDestinationLocation ¶
class SpannedDestinationLocation {
List<DestinationLocation> SpanTargets
}SpannedStorageExtraInfo ¶
class SpannedStorageExtraInfo {
List<StorageFreeSpaceInfo> Targets
}StatResult ¶
class StatResult {
int Buckets
int Users
int Devices
int Boosters
}StorageFreeSpaceInfo ¶
class StorageFreeSpaceInfo {
bool Unlimited
float32 UsedPercent
int AvailableBytes
SpannedStorageExtraInfo Spanned // Omission from JSON document implies zero-initialised SpannedStorageExtraInfo class instance
B2StorageExtraInfo B2 // Omission from JSON document implies zero-initialised B2StorageExtraInfo class instance
}StorageVaultProviderPolicy ¶
class StorageVaultProviderPolicy {
bool ShouldRestrictProviderList
List<int> AllowedProvidersWhenRestricted
}StoredObject ¶
class StoredObject {
string name
int mtime
string type
string subtree
int size
bool r // Omission from JSON document implies false
int f // Omission from JSON document implies 0
int b // Omission from JSON document implies 0
int d // Omission from JSON document implies 0
}StreamableEvent ¶
class StreamableEvent {
string OwnerOrganizationID
int Type
any Data
}SwiftDestinationLocation ¶
class SwiftDestinationLocation {
string Username // Omission from JSON document implies empty string
string APIKey // Omission from JSON document implies empty string
string Region // Omission from JSON document implies empty string
string AuthURL // Omission from JSON document implies empty string
string Domain // Omission from JSON document implies empty string
string Tenant // Omission from JSON document implies empty string
string TenantDomain // Omission from JSON document implies empty string
string TenantID // Omission from JSON document implies empty string
string TrustID // Omission from JSON document implies empty string
string AuthToken // Omission from JSON document implies empty string
string Prefix // Omission from JSON document implies empty string
string Container // Omission from JSON document implies empty string
string DefaultContainerPolicy // Omission from JSON document implies empty string
}TestResponse ¶
class TestResponse extends CometAPIResponseMessage {
bool Exists
}TotpRegeneratedResponse ¶
class TotpRegeneratedResponse extends CometAPIResponseMessage {
string Image
string URL
string ProfileHash
}U2FRegisterRequest ¶
class U2FRegisterRequest {
string Challenge
string Version
}U2FRegisteredKey ¶
class U2FRegisteredKey {
string AppID
string KeyHandle
string Version
}U2FRegistrationChallengeResponse ¶
class U2FRegistrationChallengeResponse extends CometAPIResponseMessage {
string ChallengeID
string AppID
List<U2FRegisteredKey> RegisteredKeys
List<U2FRegisterRequest> RegisterRequests
}U2FSignRequest ¶
class U2FSignRequest {
string ChallengeID
string ChallengeData
string AppID
List<U2FRegisteredKey> RegisteredKeys
}U2FSignResponse ¶
class U2FSignResponse {
string ChallengeID
string KeyHandle
string Signature
string ClientData
}UninstallConfig ¶
class UninstallConfig {
bool UninstallFlag
bool RemoveConfigFile
}UpdateCampaignDeviceStatus ¶
class UpdateCampaignDeviceStatus {
int Status
}UpdateCampaignOptions ¶
class UpdateCampaignOptions {
bool Active
bool UpgradeOlder
bool ReinstallCurrentVer
bool DowngradeNewer
}UpdateCampaignProperties ¶
class UpdateCampaignProperties extends UpdateCampaignOptions {
int StartTime
string TargetVersion
}UpdateCampaignStatus ¶
class UpdateCampaignStatus extends UpdateCampaignProperties {
List<UpdateCampaignStatusDeviceEntry> Devices
}UpdateCampaignStatusDeviceEntry ¶
class UpdateCampaignStatusDeviceEntry extends UpdateCampaignDeviceStatus {
string Username
string DeviceID
}UserCustomEmailSettings ¶
class UserCustomEmailSettings {
List<EmailReportConfig> Reports
}UserOnServer ¶
class UserOnServer {
int ServerID
string Username
}UserPolicy ¶
class UserPolicy {
bool PreventRequestStorageVault
bool PreventAddCustomStorageVault
bool PreventEditStorageVault
bool HideCloudStorageBranding
bool PreventDeleteStorageVault
StorageVaultProviderPolicy StorageVaultProviders
bool PreventNewProtectedItem
bool PreventEditProtectedItem
bool PreventDeleteProtectedItem
ProtectedItemEngineTypePolicy ProtectedItemEngineTypes
List<ExtraFileExclusion> FileAndFolderMandatoryExclusions // Omission from JSON document implies an empty array
int ModeScheduleSkipAlreadyRunning // Omission from JSON document implies 0
int ModeAdminResetPassword // Omission from JSON document implies 0
int ModeAdminViewFilenames // Omission from JSON document implies 0
int ModeRequireUserResetPassword // Omission from JSON document implies 0
bool PreventDeleteSingleSnapshots
bool PreventChangeAccountPassword
bool PreventChangeEmailSettings
bool PreventChangeAccountName
bool PreventOpenAppUI
bool RequirePasswordOpenAppUI
bool HideAppImport
bool HideAppVersion
bool PreventOpenWebUI
bool PreventViewDeviceNames
DefaultEmailReportPolicy DefaultEmailReports
RetentionPolicy DefaultStorageVaultRetention
bool EnforceStorageVaultRetention
bool PreventProtectedItemRetention
Dictionary<string, SourceConfig> DefaultSources
Dictionary<string, BackupRuleConfig> DefaultSourcesBackupRules
Dictionary<string, BackupRuleConfig> DefaultBackupRules
}UserProfileConfig ¶
class UserProfileConfig {
string Username
string AccountName
string LocalTimezone
string LanguageCode
string OrganizationID // Omission from JSON document implies empty string
List<string> Emails
Dictionary<string, UserCustomEmailSettings> OverrideEmailSettings
bool SendEmailReports
Dictionary<string, DestinationConfig> Destinations
Dictionary<string, SourceConfig> Sources
Dictionary<string, BackupRuleConfig> BackupRules
Dictionary<string, DeviceConfig> Devices
bool IsSuspended
bool AllProtectedItemsQuotaEnabled
int AllProtectedItemsQuotaBytes
int MaximumDevices
string PolicyID
UserPolicy Policy
int PasswordFormat
string PasswordHash
string PasswordRecovery // Omission from JSON document implies empty string
bool AllowPasswordLogin
bool AllowPasswordAndTOTPLogin
int TOTPKeyEncryptionFormat
string TOTPKey
bool RequirePasswordChange
int CreateTime
string CreationGUID
}UserProfileFragment ¶
class UserProfileFragment {
string Username
}VSSComponent ¶
class VSSComponent {
string Path
string Name
string CType
bool Selectable
}VSSWriterInfo ¶
class VSSWriterInfo {
string DisplayName
List<VSSComponent> Components
}VaultSnapshot ¶
class VaultSnapshot {
string Snapshot
string Source
int CreateTime
}WasabiVirtualStorageRoleSettings ¶
class WasabiVirtualStorageRoleSettings {
string MasterBucket
string AccessKey
string SecretKey
}WebInterfaceBrandingProperties ¶
class WebInterfaceBrandingProperties {
string BrandName
string LogoImage
string TopColor
string Favicon
bool HideNewsArea
}WebhookOption ¶
class WebhookOption {
string URL
List<int> WhiteListedEventTypes
}WinSMBAuth ¶
class WinSMBAuth {
string SharePath
string Username
string Password
int PasswordFormat
}WindowsCodeSignProperties ¶
class WindowsCodeSignProperties {
string WindowsCodeSignPKCS12FilePath
int WindowsCodeSignPKCS12PasswordFormat
string WindowsCodeSignPKCS12Password
string WindowsCodeSignPKCS11Engine
string WindowsCodeSignPKCS11Module
string WindowsCodeSignPKCS11Certfile
string WindowsCodeSignPKCS11KeyID
int WindowsCodeSignPKCS11PasswordFormat
string WindowsCodeSignPKCS11Password
}
