API Documentation

SSH Execute Command

Execute a one-shot SSH command on a VPS and return stdout, stderr, and exit code.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
command string Yes Shell command to execute (max 8192 characters)
timeout number No Timeout in seconds (1–300, default 30)
{
  "command": "uptime",
  "timeout": 10
}

Response

{
  "data": {
    "exitCode": 0,
    "stdout": " 14:32:01 up 12 days,  3:45,  0 users,  load average: 0.00, 0.01, 0.05\n",
    "stderr": "",
    "durationMs": 142
  }
}

Response Fields

Field Type Description
exitCode number The exit code of the command (0 = success)
stdout string Standard output
stderr string Standard error output
durationMs number Execution time in milliseconds

Errors

Status Code Description
400 INVALID_COMMAND Command is missing or not a string
400 COMMAND_TOO_LONG Command exceeds 8192 characters
400 INVALID_TIMEOUT Timeout is out of range (1–300)
404 NOT_FOUND VPS not found or not accessible
408 COMMAND_TIMEOUT Command timed out
502 SSH_AUTH_ERROR SSH authentication failed
502 SSH_CONNECTION_ERROR Could not connect to VPS

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/exec" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command": "uptime", "timeout": 10}'

MCP

This action is also available via the exec_command MCP tool.

Get SSH Security Status

Returns the SSH security settings of a VPS, including password authentication, HMAC algorithms, banner visibility, post-quantum key exchange and legacy cipher status.

Required scope: vps:read

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": {
    "passwordAuth": true,
    "sha1HmacEnabled": false,
    "bannerHidden": true,
    "bannerSupported": true,
    "postQuantumKexEnabled": true,
    "legacyCiphersEnabled": false,
    "postQuantumSupported": true,
    "opensshVersion": "9.2p1",
    "opensshPackageVersion": "1:9.2p1-2+deb12u3",
    "opensshLatestAvailable": "1:9.2p1-2+deb12u3",
    "updateAvailable": false,
    "readViaSSH": true
  }
}

Response Fields

Field Type Description
passwordAuth boolean Whether password authentication is enabled
sha1HmacEnabled boolean Whether SHA-1 based HMAC algorithms are enabled
bannerHidden boolean Whether the SSH version banner is hidden
bannerSupported boolean Whether banner hiding is supported on this OS
postQuantumKexEnabled boolean Whether post-quantum key exchange is enabled
legacyCiphersEnabled boolean Whether legacy ciphers (CBC/3DES) are allowed
postQuantumSupported boolean Whether the installed OpenSSH supports post-quantum KEX
opensshVersion string Installed OpenSSH version
opensshPackageVersion string Installed package version
opensshLatestAvailable string Latest available package version
updateAvailable boolean Whether an update is available
readViaSSH boolean Whether status was read via SSH (false = defaults/unknown)

Errors

Status Code Description
404 NOT_FOUND VPS not found or no access

Example

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/security" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This action is also available via the ssh_security MCP tool.

Update SSH Security Setting

Updates a single SSH security setting on a VPS. Each request changes exactly one setting.

Required scope: vps:manage

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Body

Field Type Required Description
setting string Yes The setting to change
enabled boolean Yes Whether to enable/disable the setting
useHypervisor boolean No Use hypervisor bypass (see below)

Available Settings

Setting Description
passwordAuth Enable/disable password authentication
sha1Hmac Enable/disable SHA-1 based HMAC algorithms
hideBanner Hide/show SSH version banner
postQuantumKex Enable/disable post-quantum key exchange
legacyCiphers Allow/disallow legacy ciphers (CBC/3DES)

Hypervisor Bypass

When SSH access is unavailable (e.g. after locking yourself out by disabling password auth without a deposited SSH key), you can set useHypervisor: true. The server will then execute the command via the hypervisor instead of using an SSH connection.

Note: Hypervisor commands may take slightly longer.

Response

{
  "data": {
    "message": "SSH security setting updated",
    "setting": "passwordAuth",
    "enabled": false
  }
}

Errors

Status Code Description
400 BAD_REQUEST Invalid setting name or value
404 NOT_FOUND VPS not found or no access
500 INTERNAL_ERROR SSH command failed — details in error message

Example

curl -X PUT "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/security" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"setting": "passwordAuth", "enabled": false}'

MCP

This action is also available via the update_ssh_security MCP tool.

List SSH Keys

Returns all SSH keys deployed on a VPS, including key IDs, display names, creation dates, and public keys.

Required scope: vps:read

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": [
    {
      "keyId": "abc123",
      "displayName": "my-key",
      "createDate": "2026-04-10T12:00:00Z",
      "publicKey": "ssh-ed25519 AAAAC3NzaC1..."
    }
  ]
}

Response Fields

Field Type Description
keyId string Unique identifier for the key
displayName string Display name given to the key
createDate string ISO 8601 creation timestamp
publicKey string The public key in OpenSSH format

Errors

Status Code Description
404 NOT_FOUND VPS not found or no access

Example

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/keys" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This data is also available via the list_ssh_keys MCP tool.

Generate SSH Key

Generates a new SSH key pair on a VPS. The public key is returned in the response. Optionally stores the key for web terminal access.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Body

Field Type Required Description
action string Yes Must be "generate"
displayName string No Display name for the key
useForWebTerminal boolean No Store the key for web terminal access (default: false)

Response

{
  "data": {
    "keyId": "abc123",
    "displayName": "my-key",
    "publicKey": "ssh-ed25519 AAAAC3NzaC1...",
    "webTerminalKeyId": "abc123"
  }
}

Response Fields

Field Type Description
keyId string Unique identifier for the generated key
displayName string Display name of the key
publicKey string The generated public key in OpenSSH format
webTerminalKeyId string | null The key ID if stored for web terminal, otherwise null

Errors

Status Code Description
400 INVALID_ACTION action must be "generate" or "upload"
404 NOT_FOUND VPS not found or no access
502 PROVIDER_ERROR Key generation failed at the provider

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/keys" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action": "generate", "displayName": "my-key", "useForWebTerminal": true}'

MCP

This action is also available via the generate_ssh_key MCP tool.

Upload SSH Key

Uploads an existing SSH public key to a VPS. Optionally stores the key ID for web terminal access.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Body

Field Type Required Description
action string Yes Must be "upload"
publicKey string Yes The SSH public key (must start with ssh-)
displayName string No Display name for the key
useForWebTerminal boolean No Store the key ID for web terminal access (default: false)

Response

{
  "data": {
    "keyId": "abc123",
    "displayName": "my-key",
    "publicKey": "ssh-ed25519 AAAAC3NzaC1...",
    "webTerminalKeyId": null
  }
}

Response Fields

Field Type Description
keyId string Unique identifier for the uploaded key
displayName string Display name of the key
publicKey string The uploaded public key
webTerminalKeyId string | null The key ID if stored for web terminal, otherwise null

Note: Uploading a public key for web terminal access only stores the key ID. The web terminal still requires a stored private key (from a previously generated key or rescue flow) to connect.

Errors

Status Code Description
400 INVALID_ACTION action must be "generate" or "upload"
400 MISSING_PUBLIC_KEY publicKey is required for upload
400 INVALID_PUBLIC_KEY Public key must start with ssh-
404 NOT_FOUND VPS not found or no access
502 PROVIDER_ERROR Key upload failed at the provider

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/keys" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action": "upload", "publicKey": "ssh-ed25519 AAAAC3NzaC1...", "displayName": "my-laptop"}'

MCP

This action is also available via the upload_ssh_key MCP tool.

Delete SSH Key

Deletes an SSH key from a VPS. If the deleted key was the active web terminal key, the terminal key setting is cleared.

Required scope: vps:manage

Path Parameters

Parameter Type Description
id string The VPS ID
keyId string The ID of the SSH key to delete

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": {
    "keyId": "abc123",
    "deleted": true
  }
}

Errors

Status Code Description
404 NOT_FOUND VPS not found or no access
502 PROVIDER_ERROR Key deletion failed at the provider

Example

curl -X DELETE "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/ssh/keys/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This action is also available via the delete_ssh_key MCP tool.

SFTP List Directory

List directory contents on a VPS. Returns file names, types, sizes, and modification times.

Required scope: vps:files

Path Parameters

Parameter Type Description
id string The VPS ID

Query Parameters

Parameter Type Required Description
path string Yes Absolute path of the directory to list

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": {
    "path": "/var/log",
    "entries": [
      {
        "name": "syslog",
        "isDirectory": false,
        "isSymlink": false,
        "size": 524288,
        "mode": "0644",
        "modifiedAt": "2025-01-15T10:30:00.000Z"
      },
      {
        "name": "nginx",
        "isDirectory": true,
        "isSymlink": false,
        "size": 4096,
        "mode": "0755",
        "modifiedAt": "2025-01-14T08:00:00.000Z"
      }
    ]
  }
}

Response Fields

Field Type Description
path string Resolved absolute path
entries array List of directory entries
entries[].name string File or directory name
entries[].isDirectory boolean Whether the entry is a directory
entries[].isSymlink boolean Whether the entry is a symbolic link
entries[].size number Size in bytes
entries[].mode string Permissions as a 4-digit octal string
entries[].modifiedAt string Last modification timestamp (ISO 8601)

Errors

Status Code Description
400 VALIDATION path is missing, not absolute or invalid
403 FORBIDDEN No owner access to the VPS
404 NOT_FOUND VPS or path not found
502 PROVIDER Connection or SFTP operation failed

Example

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/list?path=/var/log" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This action is also available via the list_files MCP tool.

SFTP Read File

Read file content from a VPS. Supports text (utf8) and binary (base64) encoding. Maximum file size is 32 MB.

Required scope: vps:files

Path Parameters

Parameter Type Description
id string The VPS ID

Query Parameters

Parameter Type Required Description
path string Yes Absolute path of the file to read
encoding string No utf8 (default) or base64

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "data": {
    "path": "/etc/nginx/nginx.conf",
    "content": "worker_processes auto;\nevents { ... }\n",
    "encoding": "utf8",
    "size": 1024
  }
}

Response Fields

Field Type Description
path string Normalized absolute path
content string File content in the requested encoding
encoding string The encoding used (utf8 or base64)
size number File size in bytes

Errors

Status Code Description
400 MISSING_PATH The path query parameter is missing
400 INVALID_PATH Path is not absolute
400 INVALID_ENCODING Encoding is not utf8 or base64
400 READ_ERROR File could not be read
404 NOT_FOUND VPS not found or not accessible
404 FILE_NOT_FOUND File does not exist
408 TIMEOUT File read timed out
413 FILE_TOO_LARGE File exceeds 32 MB
502 SSH_AUTH_ERROR SSH authentication failed
502 SSH_CONNECTION_ERROR Could not connect to VPS

Example

curl "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/read?path=/etc/hostname" \
  -H "Authorization: Bearer YOUR_API_KEY"

MCP

This action is also available via the read_file MCP tool.

SFTP Write File

Write content to a file on a VPS. Parent directories are created automatically. Supports text (utf8) and binary (base64) encoding. Maximum content size is 32 MB.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
path string Yes Absolute path of the file to write
content string Yes The file content
encoding string No utf8 (default) or base64 for binary files
{
  "path": "/etc/motd",
  "content": "Welcome to my server!\n"
}

Response

{
  "data": {
    "path": "/etc/motd",
    "size": 22
  }
}

Response Fields

Field Type Description
path string Normalized absolute path of the written file
size number File size in bytes after writing

Errors

Status Code Description
400 INVALID_BODY Request body is not valid JSON
400 MISSING_PATH Path is missing or not a string
400 INVALID_PATH Path is not absolute
400 MISSING_CONTENT Content is missing or not a string
400 INVALID_ENCODING Encoding is not utf8 or base64
400 WRITE_ERROR File could not be written
404 NOT_FOUND VPS not found or not accessible
408 TIMEOUT File write timed out
413 CONTENT_TOO_LARGE Content exceeds 32 MB
502 SSH_AUTH_ERROR SSH authentication failed
502 SSH_CONNECTION_ERROR Could not connect to VPS

Example

curl -X PUT "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/write" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/etc/motd", "content": "Welcome to my server!\n"}'

MCP

This action is also available via the write_file MCP tool.

SFTP Delete File or Directory

Delete a file or directory on a VPS. By default, only files and empty directories are removed; pass recursive: true to remove a directory and its contents. A small set of root system paths (/, /usr, /etc, /var, /home) are always rejected.

Required scope: vps:manage

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
path string Yes Absolute path of the file or directory to delete
recursive boolean No When true, delete a directory and all of its contents (default: false)
{
  "path": "/tmp/build-cache",
  "recursive": true
}

Response

{
  "data": {
    "path": "/tmp/build-cache",
    "deleted": true,
    "recursive": true
  }
}

Response Fields

Field Type Description
path string Normalized absolute path that was deleted
deleted boolean Always true on success
recursive boolean Whether recursive mode was used

Errors

Status Code Description
400 INVALID_BODY Request body is not valid JSON
400 INVALID_PATH Path is not absolute or is a protected root directory
400 DELETE_FAILED Generic deletion failure
403 DELETE_FAILED Permission denied on the target path
404 NOT_FOUND VPS not found, not accessible, or path does not exist
409 DELETE_FAILED Directory is not empty (omit recursive: true and try again)
502 SSH_AUTH SSH authentication failed
502 SSH_CONN Could not connect to VPS
504 SSH_TIMEOUT SSH command timed out

Example

curl -X DELETE "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/delete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/tmp/build-cache", "recursive": true}'

MCP

This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.

SFTP Rename or Move

Rename or move a file or directory on a VPS. The destination must not already exist; the operation will not overwrite existing files.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
from string Yes Absolute source path
to string Yes Absolute destination path
{
  "from": "/var/www/old-name.html",
  "to":   "/var/www/new-name.html"
}

Response

{
  "data": {
    "from": "/var/www/old-name.html",
    "to":   "/var/www/new-name.html",
    "renamed": true
  }
}

Response Fields

Field Type Description
from string Normalized source path
to string Normalized destination path
renamed boolean Always true on success

Errors

Status Code Description
400 INVALID_BODY Request body is not valid JSON
400 INVALID_FROM from is not an absolute path
400 INVALID_TO to is not an absolute path
400 RENAME_FAILED Generic rename failure
403 RENAME_FAILED Permission denied
404 NOT_FOUND VPS not found, not accessible, or source path does not exist
409 RENAME_FAILED Destination already exists
502 SSH_AUTH SSH authentication failed
502 SSH_CONN Could not connect to VPS
504 SSH_TIMEOUT SSH command timed out

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/rename" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from": "/var/www/old.html", "to": "/var/www/new.html"}'

MCP

This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.

SFTP Create Directory

Create a directory on a VPS. By default, parent directories are created as needed (mkdir -p behavior); set recursive: false to require that the parent already exists.

Required scope: vps:manage

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
path string Yes Absolute path of the directory to create
recursive boolean No Create parent directories as needed (default: true)
{
  "path": "/var/www/uploads/2026"
}

Response

{
  "data": {
    "path": "/var/www/uploads/2026",
    "created": true,
    "recursive": true
  }
}

Response Fields

Field Type Description
path string Normalized absolute path that was created
created boolean Always true on success
recursive boolean Whether parent directories were created automatically

Errors

Status Code Description
400 INVALID_BODY Request body is not valid JSON
400 INVALID_PATH Path is not absolute
400 MKDIR_FAILED Generic mkdir failure
403 MKDIR_FAILED Permission denied
404 MKDIR_FAILED Parent directory does not exist (non-recursive only)
404 NOT_FOUND VPS not found or not accessible
409 MKDIR_FAILED Directory already exists (non-recursive only)
502 SSH_AUTH SSH authentication failed
502 SSH_CONN Could not connect to VPS
504 SSH_TIMEOUT SSH command timed out

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/mkdir" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/var/www/uploads/2026"}'

MCP

This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.

SFTP Change Permissions

Change Unix permissions on a file or directory on a VPS. The mode may be supplied as an octal string (e.g. "0755", "644") or as a decimal integer in the range 0-4095.

Required scope: vps:exec

Path Parameters

Parameter Type Description
id string The VPS ID

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY
Content-Type Yes application/json

Request Body

Field Type Required Description
path string Yes Absolute path of the file or directory
mode string | number Yes Octal string ("0755", "644") or decimal int (0–4095)
{
  "path": "/var/www/html/script.sh",
  "mode": "0755"
}

Response

{
  "data": {
    "path": "/var/www/html/script.sh",
    "mode": "0755"
  }
}

Response Fields

Field Type Description
path string Normalized absolute path
mode string Applied permission mode as a 3- or 4-digit octal string

Errors

Status Code Description
400 INVALID_BODY Request body is not valid JSON
400 INVALID_PATH Path is not absolute
400 INVALID_MODE Mode is not an octal string or a valid decimal int (0–4095)
400 CHMOD_FAILED Generic chmod failure
403 CHMOD_FAILED Permission denied
404 CHMOD_FAILED Target path does not exist
404 NOT_FOUND VPS not found or not accessible
502 SSH_AUTH SSH authentication failed
502 SSH_CONN Could not connect to VPS
504 SSH_TIMEOUT SSH command timed out

Example

curl -X POST "https://site.quest/api/v1/vps/699cdea2ab57a244bb5273fd/sftp/chmod" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/var/www/html/script.sh", "mode": "0755"}'

MCP

This endpoint is not yet wrapped as an MCP tool. Use the REST endpoint above directly.