Comet Account Portal API

Getting Started

As well as making API requests to your Comet Server instances described in the previous sections, an API is also available for the Comet Account Portal. This API allows you to control some parts of your Comet account by making HTTP POST requests to https://account.cometbackup.com.

Authentication

Authentication for the Comet Account Portal API can be performed using an API token.

Token Authentication

Provide the token parameter in the POST body of your request, or by using Bearer authentication. You can manage your API tokens from the API token management page in the Comet Account Portal.

Example:

$ curl
    -X POST
    -H "Authorization: Bearer <your-token-here>"
    https://account.cometbackup.com/api/v1/license/list_licenses

$ curl
    -X POST
    --data-urlencode "auth_type=token"
    --data-urlencode "token=<your-token-here>"
    https://account.cometbackup.com/api/v1/license/list_licenses

Notes

1. All requests must be application/x-www-form-urlencoded encoded.

2. All response object will be application/json encoded. Unless otherwise specified.

3. The code field in the JSON response should always match the HTTP response code.

CloudView API Endpoints

CloudViewConvertToPaid (Deprecated)

Convert the Comet CloudView instance for this account into active/paid mode

Endpoint	/api/v1/cloudview/convert-to-paid
Method	POST
Token Action	CloudView::ConvertToPaid
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

CloudViewConvertToTrial (Deprecated)

Convert the Comet CloudView instance for this account into trial mode

Endpoint	/api/v1/cloudview/convert-to-trial
Method	POST
Token Action	CloudView::ConvertToTrial
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

CloudViewGenerateLoginCredentials (Deprecated)

Generate the Comet CloudView login credentials for this account

Endpoint	/api/v1/cloudview/generate-login-credentials
Method	POST
Token Action	CloudView::GenerateLoginCredentials
Response Encoding	application/json
Response Type	ApiResponse<CloudViewLoginCredentials>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

CloudViewProvision (Deprecated)

Provision a trial-mode Comet Cloudview instance for this account.

Endpoint	/api/v1/cloudview/provision
Method	POST
Token Action	CloudView::InstanceProvision
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

CloudViewStatus (Deprecated)

Get the status of the Comet CloudView instance for this account. Returns DISABLED, PROVISIONING, READY, or FAILED

Endpoint	/api/v1/cloudview/status
Method	POST
Token Action	CloudView::Status
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

CloudViewTerminate (Deprecated)

Terminate the Comet Cloudview instance for this account (permanent).

Endpoint	/api/v1/cloudview/terminate
Method	POST
Token Action	CloudView::InstanceTerminate
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

Company API Endpoints

CompanyDelete

Close your Comet Account

Endpoint	/api/v1/company/delete
Method	POST
Token Action	Company::Delete
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_force	boolean	A check for permanently deleting a company

Download API Endpoints

DownloadsGet

Returns an HTTP 301 redirect for the given Self-Hosted software download

Endpoint	/api/v1/downloads/get
Method	POST
Token Action	Download::Get
Response Encoding	text/plain;charset=UTF-8
Response Type	null

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
version_key*	string	The target version key in the 22.x.x, latest-voyager, or latest-quarterly format. Required.
platform*	string	The target platform type. Required. Valid Platforms - download_windows, download_linux_deb, download_linux_rpm, download_linux_tar, download_linux_arm64_deb, download_linux_arm64_rpm, and download_linux_arm64_tar

DownloadsGetMetadata

Get download metadata for a given version key

Endpoint	/api/v1/downloads/meta
Method	POST
Token Action	Download::GetMetadata
Response Encoding	application/json
Response Type	ApiResponse<CometVersion>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
version_key*	string	The target version key in the 22.x.x, latest-voyager, or latest-quarterly format. Required.

DownloadsList

List available Self-Hosted software downloads

Endpoint	/api/v1/downloads/list_downloads
Method	POST
Token Action	Download::ListDownloads
Response Encoding	application/json
Response Type	ApiResponse<Array<CometVersion>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_search_query	string
page	number
page_size	number

DownloadsList_Legacy (Deprecated)

This API endpoint is deprecated until 2025-06, after which it will be removed.

List available Self-Hosted software downloads. (Deprecated. Use DownloadsList).

Note: The response encoding for this request will change based on the requested format.

Endpoint	/api/v1/downloads/list
Method	POST
Token Action	Download::ListDownloads
Response Encoding	text/plain;charset=UTF-8
Response Type	any

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
format	string	The format of the table. Optional. json, csv, or xlsx (Default: json)

HostedComet API Endpoints

HostedCometCreate

Create a new Comet-Hosted instance

Endpoint	/api/v1/hosted_comet/create
Method	POST
Token Action	HostedComet::Create
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_name	string	The display name for the target server. Optional.
target_region*	string	The target hosted region. Required. (See HostedCometListRegions)
target_domain	string	The subdomain for the target server. Optional.
target_email_send_as*	string	The email that should be used to send emails on behalf of
target_email_from*	string	The name to show in the SMTP From field when sending emails
target_storage_type*	string	The storage type to autoconfigure, if any. Required.
target_storage_bucket_name	string	The bucket in the strage provider to use. Required if 'target_storage_type' is 'wasabi' or 'backblaze'.
target_storage_wasabi_access_key	string	The Wasabi root access key. Optional.
target_storage_wasabi_secret_key	string	The Wasabi root secret key. Optional.
target_storage_b2_application_key	string	The Backblaze B2 application key. Optional.
target_storage_b2_application_key_id	string	The Backblaze B2 application key id. Optional.

HostedCometDelete

Delete a Comet-Hosted instance

Endpoint	/api/v1/hosted_comet/delete
Method	POST
Token Action	HostedComet::DeleteInstance
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_hosted_server_id*	string	The target ID for the hosted server. Required.

HostedCometDescribe

Retrieve the state for a single Comet-Hosted instance

Endpoint	/api/v1/hosted_comet/describe
Method	POST
Token Action	HostedComet::Describe
Response Encoding	application/json
Response Type	ApiResponse<HostedCometTenant>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_hosted_server_id*	string	The target ID for the hosted server. Required.

HostedCometList

List all Comet-Hosted instances in your account

Endpoint	/api/v1/hosted_comet/list
Method	POST
Token Action	HostedComet::ListInstances
Response Encoding	application/json
Response Type	ApiResponse<Array<HostedCometTenant>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

HostedCometListRegions

List available Comet-Hosted regions for your account

Endpoint	/api/v1/hosted_comet/list_regions
Method	POST
Token Action	HostedComet::ListRegions
Response Encoding	application/json
Response Type	ApiResponse<Array<HostedCometListRegionsResponse>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

HostedCometSetFavourite

Set the favourited status of a Comet-Hosted instance

Endpoint	/api/v1/hosted_comet/set_favourite
Method	POST
Token Action	HostedComet::SetFavourite
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_hosted_server_id*	string	The target ID for the hosted server. Required.
target_state*	boolean	The target favourited status for the hosted server. Required.

HostedCometSetName

Update the name of a Comet-Hosted instance

Endpoint	/api/v1/hosted_comet/set_name
Method	POST
Token Action	HostedComet::SetName
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_hosted_server_id*	string	The target ID for the hosted server. Required.
target_name*	string	The target name for the hosted server. Required.

HostedCometUpdateBrandingSettings

Update the DNS and/or email settings for a single Comet-Hosted instance. See: Comet Server API

Endpoint	/api/v1/hosted_comet/update_branding
Method	POST
Token Action	HostedComet::UpdateBranding
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_hosted_server_id*	string	The target ID for the hosted server. Required.
target_use_custom_domain	boolean	The status of the custom domain. Optional. (default: false)
target_custom_domain	string	The custom domain, configured to CNAME the hosted comet url. Optional.
target_email_send_as*	string	The email address that should be used to send reports on behalf of. Required.
target_email_from*	string	The email FROM name to show when sending reports. Required.
target_email_delivery_method*	string	The type of the email configuration, 'ses' or 'smtp'. Required.
target_smtp_host	string	The custom SMTP server hostname. Optional.
target_smtp_port	number	The custom SMTP server port. Optional.
target_smtp_username	string	The custom SMTP server username. Optional.
target_smtp_password	string	The custom SMTP server password. Optional.
target_smtp_security	string	The custom SMTP server security type, 'tls', 'starttls', or 'plain'. Optional.
target_smtp_accept_invalid_ssl_certificate	boolean	Should we accept invalid SSL certificates from the custom SMTP server? Optional.

HostedCometCreate_Legacy (Deprecated)

This API endpoint is deprecated until 2025-06, after which it will be removed.

Create a new CometGo! instance. (Deprecated. Use HostedCometCreate)

Endpoint	/api/v1/cometgo
Method	POST
Token Action	HostedComet::Create
Response Encoding	application/json
Response Type	ApiResponse<object>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

HostedCometList_Legacy (Deprecated)

List all CometGo! instances in your account. (Deprecated. Use HostedCometList)

Endpoint	/api/v1/cometgo/list
Method	POST
Token Action	HostedComet::ListInstances
Response Encoding	application/json
Response Type	ApiResponse<Array<object>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

HostedCometStatus_Legacy (Deprecated)

This API endpoint is deprecated until 2025-06, after which it will be removed.

Get the status of a CometGo! instance. (Deprecated. Use HostedCometDescribe)

Endpoint	/api/v1/cometgo/status
Method	POST
Token Action	HostedComet::Describe
Response Encoding	application/json
Response Type	ApiResponse<object>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

HostedCometTerminate_Legacy (Deprecated)

This API endpoint is deprecated until 2025-06, after which it will be removed.

Terminate a CometGo! instance. (Deprecated. Use HostedCometDelete)

Endpoint	/api/v1/cometgo/terminate
Method	POST
Token Action	HostedComet::DeleteInstance
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

License API Endpoints

LicenseArchiveLicense

Archive an existing Self-Hosted license. Archived licenses will be disabled and can not be reused

Endpoint	/api/v1/license/archive
Method	POST
Token Action	License::ArchiveLicense
Response Encoding	text/plain;charset=UTF-8
Response Type	string

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
serial*	string	The serial of the license to relax. Required.

LicenseCreateLicense

Create a new server license

Endpoint	/api/v1/license/create_license
Method	POST
Token Action	License::CreateLicense
Response Encoding	application/json
Response Type	ApiResponse<ServerLicense>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_name	string	Name of the new server license. Optional.

LicenseListLicenses

List Self-Hosted serial numbers

Endpoint	/api/v1/license/list_licenses
Method	POST
Token Action	License::ListLicenses
Response Encoding	application/json
Response Type	ApiResponse<Array<ServerLicense>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

LicenseRelaxLicense

Relax the IP address and machine ID restrictions for a Self-Hosted license

Endpoint	/api/v1/license/relax
Method	POST
Token Action	License::RelaxLicense
Response Encoding	text/plain;charset=UTF-8
Response Type	string

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
serial*	string	The serial of the license to relax. Required.

LicenseResyncAll

Force sync to get the latest state from the license server

Endpoint	/api/v1/license/resync_all
Method	POST
Token Action	License::ResyncAll
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

LicenseSetFavourite

Update the server license favourited status

Endpoint	/api/v1/license/set_favourite
Method	POST
Token Action	License::SetFavourite
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_serial*	string
target_state*	boolean

LicenseSetLockState

Update the server license lock state

Endpoint	/api/v1/license/set_lock_state
Method	POST
Token Action	License::SetLockState
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_serial*	string
target_lock_state*	boolean

LicenseSetName

Update the server license name

Endpoint	/api/v1/license/set_name
Method	POST
Token Action	License::SetName
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_serial*	string
target_name*	string

LicenseCreateLicense_Legacy (Deprecated)

Create a new Self-Hosted license. (Deprecated. See LicenseCreateLicense)

Endpoint	/api/v1/license/create
Method	POST
Token Action	License::CreateLicense
Response Encoding	text/plain;charset=UTF-8
Response Type	string

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_name	string	Name of the new server license. Optional.

LicenseListAllLicenses_Legacy (Deprecated)

This API endpoint is deprecated until 2025-06, after which it will be removed.

List serial numbers for user account. (Deprecated. Use LicenseListLicenses)

Endpoint	/api/v1/license/list_all
Method	POST
Token Action	License::ListLicenses
Response Encoding	text/plain;charset=UTF-8
Response Type	Array<object>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

Report API Endpoints

ReportActiveServices

Export active services report.

Note: The response encoding for this request will change based on the requested format.

Endpoint	/api/v1/report/active_services
Method	POST
Token Action	Report::ListActiveServices
Response Encoding	text/plain;charset=UTF-8
Response Type	any

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
format	string	The format of the table. Optional. json, csv, or xlsx (Default: json)

ReportBillingHistory

Export usage history report.

Note: The response encoding for this request will change based on the requested format

Endpoint	/api/v1/report/billing_history
Method	POST
Token Action	Report::ListBillingHistory
Response Encoding	text/plain;charset=UTF-8
Response Type	any

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
format	string	The format of the table. Optional. json, csv, or xlsx (Default: json)

Token API Endpoints

TokenCreateToken

Create an API token for a company

Endpoint	/api/v1/token/create_token
Method	POST
Token Action	Token::CreateToken
Response Encoding	application/json
Response Type	ApiResponse<CompanyApiToken>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
permissions*	Array<string>	List of API token actions. Valid options can be found by calling TokenListActions

TokenListActions

List available API token actions that can be provided to TokenCreateToken

Endpoint	/api/v1/token/list_actions
Method	POST
Token Action	Token::ListActions
Response Encoding	application/json
Response Type	ApiResponse<Array<string>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

TokenListTokens

List your API tokens, including revoked tokens

Endpoint	/api/v1/token/list_tokens
Method	POST
Token Action	Token::ListTokens
Response Encoding	application/json
Response Type	ApiResponse<Array<CompanyApiToken>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

TokenRevokeToken

Revoke a given API token

Endpoint	/api/v1/token/revoke_token
Method	POST
Token Action	Token::RevokeToken
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
token*	string

User API Endpoints

MfaDisableTotp

Disable Two-Factor Authentication (Both TOTP and WebAuthn)

Endpoint	/api/v1/user/mfa/disable
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

MfaEnableTotp

Enable Two-Factor Authentication (TOTP)

Endpoint	/api/v1/user/mfa/enable-totp
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
totp_secret*	string
totp_verify_code*	string

MfaWebauthnEnable

Enable Two-Factor Authentication (WebAuthn)

Endpoint	/api/v1/user/mfa/webauthn/enable
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
webauthn_challenge_response*	string

MfaWebauthnRequestChallenge

Request a challenge in order to enable WebAuthn 2FA

Endpoint	/api/v1/user/mfa/webauthn/request-challenge
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<UserMfaEnableWebauthnChallengeResponse>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

UserChangePassword

Reset user account password

Endpoint	/api/v1/user/change-password
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
new_password*	string

UserCreateUser

Create a new user account

Endpoint	/api/v1/user/create_user
Method	POST
Token Action	User::CreateUser
Response Encoding	application/json
Response Type	ApiResponse<User>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_contact_name*	string	User contact name. Required.
target_email*	string	User email. Required.
target_password*	string|null	User password. Required. Must have at least 8 characters, one uppercase letter, one lowercase letter and one number.
target_is_billing	boolean	Should the user receive billing emails? Optional.
target_is_technical	boolean	Should the user receive technical email? Optional.
send_verification_email	boolean	Should an email verification token be sent? Optional.

UserDeleteUser

Delete a single user account

Endpoint	/api/v1/user/delete_user
Method	POST
Token Action	User::DeleteUser
Response Encoding	application/json
Response Type	ApiResponse<null>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_id*	string	Target ID of the user to delete. Required.

UserGetAccountSettings

Get basic user and company settings for the logged-in account

Endpoint	/api/v1/user/account-settings/get
Method	POST
Token Action	User::ReadSelf
Response Encoding	application/json
Response Type	ApiResponse<???>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

UserListUsers

List the other user accounts in my company

Endpoint	/api/v1/user/list_company_users
Method	POST
Token Action	User::PatchUser
Response Encoding	application/json
Response Type	ApiResponse<Array<User>>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.

UserPatchUser

Update a single user account

Endpoint	/api/v1/user/patch_user
Method	POST
Token Action	User::PatchUser
Response Encoding	application/json
Response Type	ApiResponse<User>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
target_id*	string	The target ID for the user. Required.
target_contact_name	string	The contact name for the user. Optional.
target_email	string	The email for the user. Optional.
target_password	string	The password for the user. Optional.
target_is_billing	boolean	Should the user receive billing emails? Optional.
target_is_technical	boolean	Should the user receive technical email? Optional.

UserSetAccountSettings

Set basic user and company settings for the logged-in account

Endpoint	/api/v1/user/account-settings/set
Method	POST
Token Action	User::PatchSelf
Response Encoding	application/json
Response Type	ApiResponse<string>

Request Parameters

Required parameters are marked with an asterisk*

Parameter name	Type	Description
auth_type*	string	Specify the authentication type (token). Required.
token	string	Specify the authentication token. Required if auth_type is token.
user_contact_name*	string
user_email*	string
user_is_2fa_required*	boolean
user_notifications_is_technical*	boolean
user_notifications_is_billing*	boolean
user_notifications_email_weekly_usage*	boolean
company_name*	string
company_phone_number*	string
company_address_street	string
company_address_city	string
company_address_postcode	string
company_address_country*	string

Constants

COMET_VERSION_* (number)

Name	Type	Value	Description
CURRENT	number	1
BEHIND_MAJOR	number	2
BEHIND_MINOR	number	3
BEHIND_PATCH	number	4

HOSTED_COMET_REGION_* (string)

Name	Type	Value	Description
US_WEST_1	string	us-west-1
US_EAST_1	string	us-east-1
EU_CENTRAL_1	string	eu-central-1
EU_WEST_2	string	eu-west-2
AP_SOUTHEAST_2	string	ap-southeast-2

Response Types

ApiResponse

Parameter name	Type	Description
status	string	The response status: ok or error
code	number	The response HTTP status code
data	\<any>	The response data

Examples Response Format

Example HTTP 200 Response:

{
    "status": "ok",
    "code": 200,
    "data": [
        { ... },
    ]
}

Example HTTP 401 Response:

{
    "status": "error",
    "code": 401,
    "data": {
        "message": "You do not have access to this resource."
    }
}

CloudViewLoginCredentials

Parameter name	Type	Description
status	string
login_url	string
login_postdata	string

CometVersion

Parameter name	Type	Description
version	string
shortstring	string
codename	string
platforms	Array<Platform>
release_notes_url	string
release_date	string
is_prerelease	boolean

CompanyApiToken

Parameter name	Type	Description
api_token	string
created_at	string
updated_at	string
revoked_at	string
last_used_at	string
permissions	string

HostedCometListRegionsResponse

Parameter name	Type	Description
id	string
description	string

HostedCometTenant

Parameter name	Type	Description
id	string
pending_delete	boolean
pending_delete_failed	boolean
admin_username	string
admin_password	string
send_as_display_name	string
send_as_email_address	string
send_as_email_verified	boolean
send_as_dmarc_verified	boolean
server_name	string
user_dns	string
created_at	string
date_deleted	string
use_custom_dns	boolean
user_custom_dns	string
smtp_mode	string
smtp_host	string
smtp_port	number
smtp_username	string
smtp_password	string
smtp_security	string
smtp_accept_invalid_certificate	boolean
favourited	boolean
num_devices_online	number
num_boosters_online	number
region	HOSTED_COMET_REGION_* (string)
version	string

Platform

Parameter name	Type	Description
platform_id	string
platform_name	string
platform_icon	string
filesize_bytes	number

Region

Parameter name	Type	Description
name	string
code	string
default_hosted_region	string
default_cspbw_region	string

ServerLicense

Parameter name	Type	Description
name	string
serial_number	string
created_at	string
num_clients_online	number
num_boosters_online	number
server_version	string
is_archived	boolean
is_outdated	COMET_VERSION_* (number)|null
enabled	boolean
comment	string
allowed_ip_address	string
allowed_machine_id	string
favourited	boolean
region	Region|null

User

Parameter name	Type	Description
id	string
contact_name	string
email	string
created_at	string
is_primary_contact	boolean
is_technical	boolean
is_billing	boolean
is_webpros	boolean
email_verified	boolean
twofa_required	boolean

UserMfaEnableWebauthnChallengeResponse

Parameter name	Type	Description
webauthn_challenge	string	The WebAuthn challenge (PublicKeyCredentialRequestOptions) encoded in JSON format.