VPS API: create, scale and control servers
Create, upgrade, cancel and reinstall servers, switch power, mount ISOs and read monitoring and traffic through the Sitequest REST API.
Create, upgrade, cancel and reinstall servers, switch power, mount ISOs and read monitoring and traffic through the Sitequest REST API.
Returns VPS component sell prices grouped by hostsystem. Use this to calculate the monthly cost of a VPS configuration before ordering. Prices are returned as gross EUR by default; use currency and display to customise.
You can also pass resource amounts directly to have the API calculate the total price for a specific configuration.
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
| Parameter | Required | Description |
|---|---|---|
currency |
No | Price currency: EUR (default) or USD |
display |
No | Price display mode: gross (default) or net (excluding VAT) |
hostsystem |
No | Hostsystem identifier for calculation mode (e.g. de_epyc). Required when passing resource amounts. |
core |
No | Number of CPU cores |
mem |
No | RAM in GB |
nvme |
No | NVMe storage in GB (multiples of 10) |
ipv4 |
No | Number of IPv4 addresses |
backup |
No | Number of backup slots |
network |
No | Network speed in Mbit/s (multiples of 1000) |
hdd |
No | HDD storage in GB (multiples of 10) |
When no resource amounts are provided, the full pricing table is returned.
{
"data": {
"hostsystems": [
{
"hostsystem": "de_epyc",
"components": [
{ "component": "core", "price": 0.00, "step": 1, "min": 1, "max": 16, "unit": "core", "included": 0 },
{ "component": "mem", "price": 0.00, "step": 1, "min": 1, "max": 32, "unit": "GB", "included": 0 },
{ "component": "nvme", "price": 0.00, "step": 10, "min": 10, "max": 500, "unit": "GB", "included": 0 },
{ "component": "ipv4", "price": 0.00, "step": 1, "min": 1, "max": 8, "unit": "IP", "included": 0 },
{ "component": "backup", "price": 0.00, "step": 1, "min": 2, "max": 10, "unit": "slot", "included": 2 },
{ "component": "network", "price": 0.00, "step": 1000, "min": 1000, "max": 10000, "unit": "Mbit/s", "included": 1000 }
]
}
],
"yearlyDiscount": 10,
"currency": "EUR",
"display": "gross"
}
}
| Field | Type | Description |
|---|---|---|
hostsystems |
array | List of available hostsystems with component pricing |
hostsystems[].hostsystem |
string | Hostsystem identifier (e.g. de_epyc) |
hostsystems[].components |
array | Component prices for this hostsystem |
hostsystems[].components[].component |
string | Component name: core, mem, nvme, ipv4, backup, network, hdd |
hostsystems[].components[].price |
number | Price per step per month in the requested currency and display mode |
hostsystems[].components[].step |
number | What one step represents (e.g. 1 for mem = 1 GB) |
hostsystems[].components[].min |
number | Minimum allowed value for this component |
hostsystems[].components[].max |
number | Maximum allowed value for this component |
hostsystems[].components[].unit |
string | Human-readable unit (e.g. core, GB, IP) |
hostsystems[].components[].included |
number | Free tier amount included at no charge (e.g. 2 for backup = 2 free slots, 1000 for network = 1 Gbit/s free). 0 means no free tier. |
yearlyDiscount |
number | Discount percentage for yearly billing (e.g. 10 = 10% off) |
currency |
string | Currency code (EUR or USD) |
display |
string | Display mode (gross or net) |
When resource amounts are provided along with a hostsystem, the API calculates the total price for the given configuration. Only the components you specify are included in the result.
GET /api/v1/vps/pricing?hostsystem=de_epyc&core=4&mem=8&nvme=50&backup=4
{
"data": {
"hostsystem": "de_epyc",
"components": [
{ "component": "core", "quantity": 4, "included": 0, "subtotal": 0.00 },
{ "component": "mem", "quantity": 8, "included": 0, "subtotal": 0.00 },
{ "component": "nvme", "quantity": 50, "included": 0, "subtotal": 0.00 },
{ "component": "backup", "quantity": 4, "included": 2, "subtotal": 0.00 }
],
"monthly": 0.00,
"yearly": 0.00,
"yearlyDiscount": 10,
"currency": "EUR",
"display": "gross"
}
}
| Field | Type | Description |
|---|---|---|
hostsystem |
string | The hostsystem used for pricing |
components |
array | Breakdown per requested component |
components[].component |
string | Component name |
components[].quantity |
number | Requested amount |
components[].included |
number | Free tier amount (subtracted before pricing) |
components[].subtotal |
number | Monthly cost for this component after free tier deduction |
monthly |
number | Total monthly cost |
yearly |
number | Total yearly cost (monthly x 12 with yearly discount applied) |
yearlyDiscount |
number | Discount percentage applied to yearly billing |
currency |
string | Currency code (EUR or USD) |
display |
string | Display mode (gross or net) |
To calculate the monthly price for a VPS configuration, multiply the component price by the number of steps. Subtract the included free tier before pricing:
monthly_cost = SUM(component.price * MAX(0, quantity / component.step - component.included / component.step))
For example, 4 cores at 0.00 EUR/core + 8 GB RAM at 0.00 EUR/GB + 4 backup slots (2 included free) at 0.00 EUR/slot:
4 * 0.00 + 8 * 0.00 + (4 - 2) * 0.00 = 0.00 + 0.00 + 0.00 = 0.00 EUR/month
For yearly billing, apply the discount:
yearly_cost = monthly_cost * 12 * (1 - yearlyDiscount / 100)
# Get full pricing table
curl https://site.quest/api/v1/vps/pricing \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
# Get net prices in USD
curl "https://site.quest/api/v1/vps/pricing?currency=USD&display=net" \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
# Calculate price for a specific configuration
curl "https://site.quest/api/v1/vps/pricing?hostsystem=de_epyc&core=4&mem=8&nvme=50&backup=4" \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
This data is also available via the get_vps_pricing MCP tool.
Create a new VPS instance. This endpoint creates an order, charges your saved payment method, and provisions the server. Use the Get Order Status endpoint to track progress.
Required scope: vps:provision
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Parameter | Required | Description |
|---|---|---|
hostsystem |
Yes | Host system identifier (e.g. de_epyc, de_ryzen) |
os |
Yes | Operating system identifier (e.g. ubuntu-24.04) |
cores |
Yes | Number of CPU cores (>= 1) |
mem |
Yes | RAM in GB (e.g. 8) |
disk |
Yes | NVMe disk in GB (e.g. 20) |
ips |
No | Number of IPv4 addresses (default: 1) |
backupSlots |
No | Number of backup slots (default: 2) |
networkSpeed |
No | Network speed in Mbit/s (default: 1000) |
storage |
No | Additional HDD storage in GB |
name |
No | Display name for the VPS |
{
"data": {
"orderId": "507f1f77bcf86cd799439011",
"orderToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"hostsystem": "de_epyc",
"os": "ubuntu-24.04",
"cores": 4,
"mem": 8,
"disk": 80,
"status": "completed",
"paymentId": "tr_abc123"
}
}
| Field | Type | Description |
|---|---|---|
orderId |
string | Order ID for tracking |
orderToken |
string | Order token (UUID) for tracking |
hostsystem |
string | The host system used |
os |
string | The OS that will be installed |
cores |
number | CPU cores provisioned |
mem |
number | RAM in GB |
disk |
number | NVMe disk in GB |
status |
string | completed, payment_pending, or payment_failed |
paymentId |
string | Mollie payment ID |
| Status | Description |
|---|---|
completed |
Payment succeeded, VPS is being provisioned |
payment_pending |
Payment initiated (e.g. SEPA direct debit), awaiting confirmation |
payment_failed |
Payment was declined or failed |
Before using this endpoint, ensure:
Use the VPS Pricing endpoint to check available host systems, operating systems, and component pricing before creating a VPS.
| Status | Code | Description |
|---|---|---|
| 400 | MISSING_HOSTSYSTEM |
The hostsystem field is required |
| 400 | MISSING_OS |
The os field is required |
| 400 | INVALID_CORES |
The cores field must be >= 1 |
| 400 | INVALID_MEM |
The mem field must be >= 1 |
| 400 | INVALID_DISK |
The disk field must be >= 1 |
| 400 | PRICING_UNAVAILABLE |
Could not calculate price for VPS order |
| 403 | account_suspended |
Account is suspended |
| 403 | no_valid_mandate |
No valid payment method on file |
| 403 | no_billing_address |
Billing address is missing |
| 403 | INSUFFICIENT_SCOPE |
API key lacks vps:provision scope |
| 409 | DUPLICATE_ORDER |
An identical order is already pending |
# Create a basic VPS
curl -X POST https://site.quest/api/v1/vps/create \
-H "Authorization: Bearer sq_live_a94ecfca096d..." \
-H "Content-Type: application/json" \
-d '{
"hostsystem": "de_epyc",
"os": "ubuntu-24.04",
"cores": 4,
"mem": 8,
"disk": 80
}'
# Create a VPS with all options
curl -X POST https://site.quest/api/v1/vps/create \
-H "Authorization: Bearer sq_live_a94ecfca096d..." \
-H "Content-Type: application/json" \
-d '{
"hostsystem": "de_epyc",
"os": "ubuntu-24.04",
"cores": 8,
"mem": 16,
"disk": 160,
"ips": 2,
"backupSlots": 4,
"networkSpeed": 2000,
"name": "Production Server"
}'
This action is also available via the create_vm MCP tool.
Returns all VPS instances accessible to the authenticated API key.
Required scope: vps:read
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": [
{
"id": "699cdea2ab57a244bb5273fd",
"name": "my-server",
"status": "RUNNING",
"cores": 4,
"mem": 8,
"nvme": 20,
"hdd": 0,
"os": "Ubuntu 22.04",
"datacenter": "SkyLink Data Center BV",
"country": "NL",
"ip": "45.84.196.79",
"cpuUsage": 1.02,
"memUsage": 42.31,
"nvmeUsage": 0.44,
"hddUsage": 0,
"availability": 100,
"subscription": {
"cancelledAt": null,
"expiresAt": null,
"interval": "1 month"
},
"createdAt": "2026-02-23T23:11:30.525Z"
}
]
}
| Field | Type | Description |
|---|---|---|
id |
string | Unique server identifier |
name |
string | Server display name |
status |
string | Current status: RUNNING, STOPPED, INSTALLING, etc. |
cores |
number | Number of CPU cores |
mem |
number | RAM in GB |
nvme |
number | NVMe storage in GB |
hdd |
number | HDD storage in GB |
os |
string | Operating system |
datacenter |
string | Datacenter name |
country |
string | Country code (ISO 3166-1 alpha-2) |
ip |
string | null | Primary IPv4 address |
cpuUsage |
number | CPU usage percentage (0–100) |
memUsage |
number | Memory usage percentage (0–100) |
nvmeUsage |
number | NVMe usage percentage (0–100) |
hddUsage |
number | HDD usage percentage (0–100) |
availability |
number | Uptime percentage (0–100) |
subscription |
object | null | Subscription status: cancelledAt, expiresAt, interval |
createdAt |
string | ISO 8601 creation timestamp |
curl https://site.quest/api/v1/vps \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
This data is also available via the list_vms MCP tool.
Returns detailed information about a single VPS, including live status and configuration from the hosting provider.
Required scope: vps:read
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "699cdea2ab57a244bb5273fd",
"name": "my-server",
"status": "RUNNING",
"cores": 4,
"mem": 8,
"nvme": 20,
"hdd": 0,
"ips": 1,
"backupSlots": 0,
"networkSpeed": 1000,
"os": "Ubuntu 22.04",
"iso": null,
"datacenter": "SkyLink Data Center BV",
"country": "NL",
"cpuUsage": 1.02,
"memUsage": 42.31,
"nvmeUsage": 0.44,
"hddUsage": 0,
"availability": 100,
"ipv4": [
{
"address": "45.84.196.79",
"gateway": "45.84.196.1",
"rdns": "my-server.site.quest"
}
],
"ipv6": [],
"config": { ... },
"liveStatus": { ... },
"subscription": {
"cancelledAt": null,
"expiresAt": null,
"interval": "1 month"
},
"createdAt": "2026-02-23T23:11:30.525Z"
}
}
| Field | Type | Description |
|---|---|---|
id |
string | Unique server identifier |
name |
string | Server display name |
status |
string | Current status |
cores |
number | Number of CPU cores |
mem |
number | RAM in GB |
nvme |
number | NVMe storage in GB |
hdd |
number | HDD storage in GB |
ips |
number | Number of IP addresses |
backupSlots |
number | Number of backup slots |
networkSpeed |
number | Network speed in Mbit/s |
os |
string | Operating system |
iso |
string | null | Mounted ISO image, if any |
datacenter |
string | Datacenter name |
country |
string | Country code |
cpuUsage |
number | CPU usage percentage |
memUsage |
number | Memory usage percentage |
nvmeUsage |
number | NVMe usage percentage |
hddUsage |
number | HDD usage percentage |
availability |
number | Uptime percentage |
ipv4 |
array | IPv4 addresses with gateway and rDNS |
ipv6 |
array | IPv6 addresses |
config |
object | null | Live configuration from hosting provider |
liveStatus |
object | null | Live status from hosting provider |
subscription |
object | null | Subscription status (see below) |
createdAt |
string | ISO 8601 creation timestamp |
| Field | Type | Description |
|---|---|---|
cancelledAt |
string | null | When the subscription was cancelled (ISO 8601), or null if active |
expiresAt |
string | null | When the subscription expires (ISO 8601), or null if renewing |
interval |
string | null | Billing interval (e.g. "1 month", "12 months") |
Sensitive fields like password and username are stripped from the config object.
| Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND |
VPS not found or access denied |
curl https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
This data is also available via the get_vm MCP tool.
Upgrade VPS resources such as CPU cores, RAM, disk, backup slots, and network speed. Only upgrades are allowed — all values must be greater than or equal to the current configuration.
The upgrade is billed immediately using a pro-rated one-time charge based on the remaining days in the current billing period. Your saved payment method (mandate) is charged automatically. Infrastructure changes are applied asynchronously after payment confirmation, which typically takes a few seconds.
Your recurring subscription amount is updated to reflect the new monthly price after the upgrade.
Required scope: vps:scale
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
All fields are optional. Only provide the values you want to change. Omitted fields remain at their current values.
| Parameter | Required | Description |
|---|---|---|
cores |
No | New CPU core count (must be >= current) |
mem |
No | New RAM in GB (must be >= current) |
disk |
No | New NVMe disk in GB (must be >= current) |
storage |
No | New HDD storage in GB (must be >= current) |
backupSlots |
No | New backup slot count (must be >= current) |
networkSpeed |
No | New network speed in Mbit/s (must be >= current) |
{
"data": {
"id": "507f1f77bcf86cd799439011",
"name": "Production Server",
"orderId": "609c1f77bcf86cd799439022",
"paymentId": "tr_AbCdEf1234",
"status": "payment_pending",
"immediateCost": 4.52,
"newMonthlyAmount": 29.99,
"requested": {
"cores": 8,
"mem": 16,
"disk": 160,
"storage": 500,
"backupSlots": 4,
"networkSpeed": 2000
}
}
}
| Field | Type | Description |
|---|---|---|
id |
string | The VPS ID |
name |
string | The VPS display name |
orderId |
string | The upgrade order ID for tracking |
paymentId |
string | The Mollie payment ID |
status |
string | "payment_pending" (mandate charge initiated) or "completed" |
immediateCost |
number | Pro-rated one-time charge in EUR for the remaining billing period |
newMonthlyAmount |
number | Updated monthly subscription price in EUR after the upgrade |
requested |
object | The requested new resource configuration |
requested.cores |
number | Requested CPU core count |
requested.mem |
number | Requested RAM in GB |
requested.disk |
number | Requested NVMe disk in GB |
requested.storage |
number | Requested HDD storage in GB |
requested.backupSlots |
number | Requested backup slot count |
requested.networkSpeed |
number | Requested network speed in Mbit/s |
The upgrade cost is calculated as follows:
(newMonthly - currentMonthly) / totalDays * remainingDaysInfrastructure changes (CPU, RAM, disk, etc.) are applied automatically after payment confirmation.
| Status | Code | Description |
|---|---|---|
| 400 | DOWNGRADE_NOT_ALLOWED |
One or more values are less than the current configuration |
| 400 | NO_CHANGES |
No changes detected |
| 400 | NO_MANDATE |
No valid payment method on file |
| 400 | NO_SUBSCRIPTION |
No active subscription found for this VPS |
| 400 | NO_BILLING_DIFFERENCE |
No price difference for this upgrade |
| 403 | INSUFFICIENT_SCOPE |
API key lacks vps:scale scope |
| 404 | NOT_FOUND |
VPS not found or you do not have owner access |
| 409 | DUPLICATE_UPGRADE |
An upgrade order is already pending for this VPS |
| 500 | PAYMENT_NOT_CONFIGURED |
Payment service not configured |
| 502 | PAYMENT_FAILED |
Failed to create payment |
| 502 | SUBSCRIPTION_FETCH_FAILED |
Could not fetch subscription details |
# Upgrade CPU and RAM
curl -X POST https://site.quest/api/v1/vps/507f1f77bcf86cd799439011/upgrade \
-H "Authorization: Bearer sq_live_a94ecfca096d..." \
-H "Content-Type: application/json" \
-d '{"cores": 8, "mem": 16}'
# Upgrade disk and network speed
curl -X POST https://site.quest/api/v1/vps/507f1f77bcf86cd799439011/upgrade \
-H "Authorization: Bearer sq_live_a94ecfca096d..." \
-H "Content-Type: application/json" \
-d '{"disk": 320, "networkSpeed": 2000}'
This action is also available via the upgrade_vm MCP tool. When using MCP, the upgrade follows the same billing flow — your saved payment method is charged the pro-rated amount and infrastructure changes are applied after payment confirmation.
Execute a power action on a VPS: start, stop, or restart.
Required scope: vps:manage
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Field | Type | Required | Description |
|---|---|---|---|
action |
string | Yes | One of start, stop, or restart |
{
"action": "restart"
}
{
"data": {
"action": "restart",
"success": true
}
}
| Field | Type | Description |
|---|---|---|
action |
string | The power action that was executed |
success |
boolean | Whether the action was accepted |
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_ACTION |
The action value is not start, stop, or restart |
| 404 | NOT_FOUND |
VPS not found or not accessible |
| 502 | PROVIDER_ERROR |
Upstream provider error |
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/power" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action": "restart"}'
This action is also available via the vm_power MCP tool.
Reinstall the operating system on a VPS. This is a destructive action — all data on the server will be erased.
Required scope: vps:provision
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Field | Type | Required | Description |
|---|---|---|---|
os |
string | Yes | The operating system identifier (e.g. ubuntu-24.04) |
{
"os": "ubuntu-24.04"
}
{
"data": {
"os": "ubuntu-24.04",
"success": true
}
}
| Field | Type | Description |
|---|---|---|
os |
string | The operating system being installed |
success |
boolean | Whether the reinstall was initiated |
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_OS |
The os field is missing or not a string |
| 404 | NOT_FOUND |
VPS not found or not accessible |
| 502 | PROVIDER_ERROR |
Upstream provider error |
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/os" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"os": "ubuntu-24.04"}'
This action is also available via the vm_reinstall_os MCP tool.
Mount or unmount an ISO image on a VPS. Mounting an ISO allows booting from a custom installation image.
Required scope: vps:manage
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
Content-Type |
Yes | application/json |
| Field | Type | Required | Description |
|---|---|---|---|
os |
string | null | Yes | ISO identifier to mount, or null to unmount |
Mount an ISO:
{
"os": "ubuntu-24.04-live"
}
Unmount the current ISO:
{
"os": null
}
Mount response:
{
"data": {
"mounted": true,
"os": "ubuntu-24.04-live",
"success": true
}
}
Unmount response:
{
"data": {
"mounted": false,
"success": true
}
}
| Field | Type | Description |
|---|---|---|
mounted |
boolean | Whether an ISO is now mounted |
os |
string | The mounted ISO identifier (only present when mounting) |
success |
boolean | Whether the action was accepted |
| Status | Code | Description |
|---|---|---|
| 400 | MISSING_FIELD |
The os field is not present in the request body |
| 400 | INVALID_OS |
The os value is not a string or null |
| 404 | NOT_FOUND |
VPS not found or not accessible |
| 502 | PROVIDER_ERROR |
Upstream provider error |
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/iso" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"os": "ubuntu-24.04-live"}'
This action is also available via the vm_mount_iso MCP tool.
Generate a new root password for a VPS. The new password is returned in the response and should be stored securely.
Required scope: vps:exec
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
No request body is required.
{
"data": {
"password": "aB3$kLm9pQr2"
}
}
| Field | Type | Description |
|---|---|---|
password |
string | The newly generated root password |
| Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND |
VPS not found or not accessible |
| 502 | PROVIDER_ERROR |
Upstream provider error |
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/reset-password" \
-H "Authorization: Bearer YOUR_API_KEY"
This action is also available via the vm_reset_password MCP tool.
Update the display name of a VPS. This is a local operation only and does not affect the hosting provider.
Required scope: vps:manage
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS 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–32 characters) |
{
"name": "Production Server"
}
{
"data": {
"name": "Production Server",
"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–32 characters |
| 400 | INVALID_BODY |
Request body is not valid JSON |
| 404 | NOT_FOUND |
VPS not found or not accessible |
curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/rename" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Production Server"}'
This action is also available via the rename_vm MCP tool.
Returns CPU, memory, and ping history data for a VPS instance, along with downtime incident statistics.
Monitoring must be enabled on the server for timing data to be collected.
Required scope: vps:read
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"timings": [
{
"date": "2026-03-27T12:00:00Z",
"cpu": 12.5,
"mem": 42.3,
"ping": 1.2
},
{
"date": "2026-03-27T12:05:00Z",
"cpu": 8.1,
"mem": 41.8,
"ping": 1.1
}
],
"incidents": {
"statistic": {
"LAST_24_HOURS": {
"downtime": 0,
"availability": 100,
"incidents": 0,
"longestIncident": 0,
"averageIncident": 0
},
"LAST_7_DAYS": {
"downtime": 120,
"availability": 99.98,
"incidents": 1,
"longestIncident": 120,
"averageIncident": 120
}
},
"incidents": [
{
"start": "2026-03-22T03:15:00Z",
"end": "2026-03-22T03:17:00Z",
"downtime": 120,
"type": "PING_TIMEOUT"
}
]
}
}
}
| Field | Type | Description |
|---|---|---|
date |
string | ISO 8601 timestamp |
cpu |
number | CPU usage percentage (0–100) |
mem |
number | Memory usage percentage (0–100) |
ping |
number | Ping latency in milliseconds |
Statistics are provided for multiple time periods: LAST_24_HOURS, LAST_7_DAYS, LAST_14_DAYS, LAST_30_DAYS, LAST_90_DAYS, LAST_180_DAYS.
| Field | Type | Description |
|---|---|---|
downtime |
number | Total downtime in seconds |
availability |
number | Uptime percentage (0–100) |
incidents |
number | Number of downtime incidents |
longestIncident |
number | Longest incident in seconds |
averageIncident |
number | Average incident duration in seconds |
| Field | Type | Description |
|---|---|---|
start |
string | ISO 8601 start time |
end |
string | null | ISO 8601 end time (null if ongoing) |
downtime |
number | Duration in seconds |
type |
string | PING_TIMEOUT or VM_STOPPED |
curl -X GET "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/monitoring" \
-H "Authorization: Bearer YOUR_API_KEY"
This data is also available via the get_vm_monitoring MCP tool.
Returns the current month's bandwidth usage summary and a daily traffic log for a VPS.
Required scope: vps:read
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"usage": {
"month": "2026-03",
"usage": {
"total": 52428800,
"in": 31457280,
"out": 20971520
},
"limit": {
"monthly": 10737418240,
"additional": null,
"remaining": 10684989440,
"vmStatus": "normal"
}
},
"log": {
"month": "2026-03",
"log": [
{
"date": "2026-03-25",
"in": 10485760,
"out": 7340032
},
{
"date": "2026-03-26",
"in": 12582912,
"out": 8388608
},
{
"date": "2026-03-27",
"in": 8388608,
"out": 5242880
}
]
}
}
}
| Field | Type | Description |
|---|---|---|
month |
string | Month in YYYY-MM format |
usage.total |
number | Total bytes transferred this month |
usage.in |
number | Inbound bytes |
usage.out |
number | Outbound bytes |
| Field | Type | Description |
|---|---|---|
monthly |
number | Monthly bandwidth allowance in bytes |
additional |
number | null | Additional purchased bandwidth in bytes |
remaining |
number | Remaining bandwidth in bytes |
vmStatus |
string | normal or throttled |
| Field | Type | Description |
|---|---|---|
date |
string | Date in YYYY-MM-DD format |
in |
number | Inbound bytes for the day |
out |
number | Outbound bytes for the day |
curl -X GET "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/traffic" \
-H "Authorization: Bearer YOUR_API_KEY"
This data is also available via the get_vm_traffic MCP tool.
Cancel a VPS subscription at the end of the current billing period. The VPS keeps running until the expiry date. This replaces the old immediate-delete approach with a graceful cancellation model.
Required scope: vps:cancel
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "507f1f77bcf86cd799439011",
"name": "Production Server",
"cancelled": true,
"expiresAt": "2026-04-15T00:00:00.000Z"
}
}
| Field | Type | Description |
|---|---|---|
id |
string | The VPS ID |
name |
string | The VPS display name |
cancelled |
boolean | Always true after successful cancellation |
expiresAt |
string | ISO 8601 date when the VPS will expire |
| Status | Code | Description |
|---|---|---|
| 400 | NO_SUBSCRIPTION |
No active subscription found for this VPS |
| 400 | CANCEL_FAILED |
Failed to cancel the subscription |
| 403 | INSUFFICIENT_SCOPE |
API key lacks vps:cancel scope |
| 404 | NOT_FOUND |
VPS not found or you do not have owner access |
curl -X POST https://site.quest/api/v1/vps/507f1f77bcf86cd799439011/cancel \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
To reactivate a cancelled VPS before the expiry date, use the Uncancel VPS endpoint.
This action is also available via the cancel_vm MCP tool.
Reactivate a cancelled VPS subscription before the expiry date. This creates a new recurring subscription and clears the cancellation, so the VPS continues to renew normally.
Required scope: vps:cancel
| Parameter | Type | Description |
|---|---|---|
id |
string | The VPS ID |
| Header | Required | Value |
|---|---|---|
Authorization |
Yes | Bearer YOUR_API_KEY |
{
"data": {
"id": "507f1f77bcf86cd799439011",
"name": "Production Server",
"reactivated": true
}
}
| Field | Type | Description |
|---|---|---|
id |
string | The VPS ID |
name |
string | The VPS display name |
reactivated |
boolean | Always true after successful reactivation |
| Status | Code | Description |
|---|---|---|
| 400 | NOT_CANCELLED |
No cancelled subscription found for this VPS |
| 400 | UNCANCEL_FAILED |
Failed to reactivate the subscription |
| 403 | INSUFFICIENT_SCOPE |
API key lacks vps:cancel scope |
| 404 | NOT_FOUND |
VPS not found or you do not have owner access |
curl -X POST https://site.quest/api/v1/vps/507f1f77bcf86cd799439011/uncancel \
-H "Authorization: Bearer sq_live_a94ecfca096d..."
This action is also available via the uncancel_vm MCP tool.