Hosting: Websites
List websites
Retrieve a paginated list of websites (main and addon types) accessible to the authenticated client.
This endpoint returns websites from your hosting accounts as well as websites from other client hosting accounts that have shared access with you.
Use the available query parameters to filter results by username, order ID, enabled status, or domain name for more targeted results.
get/api/hosting/v1/websites
Query parameters
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
usernamestring nullable
Example:cl_user123
Filter by specific username
order_idinteger nullable
Example:123
Order ID
is_enabledboolean nullable
Example:true
Filter by enabled status
domainstring nullable
Example:example.com
Filter by domain name (exact match)
Response
Success response
Example response
{
"data": [
{
"domain": "example.com",
"vhost_type": "main",
"is_enabled": true,
"username": "cl_user123",
"client_id": 67890,
"order_id": 12345,
"created_at": "2024-01-15T10:30:00+00:00",
"root_directory": "/home/u123456798/domains/example.com/public_html",
"parent_domain": "parent.com"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}