Webspace API: hosting, CMS and domains
Create, upgrade and cancel webspaces, install a CMS, switch PHP, reset the database password and link domains through the Sitequest REST API.
Create, upgrade and cancel webspaces, install a CMS, switch PHP, reset the database password and link domains through the Sitequest REST API.
List webspace plans, quotas, and feature pricing.
Required scope: —
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"free": { "diskGb": 1, "databases": 1, "bandwidthGb": 10, "allowedDomains": 1, "price": 0 },
"tiers": [
{ "diskGb": 5, "monthly": 4.99, "yearly": 49.90 },
{ "diskGb": 10, "monthly": 7.99, "yearly": 79.90 }
],
"addons": { "databasePerUnit": 0.50, "domainPerUnit": 1.00 }
}
}
| Field | Type | Description |
|---|---|---|
free |
object | Free-tier quotas (one per user). |
tiers |
array | Paid plans with monthly and yearly prices. |
addons |
object | Per-unit add-on pricing for databases and custom domains. |
curl https://site.quest/api/v1/webspaces/pricing
This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.
Provision a paid webspace by charging the user's saved payment mandate.
Required scope: webspace:provision
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
diskGb |
Yes | Disk allocation in GB (5-500). |
databases |
Yes | Number of MariaDB databases (10-50). |
cms |
No | STATIC (default), WORDPRESS, JOOMLA, DRUPAL, TYPO3. |
interval |
No | 1 month (default) or 12 months. |
name |
No | Display name. |
{
"data": {
"orderId": "507f1f77bcf86cd799439011",
"orderToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"diskGb": 10,
"databases": 10,
"cms": "WORDPRESS",
"interval": "1 month",
"status": "completed",
"paymentId": "tr_abc123"
}
}
| Field | Type | Description |
|---|---|---|
orderId / orderToken |
string | Use these with Get Order Status. |
status |
string | completed, payment_pending, or payment_failed. |
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_DISK |
diskGb is missing or out of range. |
| 400 | INVALID_DATABASES |
databases is missing or out of range. |
| 400 | INVALID_CMS |
cms is not one of the allowed values. |
| 403 | no_valid_mandate |
No saved payment method on file. |
| 403 | account_suspended |
Account is suspended. |
curl -X POST https://site.quest/api/v1/webspaces/create \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "diskGb": 10, "databases": 10, "cms": "WORDPRESS", "interval": "1 month" }'
This action is also available via the create_webspace MCP tool.
Claim the one-per-user free starter webspace. No billing.
Required scope: webspace:provision
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
cms |
No | Initial CMS to install. Default STATIC. |
{
"data": {
"id": "69e80ac118f081032f3b0416",
"subdomain": "ws-0862c.sitequest.eu",
"cms": "STATIC",
"isFree": true,
"status": "completed"
}
}
| Field | Type | Description |
|---|---|---|
subdomain |
string | Auto-generated *.sitequest.eu hostname. |
| Status | Code | Description |
|---|---|---|
| 409 | ALREADY_CLAIMED |
User has already claimed their free webspace. |
| 403 | ACCOUNT_SUSPENDED |
Account is suspended. |
curl -X POST https://site.quest/api/v1/webspaces/free \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "cms": "WORDPRESS" }'
This action is also available via the webspace_claim_free MCP tool.
List all webspaces accessible to the API key.
Required scope: webspace:read
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": [
{
"id": "69e80ac118f081032f3b0416",
"name": "My Blog",
"subdomain": "my-blog.sitequest.eu",
"customDomain": null,
"status": "ACTIVE",
"cms": "WORDPRESS",
"cmsVersion": "6.5",
"phpVersion": "8.3",
"isFree": false,
"region": "eu-central",
"diskSpaceGb": 5,
"diskUsageGb": 0.42,
"bandwidthGb": 100,
"bandwidthUsageGb": 1.25,
"databases": 10,
"databasesUsed": 1,
"linkedDomains": 1,
"createdAt": "2026-04-01T12:34:56.000Z"
}
]
}
| Field | Type | Description |
|---|---|---|
id |
string | Webspace identifier. |
subdomain |
string | The *.sitequest.eu hostname assigned to the webspace. |
status |
string | ACTIVE, SUSPENDED, INSTALLING, FAILED. |
cms |
string | Installed CMS: STATIC, WORDPRESS, JOOMLA, DRUPAL, TYPO3. |
phpVersion |
string | Active PHP version (8.1–8.5). |
isFree |
boolean | true if claimed via the free-tier endpoint. |
diskSpaceGb / bandwidthGb |
number | Allocated disk space and monthly bandwidth in GB. |
diskUsageGb / bandwidthUsageGb |
number | Cached usage counters in GB. |
curl https://site.quest/api/v1/webspaces \
-H "Authorization: Bearer sq_live_..."
This action is also available via the list_webspaces MCP tool.
Detail view of a single webspace including linked domains and live disk usage.
Required scope: webspace:read
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "69e80ac118f081032f3b0416",
"name": "My Blog",
"subdomain": "my-blog.sitequest.eu",
"customDomain": null,
"systemUser": "ws_0862c",
"status": "ACTIVE",
"cms": "WORDPRESS",
"phpVersion": "8.3",
"region": "eu-central",
"nodeName": "node-bf015",
"diskSpaceGb": 5,
"diskUsageGb": 0.42,
"diskUsageGbCached": 0.4,
"bandwidthGb": 100,
"bandwidthUsageGb": 1.25,
"databases": 10,
"databasesUsed": 1,
"linkedDomains": [
{ "id": "69ee...", "domain": "blog.example.com", "sslActive": true, "sslExpiry": "2027-04-22T00:00:00.000Z" }
],
"sslExpiry": "2027-04-22T00:00:00.000Z",
"createdAt": "2026-04-01T12:34:56.000Z",
"updatedAt": "2026-04-22T12:34:56.000Z"
}
}
| Field | Type | Description |
|---|---|---|
systemUser |
string | The Linux user (ws_<slug>) for SSH/SFTP login. |
diskUsageGb |
number | Live disk usage probe (falls back to cached value on probe failure). |
diskUsageGbCached |
number | Last cached disk usage in GB. |
linkedDomains |
array | Custom domains linked to this webspace, with SSL status. |
curl https://site.quest/api/v1/webspaces/69e80ac118f081032f3b0416 \
-H "Authorization: Bearer sq_live_..."
This action is also available via the get_webspace MCP tool.
SSH/SFTP connection details including hostname, port, user, host-key fingerprint, and a ready-to-paste ~/.ssh/config snippet.
Required scope: webspace:read
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"host": "ws-0862c.sitequest.eu",
"ip": "45.84.196.148",
"port": 22,
"username": "ws_0862c",
"hostKeyFingerprint": "SHA256:abcd1234...",
"sshConfigSnippet": "Host ws-0862c\n HostName ws-0862c.sitequest.eu\n User ws_0862c\n Port 22\n IdentityFile ~/.ssh/id_ed25519",
"sshExample": "ssh -p 22 ws_0862c@ws-0862c.sitequest.eu",
"sftpExample": "sftp -P 22 ws_0862c@ws-0862c.sitequest.eu"
}
}
| Field | Type | Description |
|---|---|---|
hostKeyFingerprint |
string | null | SHA-256 fingerprint fetched live via ssh-keyscan (best-effort, may be null on probe failure). |
sshConfigSnippet |
string | Drop-in snippet for ~/.ssh/config. |
curl https://site.quest/api/v1/webspaces/69e80ac1.../connection-info \
-H "Authorization: Bearer sq_live_..."
This action is also available via the webspace_get_ssh_info MCP tool.
Increase disk space or database count. Downgrades are blocked.
The pro-rated amount is charged to your saved payment method. The new limits apply once the payment is confirmed, and your monthly price rises accordingly. Use orderId to follow the order.
Required scope: webspace:scale
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
diskGb |
No | New disk allocation in GB. Must be ≥ current. |
databases |
No | New database count. Must be ≥ current. |
{
"data": {
"id": "69e80ac118f081032f3b0416",
"subdomain": "ws-0862c.sitequest.eu",
"orderId": "69e80ac118f081032f3b0420",
"paymentId": "tr_7UhSN1zuXS",
"status": "payment_pending",
"immediateCost": 2.15,
"newMonthlyAmount": 4.5,
"requested": { "diskGb": 10, "databases": 15 }
}
}
| Status | Code | Description |
|---|---|---|
| 400 | DOWNGRADE_NOT_ALLOWED |
Requested value is below current. |
| 400 | NO_CHANGES |
Body did not request any changes. |
| 403 | SPENDING_LIMIT_EXCEEDED |
The upgrade exceeds this API key's spending limit. |
| 403 | NOT_BILLING_OWNER |
Only the subscription owner can upgrade the webspace. |
| 409 | DUPLICATE_UPGRADE |
An upgrade is already pending for this webspace. |
| 409 | FREE_TIER_IMMUTABLE |
Free webspaces cannot be upgraded — delete and recreate as paid. |
curl -X PATCH https://site.quest/api/v1/webspaces/69e80ac118f081032f3b0416 \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "diskGb": 20 }'
This action is also available via the webspace_upgrade MCP tool, where confirm must be true.
Update the display name of a webspace. This is a local operation only and does not affect provisioning or the subdomain.
Required scope: webspace:manage
| Parameter | Type | Description |
|---|---|---|
id |
string | The webspace ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | New display name (1–255 characters) |
{
"name": "My Portfolio"
}
{
"data": {
"name": "My Portfolio",
"success": true
}
}
| Field | Type | Description |
|---|---|---|
name |
string | The new display name |
success |
boolean | Whether the rename was successful |
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_NAME |
Name must be 1–255 characters |
| 400 | INVALID_BODY |
Request body is not valid JSON |
| 404 | NOT_FOUND |
Webspace not found or not accessible |
curl -X POST "https://site.quest/api/v1/webspaces/69e80ac118f081032f3b0416/rename" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "My Portfolio"}'
This action is also available via the webspace_set_label MCP tool.
Switch the PHP version used by the webspace's vhost. Restarts OpenLiteSpeed gracefully.
Required scope: webspace:manage
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
phpVersion |
Yes | One of 8.1, 8.2, 8.3, 8.4, 8.5. |
{ "data": { "id": "69e80ac1...", "subdomain": "ws-0862c.sitequest.eu", "phpVersion": "8.4" } }
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_PHP_VERSION |
Version is not in the supported list. |
| 400 | NO_CHANGES |
Webspace already runs that version. |
curl -X PATCH https://site.quest/api/v1/webspaces/69e80ac1.../php \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "phpVersion": "8.4" }'
This action is also available via the webspace_set_php MCP tool.
Install (or reinstall) a CMS in the webspace docroot. Wipes existing content. Returns a jobId for SSE-based progress tracking.
Required scope: webspace:manage
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
cms |
Yes | STATIC, WORDPRESS, JOOMLA, DRUPAL, or TYPO3. |
{
"data": {
"id": "69e80ac1...",
"subdomain": "ws-0862c.sitequest.eu",
"cms": "WORDPRESS",
"jobId": "a1b2c3d4e5f6...",
"status": "installing"
}
}
| Field | Type | Description |
|---|---|---|
jobId |
string | Use this id to subscribe to install progress events. |
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_CMS |
cms is not one of the allowed values. |
| 409 | NODE_NOT_LINKED |
Webspace node is not linked to a VM. |
curl -X POST https://site.quest/api/v1/webspaces/69e80ac1.../cms \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "cms": "WORDPRESS" }'
This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.
Generate a new MariaDB password. The plaintext is returned once — store it immediately.
Required scope: webspace:manage
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "69e80ac1...",
"subdomain": "ws-0862c.sitequest.eu",
"dbName": "ws_0862c_db",
"dbUser": "ws_0862c",
"dbPassword": "Z9v…",
"dbHost": "localhost",
"warning": "Store this password now — it will not be shown again."
}
}
| Field | Type | Description |
|---|---|---|
dbPassword |
string | Returned only once. Cannot be retrieved later. |
dbHost |
string | MariaDB host. Always localhost (only reachable from inside the webspace). |
curl -X POST https://site.quest/api/v1/webspaces/69e80ac1.../db/password \
-H "Authorization: Bearer sq_live_..."
This action is also available via the webspace_reset_db_password MCP tool.
List custom domains linked to a webspace.
Required scope: webspace:read
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": [
{
"id": "69ee...",
"domain": "blog.example.com",
"domainId": "69dd...",
"sslActive": true,
"sslExpiry": "2027-04-22T00:00:00.000Z",
"createdAt": "2026-04-22T12:34:56.000Z"
}
]
}
| Field | Type | Description |
|---|---|---|
domainId |
string | Reference to the user's owning Domain record. |
curl https://site.quest/api/v1/webspaces/69e80ac1.../domains \
-H "Authorization: Bearer sq_live_..."
This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.
Link a custom domain to a webspace. Adds the vhost server-name and writes nginx/OLS config. Free-tier webspaces cannot link custom domains.
Required scope: webspace:manage
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
domain |
Yes | Full hostname to link (e.g. blog.example.com). |
domainId |
Yes | ID of the user's owning Domain record. |
dnsName |
Yes | Subdomain part for the auto-created A record. Use @ for root. |
{
"data": {
"id": "69ee...",
"domain": "blog.example.com",
"sslActive": false,
"sslExpiry": null,
"createdAt": "2026-04-22T12:34:56.000Z"
}
}
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_DOMAIN |
Hostname is missing or malformed. |
| 403 | FREE_TIER_NO_CUSTOM_DOMAINS |
Free webspaces cannot link custom domains. |
| 404 | DOMAIN_RECORD_NOT_FOUND |
Domain not found or not owned by this user. |
| 409 | DOMAIN_LIMIT_REACHED |
Webspace has reached its allowedDomains limit. |
| 409 | DOMAIN_ALREADY_LINKED |
This hostname is already linked elsewhere. |
curl -X POST https://site.quest/api/v1/webspaces/69e80ac1.../domains \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "domain": "blog.example.com", "domainId": "69dd...", "dnsName": "blog" }'
This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.
Unlink a custom domain from a webspace. Revokes the SSL cert and removes vhost + DNS record.
Required scope: webspace:manage
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{ "data": { "id": "69ee...", "domain": "blog.example.com", "unlinked": true } }
| Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND |
Linked-domain id does not belong to this webspace. |
curl -X DELETE https://site.quest/api/v1/webspaces/69e80ac1.../domains/69ee... \
-H "Authorization: Bearer sq_live_..."
This action is also available via the webspace_unlink_domain MCP tool.
Cancel a webspace subscription at the end of the current billing period. The webspace keeps running until the expiry date and is then removed with all its data. Free webspaces have no subscription and cannot be cancelled; use Delete Webspace instead.
Required scope: webspace:cancel
| Parameter | Type | Description |
|---|---|---|
id |
string | The webspace ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "507f1f77bcf86cd799439011",
"subdomain": "my-site",
"cancelled": true,
"expiresAt": "2026-04-15T00:00:00.000Z"
}
}
| Field | Type | Description |
|---|---|---|
id |
string | The webspace ID |
subdomain |
string | The webspace subdomain |
cancelled |
boolean | Always true after successful cancellation |
expiresAt |
string | ISO 8601 date when the webspace will expire |
| Status | Description |
|---|---|
| 403 | API key lacks the webspace:cancel scope |
| 404 | Webspace not found or you do not have owner access |
| 409 | Free webspace, or no active subscription found |
curl -X POST https://site.quest/api/v1/webspaces/507f1f77bcf86cd799439011/cancel \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
To reactivate a cancelled webspace before the expiry date, use the Reactivate Webspace endpoint.
This action is also available via the webspace_cancel MCP tool.
Reactivate a cancelled webspace subscription before the expiry date. The cancellation is cleared and billing continues.
Required scope: webspace:cancel
| Parameter | Type | Description |
|---|---|---|
id |
string | The webspace ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "507f1f77bcf86cd799439011",
"subdomain": "my-site",
"reactivated": true
}
}
| Status | Description |
|---|---|
| 403 | API key lacks the webspace:cancel scope |
| 404 | Webspace not found or you do not have owner access |
| 409 | Free webspace, or no cancelled subscription found |
curl -X POST https://site.quest/api/v1/webspaces/507f1f77bcf86cd799439011/uncancel \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
This action is also available via the webspace_uncancel MCP tool.
Permanently delete a free webspace. Confirmation required.
Paid webspaces cannot be deleted. Use Cancel Webspace: the webspace keeps running until the paid period ends and is then removed. After deleting, you cannot create another free webspace, because each account gets one.
Required scope: webspace:provision
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
confirm |
Yes | Must be exactly true. |
{ "data": { "id": "69e80ac118f081032f3b0416", "subdomain": "ws-0862c.sitequest.eu", "deleted": true } }
| Status | Code | Description |
|---|---|---|
| 400 | MISSING_CONFIRM |
Body did not include { "confirm": true }. |
| 409 | PAID_WEBSPACE |
The webspace is paid and must be cancelled instead. |
curl -X DELETE https://site.quest/api/v1/webspaces/69e80ac118f081032f3b0416 \
-H "Authorization: Bearer sq_live_..." \
-H "Content-Type: application/json" \
-d '{ "confirm": true }'
This action is also available via the webspace_delete MCP tool.