Client — Profile

Updated Oct 4, 2026 Markdown

`GET /api/v1/client/profile`

Get client profile

Return the authenticated client account profile (username, domain, email, status, 2FA, reseller info).

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X GET \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/client/profile

`PUT /api/v1/client/profile`

Update client profile

Update profile fields (email, sidebar choice) for the authenticated client account. A session opened by impersonation does not change the sidebar choice.

Body fields:

Field	Type	Required	Notes
`email`	string	no	—
`sidebar_collapsed`	boolean	no	The sidebar choice to keep: true collapsed, false expanded. A session opened by impersonation leaves the account's choice as it is.

Request body example:

JSON

{
  "email": "string",
  "sidebar_collapsed": false
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X PUT \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/client/profile

`POST /api/v1/client/profile/2fa/backup-codes/regenerate`

Regenerate backup codes (client)

Generate a fresh set of one-time backup codes for the authenticated client; old codes are invalidated.

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/client/profile/2fa/backup-codes/regenerate

`POST /api/v1/client/profile/2fa/disable`

Disable 2FA (client)

Disable 2FA for the authenticated client after verifying the account password.

Body fields:

Field	Type	Required	Notes
`password`	string	yes	minLength=1

Request body example:

JSON

{
  "password": "REPLACE_ME"
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/client/profile/2fa/disable

`POST /api/v1/client/profile/2fa/enable`

Enable 2FA (client)

Verify the OTP code and activate 2FA for the authenticated client; returns one-time backup codes.

Body fields:

Field	Type	Required	Notes
`code`	string	yes	minLength=6; maxLength=6; pattern=`^\d{6}$`

Request body example:

JSON

{
  "code": "string"
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/client/profile/2fa/enable

`POST /api/v1/client/profile/2fa/resend-code`

Resend email 2FA code (client)

Resend the email OTP code during client 2FA email setup.

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  https://your-server:2000/api/v1/client/profile/2fa/resend-code

`POST /api/v1/client/profile/2fa/setup`

Initiate 2FA setup (client)

Initiate two-factor authentication setup for the authenticated client (totp or email method).

Body fields:

Field	Type	Required	Notes
`method`	string	no	default `totp`; pattern=`^(totp\|email)$`

Request body example:

JSON

{
  "method": "totp"
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X POST \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/client/profile/2fa/setup

`PATCH /api/v1/client/profile/password`

Change client password

Change the authenticated client's password (requires current password). Invalidates all existing sessions.

Body fields:

Field	Type	Required	Notes
`current_password`	string	yes	minLength=1
`new_password`	string	yes	At least 8 characters and at most 72 bytes when UTF-8 encoded.; minLength=8; maxLength=128

Request body example:

JSON

{
  "current_password": "REPLACE_ME",
  "new_password": "REPLACE_ME"
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

curl -X PATCH \
  -H "X-WHost-Key: $WHOST_API_KEY" \
  -H "X-WHost-Timestamp: $(date +%s)" \
  -H "X-WHost-Nonce: $(openssl rand -hex 16)" \
  -H "X-WHost-Signature: $(compute_hmac)" \
  -H "Content-Type: application/json" \
  -d @body.json \
  https://your-server:2000/api/v1/client/profile/password

Still Need Help?

Our support team is here around the clock for anything you can't find above.