API reference
Web & email hosting
Plesk-based website and email hosting subscriptions.
- List hosting subscriptions
GET /v1/hosting - Retrieve a hosting subscription
GET /v1/hosting/{id}
List hosting subscriptions
GET/v1/hosting
Requires a secret key with the read scope.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Items per page, 1-100 (default 50). |
offset | query | integer | Items to skip (default 0). |
Request
curl "https://api.newhost.co.za/v1/hosting" \
-H "Authorization: Bearer sk_live_..."Response
{
"data": [
{
"id": "clx8sub0001",
"hostingDomain": "acme.co.za",
"status": "ACTIVE",
"pleskStatus": "ACTIVE",
"billingCycle": "MONTHLY",
"currentPeriodEnd": "2026-10-01T00:00:00.000Z",
"plan": {
"slug": "plesk-web-pro",
"name": "Web Pro",
"category": "WEB"
},
"mailboxes": 3
}
],
"has_more": false
}Retrieve a hosting subscription
GET/v1/hosting/{id}
Includes live usage from the server and the mailbox list.
Requires a secret key with the read scope.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | The subscription ID. |
Request
curl "https://api.newhost.co.za/v1/hosting/ID" \
-H "Authorization: Bearer sk_live_..."Response
{
"data": {
"id": "clx8sub0001",
"hostingDomain": "acme.co.za",
"pleskStatus": "ACTIVE",
"usage": {
"Disk space used": "1.2 GB"
},
"mailboxes": [
{
"address": "[email protected]",
"quotaMb": 1024
}
]
}
}