Listings

Updated Oct 16, 2026 Markdown

GET /api/v1/backups

List local backups (server-wide)

One page of every account's local backups (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_BackupResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/backups

GET /api/v1/backups/schedules

List backup schedules (server-wide)

One page of every backup schedule on the server (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_BackupScheduleResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/backups/schedules

GET /api/v1/cron

List cron jobs (server-wide)

One page of the panel-managed cron jobs of every account (or one account's); by account, then in crontab order, by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_CronListItem__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/cron

GET /api/v1/domains

List primary and addon domains (server-wide)

One page of every account's primary and addon domains (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_DomainResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/domains

GET /api/v1/domains/parked

List parked domains (server-wide)

One page of every account's parked domains (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_ParkedDomainResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/domains/parked

GET /api/v1/domains/redirects

List redirects (server-wide)

One page of every account's redirects (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_RedirectResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/domains/redirects

GET /api/v1/domains/subdomains

List subdomains (server-wide)

One page of every account's subdomains (or one account's); newest first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_SubdomainResponse__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/domains/subdomains

GET /api/v1/emails

List mailboxes (server-wide)

One page of the server's mailboxes, or one hosting account's with account. search matches part of the address; active mailboxes come first unless sort=status. used_mb is the usage Dovecot's quota counts.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no pattern=^(address|quota|used|status|account)$
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_EmailListItem__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/emails

GET /api/v1/emails/forwarders

List forwarders (server-wide)

One page of the server's forwarders, or one hosting account's with account. search matches part of the source or the destination.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no pattern=^(source|destination|account)$
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_ForwarderListItem__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/emails/forwarders

GET /api/v1/ssl/certificates

List SSL certificates (server-wide)

One page of the certificates set up for every account's primary and addon domains (or one account's); latest expiry first by default.

Query parameters:

Name Type Required Notes
limit integer no minimum=1; maximum=200
offset integer no minimum=0
search string no Part of the row's text fields, any case.
account string no Only this hosting account's rows.
sort string no —
order string no pattern=^(asc|desc)$

Responses:

Status Schema Description
200 ApiSuccess_PaginatedResponse_SSLListItem__ Successful Response
422 HTTPValidationError Validation Error

Response example (200):

JSON
{
  "data": {
    "items": [
      "..."
    ],
    "limit": 1.0,
    "offset": 0,
    "total": 0
  },
  "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/ssl/certificates
Still Need Help?

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

Contact Us Open a Ticket