API reference
Web & email hosting
Plesk-based website and email hosting subscriptions.
Try these requests in Postman: Download Postman collection (how to use it).
- List hosting subscriptions
GET /v1/hosting - Retrieve a hosting subscription
GET /v1/hosting/{id} - List website aliases
GET /v1/hosting/{id}/aliases - Add a website alias
POST /v1/hosting/{id}/aliases - Remove a website alias
DELETE /v1/hosting/{id}/aliases/{aliasId}
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 (mailboxes in use; forwarders are not listed). quotaMb is the mailbox size limit in MB, or null when the mailbox has no own limit and the plan's mailbox size applies (mailboxes created in the control panel). Changed October 2026: quotaMb can be null.
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
}
]
}
}List website aliases
GET/v1/hosting/{id}/aliases
Extra domains that show the same website (domain aliases). Website aliases are a paid add-on: price.monthlyGross per alias per month (12 x per year on yearly plans), billed with the subscription. Global Software Services (Pty) Ltd, the company behind NewHost, is not registered for VAT, so no VAT is added: price.monthlyGross is the full amount you pay, price.vatRegistered is false and price.vat is "0.00". quote is what adding one now would cost (the rest of the current cycle, prorated). dns is where an alias must point: an A record to dns.ip or a CNAME to dns.cname.
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/aliases" \
-H "Authorization: Bearer sk_live_..."Response
{
"data": {
"aliases": [
{
"id": "clx8als0001",
"domain": "example.com",
"status": "ACTIVE",
"billable": true,
"grandfathered": false,
"charged": true,
"dnsStatus": "OK",
"sslStatus": "ACTIVE",
"paidThrough": "2026-10-01T00:00:00.000Z",
"invoiceId": "clx8inv0002",
"addedAt": "2026-09-17T09:30:00.000Z",
"activatedAt": "2026-09-17T09:41:00.000Z"
}
],
"price": {
"code": "website_alias",
"name": "Website alias",
"active": true,
"monthlyGross": "250.00",
"net": "250.00",
"vat": "0.00",
"vatRegistered": false
},
"quote": {
"dueNow": "116.67",
"dueNowNet": "116.67",
"dueNowVat": "0.00",
"periodStart": "2026-09-17T09:30:00.000Z",
"periodEnd": "2026-10-01T00:00:00.000Z",
"prorated": "14 of 30 days",
"perCycle": "250.00",
"cycle": "MONTHLY"
},
"dns": {
"ip": "203.0.113.10",
"cname": "acme.co.za"
}
}
}Add a website alias
POST/v1/hosting/{id}/aliases
Orders an alias and creates an invoice for the prorated amount (paid from your wallet when auto-pay is on and the balance allows; otherwise pay it like any invoice). The alias is set up on the server once the invoice is paid (status PROVISIONING, then PENDING_DNS until its DNS points to the server, then ACTIVE with SSL). From then on it is charged with every renewal. Send dryRun: true to validate the domain, check its DNS and get the quote without ordering.
Requires a secret key with the write scope. Returns 201 on success.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | The subscription ID. |
Body
| Field | Type | Description |
|---|---|---|
domainrequired | string | The alias, e.g. example.com (www. is covered automatically). |
dryRun | boolean | Only validate, check DNS and quote. |
Request
curl -X POST "https://api.newhost.co.za/v1/hosting/ID/aliases" \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{"domain":"example.com"}'Response
{
"data": {
"alias": {
"id": "clx8als0001",
"domain": "example.com",
"status": "PENDING_PAYMENT",
"billable": true,
"grandfathered": false,
"charged": true,
"dnsStatus": "UNKNOWN",
"sslStatus": "NONE",
"paidThrough": null,
"invoiceId": "clx8inv0002",
"addedAt": "2026-09-17T09:30:00.000Z",
"activatedAt": null
},
"invoice": {
"id": "clx8inv0002",
"number": "NH-2026-000124",
"amount": "116.67",
"status": "UNPAID"
},
"amountDue": "116.67"
}
}Remove a website alias
DELETE/v1/hosting/{id}/aliases/{aliasId}
Stops future charges and removes the alias from the server. The unused whole days of the current paid period are credited to your wallet (credit in the response). An unpaid order for the alias is voided.
Requires a secret key with the write scope.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string | The subscription ID. |
aliasIdrequired | path | string | Alias ID from List website aliases. |
Request
curl -X DELETE "https://api.newhost.co.za/v1/hosting/ID/aliases/ALIASID" \
-H "Authorization: Bearer sk_live_..."Response
{
"data": {
"alias": {
"id": "clx8als0001",
"domain": "example.com",
"status": "REMOVING",
"billable": true,
"grandfathered": false,
"charged": true,
"dnsStatus": "OK",
"sslStatus": "ACTIVE",
"paidThrough": "2026-10-01T00:00:00.000Z",
"invoiceId": "clx8inv0002",
"addedAt": "2026-09-17T09:30:00.000Z",
"activatedAt": "2026-09-17T09:41:00.000Z",
"removedAt": "2026-09-20T10:00:00.000Z"
},
"credit": "83.34"
}
}