Client — SSL

Updated Oct 4, 2026 Markdown

`GET /api/v1/client/ssl`

List SSL certificates (client)

Return SSL certificate status for all domains owned by the authenticated client.

Responses:

Status	Schema	Description
`200`	`ApiSuccess_list_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/ssl

`DELETE /api/v1/client/ssl/{domain}`

Delete SSL certificate (client)

Delete the SSL certificate for a domain owned by the authenticated client and disable HTTPS on the vhost.

Path parameters:

Name	Type	Required	Notes
`domain`	string	yes	—

Responses:

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

Response example (200):

JSON

{
  "message": "string",
  "status": "success"
}

cURL example:

shell

curl -X DELETE \
  -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/ssl/{domain}

`GET /api/v1/client/ssl/{domain}`

Get SSL certificate (client)

Return SSL certificate metadata for a specific domain owned by the authenticated client.

Path parameters:

Name	Type	Required	Notes
`domain`	string	yes	—

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 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/ssl/{domain}

`POST /api/v1/client/ssl/{domain}/custom`

Upload custom SSL certificate (client)

Upload a custom SSL certificate (cert + key + optional chain) for a domain owned by the authenticated client.

Path parameters:

Name	Type	Required	Notes
`domain`	string	yes	—

Body fields:

Field	Type	Required	Notes
`ca_bundle`	string	no	—
`certificate`	string	yes	minLength=1; maxLength=65536
`force`	boolean	no	default `False`
`private_key`	string	yes	minLength=1; maxLength=65536

Request body example:

JSON

{
  "ca_bundle": "string",
  "certificate": "string",
  "force": false,
  "private_key": "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/ssl/{domain}/custom

`POST /api/v1/client/ssl/{domain}/letsencrypt`

Request Let's Encrypt certificate (client)

Issue or renew a Let's Encrypt certificate for a domain owned by the authenticated client.

Path parameters:

Name	Type	Required	Notes
`domain`	string	yes	—

Request body example:

JSON

{
  "force": false,
  "force_renew": 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 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/ssl/{domain}/letsencrypt

Still Need Help?

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