Servidor MCP
BorealHost
ai.borealhost/mcp
Qué hace este MCP
Provides web hosting and infrastructure management, including site deployment, DNS, domains, containers, compute, backups, caching, firewalls, and CDN controls.
Capacidades
Herramientas
184
herramientas
add_cron
Add a cron job to a site.
Requires: API key with write scope.
Args:
slug: Site identifier
schedule: Cron schedule (e.g. "*/5 * * * *", "0 2 * * *")
command: Command to execute
Returns:
{"added": true, "result": {...}}
Esquema de entrada
{'type': 'object', 'title': 'add_cronArguments', 'required': ['slug', 'schedule', 'command'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'command': {'type': 'string', 'title': 'Command'}, 'schedule': {'type': 'string', 'title': 'Schedule'}}}
add_domain_dns
Add a DNS record to a domain.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
record_type: "A", "AAAA", "CNAME", "MX", "TXT", or "SRV"
value: Record value (e.g. "1.2.3.4" for A, "mail.example.com" for MX)
subdomain: Subdomain part (e.g. "www", "mail"). Empty for apex domain.
priority: MX priority (required for MX records)
The DNS provider manages the effective TTL and does not expose a
per-record value through this service.
Returns:
{"success": true, "record": {"id": "...", "type": "A",
"subdomain": "www", "value": "1.2.3.4"}}
Errors:
VALIDATION_ERROR: Missing value, invalid record type
NOT_FOUND: Domain not found
Esquema de entrada
{'type': 'object', 'title': 'add_domain_dnsArguments', 'required': ['domain_name', 'record_type', 'value'], 'properties': {'value': {'type': 'string', 'title': 'Value'}, 'priority': {'type': 'integer', 'title': 'Priority', 'default': None}, 'subdomain': {'type': 'string', 'title': 'Subdomain', 'default': ''}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}, 'record_type': {'type': 'string', 'title': 'Record Type'}}}
add_firewall_rule
Add an IP firewall rule (allow or deny) and reload Nginx.
Supports IPv4, IPv6, and CIDR notation. Max 100 rules per site.
If a rule already exists for the IP, the action is updated.
Requires: API key with write scope.
Args:
slug: Site identifier
ip: IP address or CIDR (e.g. "1.2.3.4", "10.0.0.0/8", "2001:db8::/32")
action: "deny" (block) or "allow" (whitelist). Default: "deny"
Returns:
{"added": true, "ip": "1.2.3.4", "action": "deny"}
Esquema de entrada
{'type': 'object', 'title': 'add_firewall_ruleArguments', 'required': ['slug', 'ip'], 'properties': {'ip': {'type': 'string', 'title': 'Ip'}, 'slug': {'type': 'string', 'title': 'Slug'}, 'action': {'type': 'string', 'title': 'Action', 'default': 'deny'}}}
add_mailbox_alias
Add an alias on the same domain, preserving existing aliases.
Esquema de entrada
{'type': 'object', 'title': 'add_mailbox_aliasArguments', 'required': ['email', 'alias'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'alias': {'type': 'string', 'title': 'Alias'}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}}}
add_port_forward
Publish a container port on the node's public IP (TCP or UDP).
This is how inbound UDP reaches a container. There is no other way: the
container's own address is private, and the IP allow/deny rules of
add_firewall_rule cannot route anything.
PORT PRESERVATION MATTERS. Leave external_port at 0 and a port is allocated
from 10000-19999 â your service becomes reachable, but on a DIFFERENT
number. That is fine for HTTP or ssh and broken for every protocol that
carries its own port inside the payload: STUN, TURN, RTP/WebRTC, SIP,
WireGuard, QUIC. For those, pass external_port equal to internal_port.
A media server needs a contiguous span, not one port â pass
internal_port_end. A span is always published unchanged and counts as ONE
rule against your limit.
Some ports are refused because the host or its neighbours already answer on
them: 22, 80, 443, 2222, 9201, 51820, and the bands 9210-9250, 9310-9350
and 20000-20099. The last one is why the "forward UDP 20000-20999 for
Janus" recipe printed in most Nextcloud Talk guides will not work here â
pick a span above it, e.g. 20100-20599.
Requires: API key with write scope.
Args:
slug: Site identifier
internal_port: Port your service listens on inside the container
protocol: "tcp" or "udp". Default: "tcp"
label: Free-text note shown in the panel
external_port: Publish on this exact port; 0 allocates one from the pool
internal_port_end: End of a contiguous range (inclusive); 0 means one port
Returns:
{"id": "...", "external_port": 3478, "internal_port": 3478,
"protocol": "udp", "status": "active",
"public_address": "203.0.113.5:3478", "port_preserved": true}
Esquema de entrada
{'type': 'object', 'title': 'add_port_forwardArguments', 'required': ['slug', 'internal_port'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'label': {'type': 'string', 'title': 'Label', 'default': ''}, 'protocol': {'type': 'string', 'title': 'Protocol', 'default': 'tcp'}, 'external_port': {'type': 'integer', 'title': 'External Port', 'default': 0}, 'internal_port': {'type': 'integer', 'title': 'Internal Port'}, 'internal_port_end': {'type': 'integer', 'title': 'Internal Port End', 'default': 0}}}
add_redirect
Add an HTTP redirect rule to a site.
Requires: API key with write scope.
Args:
slug: Site identifier
source_path: Path to redirect, must start with "/" (e.g. "/old-page")
target_url: Destination URL
redirect_type: 301 (permanent, default) or 302 (temporary)
Returns:
{"id", "source_path", "target_url", "redirect_type"}
Esquema de entrada
{'type': 'object', 'title': 'add_redirectArguments', 'required': ['slug', 'source_path', 'target_url'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'target_url': {'type': 'string', 'title': 'Target Url'}, 'source_path': {'type': 'string', 'title': 'Source Path'}, 'redirect_type': {'type': 'integer', 'title': 'Redirect Type', 'default': 301}}}
add_site
Provision a site into a slot a plan you ALREADY PAY FOR includes.
Two different things can be meant by "create a site". Buying one is the
checkout flow (create_checkout â update â complete). This is the other: most
plans include several sites, and this uses one of them at no extra cost.
site_starter includes 5, site_plus 8, site_pro 12, and the agency plans
more. `whoami` and `list_sites` show what the account already holds.
â Prefer this over buying a second subscription when a slot is free. Sites
under ONE subscription share one CPU pool, one disk quota and one
rate-limit bucket â that shared budget is what the plan sells. Two
subscriptions split it, so the customer pays twice for capacity they had.
Requires: API key with write scope, on the account that owns the plan.
Args:
slug: Sub-domain for the new site (lowercase, digits, hyphens)
subscription_id: The subscription whose slot to use
client_name: Display name for the site (optional)
domain: Custom domain; defaults to <slug>.borealhost.ai
site_type: wordpress (default) | php | php-nodb | static-site. Choose
here rather than provisioning WordPress and calling set_site_type
afterwards â that installs a WordPress you then abandon in the
docroot, and it costs a minute of provisioning.
Returns:
{"subscription_id": "uuid", "provisioning_job_id": "uuid",
"slug": "my-second-site", "domain": "my-second-site.borealhost.ai",
"status": "provisioning"}
Poll get_site_status(slug) until it reports active.
Errors:
VALIDATION_ERROR: Plan includes a single site, slug taken, or every
slot is in use (the message reports used/total)
NOT_FOUND: Unknown subscription, or it belongs to another account
Esquema de entrada
{'type': 'object', 'title': 'add_siteArguments', 'required': ['slug', 'subscription_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'domain': {'type': 'string', 'title': 'Domain', 'default': ''}, 'site_type': {'type': 'string', 'title': 'Site Type', 'default': ''}, 'client_name': {'type': 'string', 'title': 'Client Name', 'default': ''}, 'subscription_id': {'type': 'string', 'title': 'Subscription Id'}}}
add_ssh_key
Inject your SSH public key into a site's container for direct SSH access.
The key is appended to /home/admin/.ssh/authorized_keys.
Only available for VPS/dedicated plans.
Requires: API key with write scope.
Args:
slug: Site identifier
public_key: SSH public key string. Supported types:
ssh-ed25519, ssh-rsa, ecdsa-sha2-nistp256/384/521
Returns:
{"success": true, "message": "SSH key added",
"ssh_command": "ssh admin@184.107.x.x"}
Errors:
VALIDATION_ERROR: Invalid or unsupported key format
FORBIDDEN: Plan does not support SSH
Esquema de entrada
{'type': 'object', 'title': 'add_ssh_keyArguments', 'required': ['slug', 'public_key'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'public_key': {'type': 'string', 'title': 'Public Key'}}}
add_subdomain
Create and route a subdomain of a site-linked domain.
Creates the DNS A record (if absent) pointing at the site's server,
then configures the nginx vhost and SSL certificate on that server.
The domain must already be linked to a site (see link_domain).
Idempotent: if the DNS record already exists and points at the site's
server, the nginx/SSL steps are (re)applied â safe to re-call, e.g. to
retry SSL after DNS propagation. May take up to 3 minutes when a
certificate is issued.
Requires: API key with write scope.
Args:
domain_name: Registrable domain linked to a site (e.g. "example.com")
subdomain: Subdomain label only, no dots (e.g. "blog")
Returns:
{"fqdn": "blog.example.com", "domain": "example.com",
"site": "my-site", "message": "..."}
Errors:
NOT_FOUND: Domain not found
VALIDATION_ERROR: Domain not linked to a site, invalid label, or
an existing record points at a different server
Esquema de entrada
{'type': 'object', 'title': 'add_subdomainArguments', 'required': ['domain_name', 'subdomain'], 'properties': {'subdomain': {'type': 'string', 'title': 'Subdomain'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
adopt_compute_instance
Turn an instance you are ALREADY running into a persistent volume.
Use this when you launched something, set it up, and then decided you want
to keep it. Nothing reboots and no data moves â the machine you have
becomes the volume, and you can detach it afterwards to stop paying for
compute while keeping the machine. Beats creating a volume and rebuilding.
Only instances launched with an ssh_public_key qualify. One launched with
your own user_data carries only your key, and a key cannot be added to a
machine we cannot already log into â check "managed_ssh" on the instance.
Requires: API key with write scope, and an active subscription.
Args:
instance_id: A running lsw.* instance you own
name: Label for the volume (defaults to the instance name)
Returns:
Volume dict with state "attached", wrapping that same instance. No
snapshot exists yet â the first one is taken on detach or snapshot.
Errors:
CONFLICT: Not running, already a volume, BorealHost Metal, or launched
without BorealHost management access
Esquema de entrada
{'type': 'object', 'title': 'adopt_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'default': ''}, 'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
attach_compute_volume
Restore a detached volume onto a fresh instance â optionally a new type.
Pass a different instance_type to move the same machine to different
hardware: this is the closest thing to changing instance type that the
provider allows, since it has no resize API at all.
The restore runs at first boot and the machine reboots into itself, so the
instance answers SSH BEFORE it is ready. Poll get_compute_volume and give
it a few minutes (measured: ~6 min for a 10 GB GPU machine end to end).
The machine keeps its SSH host keys, so your client will not warn about a
changed host identity.
Requires: API key with write scope.
Args:
volume_id: A volume in state "detached"
ssh_public_key: Required â installed via cloud-init at boot
instance_type: Defaults to the type it last ran on
root_disk_size: GB. May grow, never shrink below the volume's size.
Returns:
Volume dict with state "attached" and a new instance.
Errors:
CONFLICT: Volume is not detached, or has no snapshot yet
Esquema de entrada
{'type': 'object', 'title': 'attach_compute_volumeArguments', 'required': ['volume_id', 'ssh_public_key'], 'properties': {'volume_id': {'type': 'string', 'title': 'Volume Id'}, 'instance_type': {'type': 'string', 'title': 'Instance Type', 'default': ''}, 'root_disk_size': {'type': 'integer', 'title': 'Root Disk Size', 'default': 0}, 'ssh_public_key': {'type': 'string', 'title': 'Ssh Public Key'}}}
browse_backup
List one bounded page of immediate children in a backup directory.
This returns names and metadata only, never file contents. Use
``next_cursor`` from the response as ``cursor`` to request the next page.
Requires: API key with read scope.
Args:
slug: Site identifier
backup_id: UUID of a completed backup
path: Absolute directory path as it existed in the backup
cursor: Resume after this entry name (optional)
limit: Maximum entries, from 1 through 100
Errors:
SNAPSHOT_SCOPE_CHANGED: The path is allowed by today's schedule but was
not included when this backup was created; choose an included path
or a newer backup.
Esquema de entrada
{'type': 'object', 'title': 'browse_backupArguments', 'required': ['slug', 'backup_id', 'path'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 100}, 'cursor': {'type': 'string', 'title': 'Cursor', 'default': ''}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}}}
cache_flush
Flush all caches (Redis + WP object cache).
Requires: API key with write scope.
Args:
slug: Site identifier
Returns:
{"flushed": true}
Esquema de entrada
{'type': 'object', 'title': 'cache_flushArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
cache_status
Get cache status (Redis, WP object cache, hit rates).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"redis_running": true, "object_cache_enabled": true,
"hit_rate": 0.95, "memory_used_mb": 12}
Esquema de entrada
{'type': 'object', 'title': 'cache_statusArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
cache_toggle
Enable or disable the WordPress object cache.
Requires: API key with write scope.
Args:
slug: Site identifier
enable: true to enable, false to disable
Returns:
{"enabled": true}
Esquema de entrada
{'type': 'object', 'title': 'cache_toggleArguments', 'required': ['slug', 'enable'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'enable': {'type': 'boolean', 'title': 'Enable'}}}
cancel_checkout
Abandon an unpaid checkout and expire its Stripe payment link.
Use this to clean up abandoned attempts rather than leaving them to sit.
A completed checkout is never cancelled here â that would be a refund, and
it is refused.
Args:
checkout_id: Checkout session ID
Returns:
The checkout, with status "canceled".
Errors:
VALIDATION_ERROR: Checkout was already paid â cancel the subscription
from the panel instead
FORBIDDEN: Missing checkout_secret and no owning API key
Esquema de entrada
{'type': 'object', 'title': 'cancel_checkoutArguments', 'required': ['checkout_id'], 'properties': {'checkout_id': {'type': 'string', 'title': 'Checkout Id'}}}
cancel_scheduled_snapshot
Cancel a scheduled snapshot.
Requires: API key with write scope.
Args:
slug: Site identifier
schedule_id: UUID of the scheduled snapshot to cancel
Returns:
{"success": true, "message": "Scheduled snapshot cancelled"}
Errors:
NOT_FOUND: Schedule not found or already executed
Esquema de entrada
{'type': 'object', 'title': 'cancel_scheduled_snapshotArguments', 'required': ['slug', 'schedule_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'schedule_id': {'type': 'string', 'title': 'Schedule Id'}}}
claim_api_key
Claim an API key using a claim token from the container.
After calling request_api_key(), read the claim token from the path that
call returned in `claim_path`, on that site's container, and pass it here.
The token is single-use â once claimed, it cannot be used again.
The API key is automatically activated for this MCP session.
Args:
claim_token: The claim token string read from the container file
Returns:
{"api_key": "bh_...", "key_prefix": "bh_...",
"site_slug": "my-site", "scopes": ["read", "write"],
"message": "API key created and activated..."}
Errors:
VALIDATION_ERROR: Invalid, expired, or already-claimed token
Esquema de entrada
{'type': 'object', 'title': 'claim_api_keyArguments', 'required': ['claim_token'], 'properties': {'claim_token': {'type': 'string', 'title': 'Claim Token'}}}
clear_mailbox_forwarding
Clear forwarding; when Sieve exists, requires explicit clear_all_filters=true.
Esquema de entrada
{'type': 'object', 'title': 'clear_mailbox_forwardingArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'clear_all_filters': {'type': 'boolean', 'title': 'Clear All Filters', 'default': False}}}
cloudflare_proxy_status
Get Cloudflare proxy (CDN) status for a site.
Shows whether traffic is routed through Cloudflare's CDN (orange cloud)
or goes direct to origin (grey cloud / DNS-only).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"domain": "my-site.borealhost.ai", "has_record": true,
"proxied": true, "ip": "1.2.3.4"}
Esquema de entrada
{'type': 'object', 'title': 'cloudflare_proxy_statusArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
cloudflare_purge_cache
Purge Cloudflare CDN cache for a site.
Without urls: purges all cached content for the site's subdomain.
With urls: purges only the specified URLs (max 30 per call).
Requires: API key with write scope.
Args:
slug: Site identifier
urls: Optional list of specific URLs to purge
(e.g. ["https://my-site.borealhost.ai/style.css"])
Returns:
{"purged": true, "scope": "host", "domain": "my-site.borealhost.ai"}
Esquema de entrada
{'type': 'object', 'title': 'cloudflare_purge_cacheArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'urls': {'type': 'array', 'items': {}, 'title': 'Urls', 'default': None}}}
cloudflare_set_proxy
Enable or disable Cloudflare CDN proxy for a site.
When enabled (orange cloud): traffic goes through Cloudflare's CDN,
gets caching, DDoS protection, and SSL termination at the edge.
When disabled (grey cloud): traffic goes directly to origin server.
Requires: API key with write scope.
Args:
slug: Site identifier
proxied: true to enable CDN proxy, false to disable
Returns:
{"domain": "my-site.borealhost.ai", "proxied": true, "ip": "1.2.3.4"}
Esquema de entrada
{'type': 'object', 'title': 'cloudflare_set_proxyArguments', 'required': ['slug', 'proxied'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'proxied': {'type': 'boolean', 'title': 'Proxied'}}}
complete_checkout
Complete checkout with payment and start site provisioning.
The checkout must be in "ready" status.
Two payment methods:
- "stripe_checkout" (default): Returns a short, chat-safe payment URL.
**Present `payment_url` to the human â NOT `stripe_checkout_url`.**
The raw Stripe URL has a required `#fragment` that chat UIs routinely
strip when rendering markdown links, which causes Stripe to show
"page not found". `payment_url` is a short BorealHost redirect that
preserves the fragment via HTTP 302. After paying, the human lands on a
confirmation page (`confirmation_url`) â not on raw JSON. Then poll
get_checkout_status() until status becomes "completed". The API key
appears in the first poll after payment (shown once, then cleared).
Payment provisions the site; nothing else has to be called to create it.
- "stripe_payment_method": Charges a Stripe PaymentMethod directly.
Requires payment_method_id. On success, returns the API key immediately.
Args:
checkout_id: Checkout session ID
payment_method: "stripe_checkout" (returns a payment_url for a human),
"stripe_payment_method" (card on file), or "wallet" â pay from the
account's prepaid balance against THIS key's allowance. Check
get_wallet() first: `spendable_cents` is what you may actually
spend, and a wallet payment is refused for plans that order
dedicated hardware, which are authorised against a verified card
payment instead.
payment_method_id: Stripe PaymentMethod ID (pm_...). Required only
for "stripe_payment_method".
Returns (stripe_checkout):
{"id": "uuid", "status": "awaiting_payment",
"payment_url": "https://borealhost.ai/pay/<id>/?s=<secret>",
"confirmation_url": "https://borealhost.ai/pay/<id>/confirmation/?s=...",
"stripe_checkout_url": "https://checkout.stripe.com/c/pay/...",
"message": "Present payment_url to the human..."}
Returns (stripe_payment_method):
{"id": "uuid", "status": "completed", "api_key": "bh_...",
"api_key_message": "Store this API key securely...",
"subscription_id": "uuid", "provisioning_job_id": "uuid"}
Errors:
VALIDATION_ERROR: Missing payment_method_id for stripe_payment_method
FORBIDDEN: Checkout not in "ready" status
Esquema de entrada
{'type': 'object', 'title': 'complete_checkoutArguments', 'required': ['checkout_id'], 'properties': {'checkout_id': {'type': 'string', 'title': 'Checkout Id'}, 'payment_method': {'type': 'string', 'title': 'Payment Method', 'default': 'stripe_checkout'}, 'payment_method_id': {'type': 'string', 'title': 'Payment Method Id', 'default': ''}}}
configure_email_dns
Configure OpenSRS DKIM and merge email DNS, preserving other senders and subdomains.
Esquema de entrada
{'type': 'object', 'title': 'configure_email_dnsArguments', 'required': ['domain'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'dmarc_reporting_address': {'type': 'string', 'title': 'Dmarc Reporting Address', 'default': ''}}}
container_action
Start, stop, or restart a site's container.
Only for plans with a dedicated container (VPS / split-VPS / dedicated).
Shared-hosting sites share a container and cannot restart it. The
response reports the observed container state after the action.
Requires: API key with write scope.
Args:
slug: Site identifier
action: "start", "stop", or "restart"
Returns:
{"site", "action", "status": "running|stopped", "observed": true}
Errors:
VALIDATION_ERROR: Shared-hosting plan or unknown action
Esquema de entrada
{'type': 'object', 'title': 'container_actionArguments', 'required': ['slug', 'action'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'action': {'type': 'string', 'title': 'Action'}}}
create_alert_rule
Create an alert rule to monitor CPU, memory, or disk usage.
When the metric crosses the threshold, a notification is sent via
email and/or webhook. Max 10 rules per site.
Requires: API key with write scope.
Args:
slug: Site identifier
metric: "cpu", "memory", or "disk" (percentage-based)
threshold: Threshold value 0-100 (e.g. 90 for 90%)
operator: "gt" (greater than) or "lt" (less than). Default: "gt"
severity: "warning" or "critical". Default: "warning"
cooldown_minutes: Min minutes between repeated alerts. Default: 30
notify_email: Send email notification. Default: true
notify_webhook: Optional webhook URL for POST notifications
Returns:
{"id": "uuid", "metric": "disk", "threshold": 90, ...}
Esquema de entrada
{'type': 'object', 'title': 'create_alert_ruleArguments', 'required': ['slug', 'metric', 'threshold'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'metric': {'type': 'string', 'title': 'Metric'}, 'operator': {'type': 'string', 'title': 'Operator', 'default': 'gt'}, 'severity': {'type': 'string', 'title': 'Severity', 'default': 'warning'}, 'threshold': {'type': 'number', 'title': 'Threshold'}, 'notify_email': {'type': 'boolean', 'title': 'Notify Email', 'default': True}, 'notify_webhook': {'type': 'string', 'title': 'Notify Webhook', 'default': ''}, 'cooldown_minutes': {'type': 'integer', 'title': 'Cooldown Minutes', 'default': 30}}}
create_api_key
Create a new API key with specified scopes.
Cannot create keys with higher scopes than the current key.
Site-scoped keys restrict access to a single site.
email_domains restricts the key to email tools on the named domains; use
email:read, email:write and optionally email:signon scopes. expires_at is
an ISO timestamp; ip_allowlist accepts IP addresses and CIDR networks.
Requires: API key with write scope.
Args:
name: Human-readable name for the key (1-100 chars)
scopes: Comma-separated scopes. Options: "read", "read,write",
"read,write,admin". Default: "read"
site_slug: Optional â restrict the key to a single site.
Omit for account-wide access.
Returns:
{"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...",
"name": "My Key", "scopes": ["read", "write"],
"message": "Store this API key securely â it will not be shown again."}
Errors:
VALIDATION_ERROR: Invalid name, scopes, or max 25 active keys
FORBIDDEN: Cannot create keys with higher scopes than current key
Esquema de entrada
{'type': 'object', 'title': 'create_api_keyArguments', 'required': ['name'], 'properties': {'name': {'type': 'string', 'title': 'Name'}, 'scopes': {'type': 'string', 'title': 'Scopes', 'default': 'read'}, 'site_slug': {'type': 'string', 'title': 'Site Slug', 'default': ''}, 'expires_at': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Expires At', 'default': None}, 'ip_allowlist': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Ip Allowlist', 'default': None}, 'email_domains': {'anyOf': [{'type': 'array', 'items': {'type': 'string'}}, {'type': 'null'}], 'title': 'Email Domains', 'default': None}}}
create_b2_snapshot
Create a B2 cloud-backed snapshot (zero local disk, async).
Streams container data directly to Backblaze B2 via restic.
No local disk impact â billed separately at cost+5%.
Runs in background â returns immediately with status "creating".
Poll list_snapshots() to check when status becomes "completed".
Only available for VPS plans.
Requires: API key with write scope.
Args:
slug: Site identifier
description: Optional description (max 200 chars)
Returns:
{"id": "uuid", "name": "...", "status": "creating",
"storage_type": "b2",
"message": "B2 cloud snapshot started. Poll list_snapshots()..."}
Errors:
VALIDATION_ERROR: Not a VPS plan or max snapshots reached
Esquema de entrada
{'type': 'object', 'title': 'create_b2_snapshotArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'description': {'type': 'string', 'title': 'Description', 'default': ''}}}
create_backup
Create a manual backup (runs asynchronously).
The backup starts in the background. Poll list_backups() to check status.
Requires: API key with write scope.
Args:
slug: Site identifier
Returns:
{"id": "uuid", "status": "pending",
"message": "Backup started. Poll list_backups() to check status."}
Esquema de entrada
{'type': 'object', 'title': 'create_backupArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
create_checkout
Start a new checkout session to purchase a hosting plan.
No authentication needed. After creating, call update_checkout to set
buyer info, then complete_checkout to pay.
The response carries a `checkout_secret`, returned ONCE, that every later
step of this checkout requires. It is held in memory for this MCP session
and sent automatically â but it is gone if the server restarts. If a session
key is set, the checkout is owned by that account and the API key authorizes
the later steps on its own, which is the durable path.
Args:
sku: Plan SKU in format bh_{plan_slug}_{monthly|annual}.
Examples: "bh_site_starter_monthly", "bh_site_pro_annual",
"bh_site_managed_monthly", "bh_site_business_annual".
Call list_plans() to discover all available plan slugs.
Returns:
{"id": "uuid", "sku": "bh_site_starter_monthly",
"plan_slug": "site_starter", "billing_period": "monthly",
"status": "not_ready", "buyer_email": "", "requested_slug": "",
"created_at": "iso8601", "checkout_secret": "base64-token"}
Errors:
VALIDATION_ERROR: Invalid SKU format or unknown plan
RATE_LIMITED: Max 10 checkouts per IP per hour
Esquema de entrada
{'type': 'object', 'title': 'create_checkoutArguments', 'required': ['sku'], 'properties': {'sku': {'type': 'string', 'title': 'Sku'}}}
create_compute_volume
Create a persistent machine and boot its first instance.
Start here, then set the machine up however you like (install packages,
drivers, models). Everything you do becomes part of the volume the first
time you detach or snapshot it.
While attached you pay hourly compute; while detached you pay only for
stored bytes (CA$0.03/GB/month). Stopping an instance does NOT save money
on this provider â detaching is what stops the compute charge.
Requires: API key with write scope, and an active subscription.
Args:
name: Label for the volume, e.g. "trainer"
image_id: From list_compute_images, e.g. "UBUNTU_24_04_64BIT".
Cannot change later â restores must land on the same OS.
instance_type: From list_compute_types, e.g. "lsw.g6.xlarge".
CAN change on every later attach.
ssh_public_key: Required. Volume instances always boot via cloud-init,
so this is the only way in.
root_disk_size: GB. Defaults to the type's minimum (or 25).
Returns:
Volume dict with state "attached". Poll get_compute_volume until
instance.state is "running" (~1-3 min).
Errors:
PAYMENT_REQUIRED: No active subscription
LIMIT_EXCEEDED: Volume cap reached
NOT_AVAILABLE: Volumes not enabled on this deployment
Esquema de entrada
{'type': 'object', 'title': 'create_compute_volumeArguments', 'required': ['name', 'image_id', 'instance_type', 'ssh_public_key'], 'properties': {'name': {'type': 'string', 'title': 'Name'}, 'image_id': {'type': 'string', 'title': 'Image Id'}, 'instance_type': {'type': 'string', 'title': 'Instance Type'}, 'root_disk_size': {'type': 'integer', 'title': 'Root Disk Size', 'default': 0}, 'ssh_public_key': {'type': 'string', 'title': 'Ssh Public Key'}}}
create_directory
Create a directory in a site's container.
Creates parent directories if they don't exist.
Requires: API key with write scope.
Args:
slug: Site identifier
path: Relative path of the directory to create
Returns:
{"success": true, "path": "uploads/2024", "message": "Directory created"}
Errors:
NOT_FOUND: Unknown slug
FORBIDDEN: Protected system path
Esquema de entrada
{'type': 'object', 'title': 'create_directoryArguments', 'required': ['slug', 'path'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}}}
create_email_mailbox
Create a domain-addressed billable mailbox. Password returned once; retries omit it.
Esquema de entrada
{'type': 'object', 'title': 'create_email_mailboxArguments', 'required': ['domain', 'local_part'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'label': {'type': 'string', 'title': 'Label', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'password': {'type': 'string', 'title': 'Password', 'default': ''}, 'quota_gb': {'type': 'integer', 'title': 'Quota Gb', 'default': 5}, 'local_part': {'type': 'string', 'title': 'Local Part'}, 'display_name': {'type': 'string', 'title': 'Display Name', 'default': ''}, 'idempotency_key': {'type': 'string', 'title': 'Idempotency Key', 'default': ''}, 'smtp_sent_limit': {'anyOf': [{'type': 'integer'}, {'type': 'null'}], 'title': 'Smtp Sent Limit', 'default': None}}}
create_ftp_account
Create an SFTP account on a site.
The account is chrooted to /var/www and lands in home_dir. Password must be
at least 8 characters. Username must be lowercase alphanumeric.
Requires: API key with write scope.
Args:
slug: Site identifier
username: SFTP username (lowercase, max 32 chars)
password: Password (min 8 chars)
home_dir: Landing directory inside /var/www. Leave empty to land at
/var/www itself, which lists every site directory.
Returns:
{"success": true, "username": "sftpuser", "home_dir": "/wordpress",
"protocol": "sftp"}
Esquema de entrada
{'type': 'object', 'title': 'create_ftp_accountArguments', 'required': ['slug', 'username', 'password'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'home_dir': {'type': 'string', 'title': 'Home Dir', 'default': ''}, 'password': {'type': 'string', 'title': 'Password'}, 'username': {'type': 'string', 'title': 'Username'}}}
create_mailbox
Create a mailbox on the site's email domain.
Password is generated when omitted and returned ONCE â store it.
Each mailbox adds to the subscription's email billing.
Requires: API key with write scope.
Args:
slug: Site identifier
local_part: Part before the @ (e.g. "info")
display_name: Optional display name
password: Optional password (generated if empty)
Returns:
{"email", "password", "message"}
Esquema de entrada
{'type': 'object', 'title': 'create_mailboxArguments', 'required': ['slug', 'local_part'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'password': {'type': 'string', 'title': 'Password', 'default': ''}, 'local_part': {'type': 'string', 'title': 'Local Part'}, 'display_name': {'type': 'string', 'title': 'Display Name', 'default': ''}}}
create_mailbox_token
Issue a temporary mail-services token with no OMA access. Requires email:signon.
Use 60, 120, ... 1440 minutes. OpenSRS rejects fractional hours; no rounding up.
Esquema de entrada
{'type': 'object', 'title': 'create_mailbox_tokenArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'duration_minutes': {'type': 'integer', 'title': 'Duration Minutes', 'default': 60}}}
create_snapshot
Create a local container snapshot (async).
Runs in background â returns immediately with status "creating".
Poll list_snapshots() to check when status becomes "completed" or "failed".
Available for VPS, dedicated, and cloud plans (any plan with max_snapshots > 0).
Local snapshots are stored on the host disk and count against disk quota.
Requires: API key with write scope.
Args:
slug: Site identifier
description: Optional description (max 200 chars)
Returns:
{"id": "uuid", "name": "snap-...", "status": "creating",
"storage_type": "local",
"message": "Snapshot started. Poll list_snapshots() to check status."}
Errors:
VALIDATION_ERROR: Max snapshots reached or insufficient disk quota
Esquema de entrada
{'type': 'object', 'title': 'create_snapshotArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'description': {'type': 'string', 'title': 'Description', 'default': ''}}}
create_support_ticket
Open a support ticket with the BorealHost team.
Use this to escalate platform-side problems you cannot fix with the
available tools (billing issues, infrastructure faults, API bugs).
A human answers every ticket â poll get_support_ticket for updates.
Requires: API key with write scope.
Args:
subject: Short summary (max 200 chars)
message: Full description (max 20000 chars)
category: Optional (e.g. "technical", "billing")
site: Optional site slug the ticket concerns
Returns:
{"id", "subject", "status", "message": "Ticket created..."}
Esquema de entrada
{'type': 'object', 'title': 'create_support_ticketArguments', 'required': ['subject', 'message'], 'properties': {'site': {'type': 'string', 'title': 'Site', 'default': ''}, 'message': {'type': 'string', 'title': 'Message'}, 'subject': {'type': 'string', 'title': 'Subject'}, 'category': {'type': 'string', 'title': 'Category', 'default': ''}}}
create_webhook
Register a webhook endpoint for platform events.
Events (backup failures, security notices, hosting incidents, billing)
are POSTed as JSON, signed with X-BH-Signature (HMAC-SHA256 of the raw
body). The signing secret is returned ONCE. Categories: billing,
security, hosting, decommission, general â empty list means all.
Endpoints auto-disable after 20 consecutive failures.
Requires: API key with write scope.
Returns:
{"id", "url", "events", "secret", "message"}
Esquema de entrada
{'type': 'object', 'title': 'create_webhookArguments', 'required': ['url'], 'properties': {'url': {'type': 'string', 'title': 'Url'}, 'events': {'type': 'array', 'items': {}, 'title': 'Events', 'default': None}}}
database_search_replace
Search and replace in WordPress database (e.g. URL migration).
Handles serialized data safely. Use dry_run=true first to preview changes.
Requires: API key with write scope.
Args:
slug: Site identifier
old: String to search for (e.g. "http://old-domain.com")
new: Replacement string (e.g. "https://new-domain.com")
dry_run: Preview only without making changes (default: true)
Returns:
{"replacements": 42, "tables_affected": 5, "dry_run": true}
Esquema de entrada
{'type': 'object', 'title': 'database_search_replaceArguments', 'required': ['slug', 'old', 'new'], 'properties': {'new': {'type': 'string', 'title': 'New'}, 'old': {'type': 'string', 'title': 'Old'}, 'slug': {'type': 'string', 'title': 'Slug'}, 'dry_run': {'type': 'boolean', 'title': 'Dry Run', 'default': True}}}
decommission
Delete a site and schedule resource cleanup (7-day grace period).
WARNING: This is destructive. The site will be inaccessible immediately.
After the grace period, its active service data is deleted. A final backup
remains recoverable for 30 days; immutable copies may remain until their
retention locks expire.
Best practice: create a snapshot before decommissioning.
Requires: API key with admin scope.
Args:
slug: Site identifier
Returns:
{"success": true, "message": "Site scheduled for deletion",
"grace_period_days": 7}
Errors:
NOT_FOUND: Unknown slug
Esquema de entrada
{'type': 'object', 'title': 'decommissionArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
delete_account
Permanently anonymize the account. Cancels subscriptions, deactivates keys.
WARNING: This is irreversible. The account will be soft-deleted and all
personal data anonymized. All sites will be decommissioned.
Requires: API key with admin scope.
Returns:
{"success": true, "message": "Account anonymized"}
Esquema de entrada
{'type': 'object', 'title': 'delete_accountArguments', 'properties': {}}
delete_alert_rule
Delete an alert rule.
Requires: API key with write scope.
Args:
slug: Site identifier
rule_id: UUID of the alert rule to delete
Returns:
{"deleted": true, "id": "uuid"}
Esquema de entrada
{'type': 'object', 'title': 'delete_alert_ruleArguments', 'required': ['slug', 'rule_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'rule_id': {'type': 'string', 'title': 'Rule Id'}}}
delete_backup
Permanently delete a single backup (metadata + stored snapshot).
Irreversible. Requires: API key with admin scope.
Returns:
{"site", "backup_id", "deleted": true}
Esquema de entrada
{'type': 'object', 'title': 'delete_backupArguments', 'required': ['slug', 'backup_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}}}
delete_compute_volume
Permanently delete a volume and everything stored in it.
Irreversible: the instance is released AND the stored data is purged from
object storage, so billing genuinely stops. Refuses while an instance is
live unless force=True, so a running machine's only copy cannot be
destroyed by reflex.
Requires: API key with admin scope.
Returns:
{"id", "state": "deleted"}
Esquema de entrada
{'type': 'object', 'title': 'delete_compute_volumeArguments', 'required': ['volume_id'], 'properties': {'force': {'type': 'boolean', 'title': 'Force', 'default': False}, 'volume_id': {'type': 'string', 'title': 'Volume Id'}}}
delete_cron
Delete a cron job by line number.
Get line numbers from list_cron().
Requires: API key with write scope.
Args:
slug: Site identifier
line_number: Line number of the cron entry to delete
Returns:
{"deleted": true}
Esquema de entrada
{'type': 'object', 'title': 'delete_cronArguments', 'required': ['slug', 'line_number'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'line_number': {'type': 'integer', 'title': 'Line Number'}}}
delete_domain_dns
Delete a DNS record from a domain.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
record_id: ID of the DNS record to delete (from list_domain_dns)
Returns:
{"success": true, "message": "DNS record deleted"}
Errors:
NOT_FOUND: Domain or record not found
Esquema de entrada
{'type': 'object', 'title': 'delete_domain_dnsArguments', 'required': ['domain_name', 'record_id'], 'properties': {'record_id': {'type': 'string', 'title': 'Record Id'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
delete_email_mailbox
Soft-delete a mailbox. confirm must equal email. Provider recovery window: 30 days.
Esquema de entrada
{'type': 'object', 'title': 'delete_email_mailboxArguments', 'required': ['email', 'confirm'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'confirm': {'type': 'string', 'title': 'Confirm'}}}
delete_file
Delete a file or directory from a site's container.
Directories are deleted recursively. Protected system paths
(e.g. /etc, /usr) cannot be deleted.
Requires: API key with write scope.
Args:
slug: Site identifier
path: Relative path to delete
Returns:
{"success": true, "path": "...", "message": "Deleted"}
Errors:
NOT_FOUND: Path doesn't exist
FORBIDDEN: Protected system path
Esquema de entrada
{'type': 'object', 'title': 'delete_fileArguments', 'required': ['slug', 'path'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}}}
delete_mailbox
Delete a mailbox (its mail is destroyed).
Requires: API key with write scope.
Returns:
{"email", "deleted": true}
Esquema de entrada
{'type': 'object', 'title': 'delete_mailboxArguments', 'required': ['slug', 'email'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'email': {'type': 'string', 'title': 'Email'}}}
delete_redirect
Delete a redirect rule by source path or id.
Requires: API key with write scope.
Returns:
{"site", "deleted": true}
Esquema de entrada
{'type': 'object', 'title': 'delete_redirectArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'redirect_id': {'type': 'string', 'title': 'Redirect Id', 'default': ''}, 'source_path': {'type': 'string', 'title': 'Source Path', 'default': ''}}}
delete_snapshot
Delete a snapshot (local or B2).
Requires: API key with write scope.
Args:
slug: Site identifier
snapshot_id: UUID of the snapshot to delete
Returns:
{"success": true, "message": "Snapshot deleted"}
Errors:
NOT_FOUND: Snapshot not found
Esquema de entrada
{'type': 'object', 'title': 'delete_snapshotArguments', 'required': ['slug', 'snapshot_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'snapshot_id': {'type': 'string', 'title': 'Snapshot Id'}}}
delete_subdomain
Remove a subdomain: its DNS record, nginx vhost and certificate.
The inverse of add_subdomain. Removes the DNS record AND the server-side
vhost and cert, so the name stops resolving and stops being served. Nothing
else on the domain is touched.
Requires: API key with write scope.
Args:
domain_name: Registrable domain linked to a site (e.g. "example.com")
subdomain: Subdomain label only, no dots (e.g. "blog")
Returns:
{"fqdn": "blog.example.com", "domain": "example.com",
"removed": ["dns", "vhost", "cert"], "message": "..."}
Errors:
NOT_FOUND: Domain or subdomain not found
VALIDATION_ERROR: Domain not linked to a site, or invalid label
Esquema de entrada
{'type': 'object', 'title': 'delete_subdomainArguments', 'required': ['domain_name', 'subdomain'], 'properties': {'subdomain': {'type': 'string', 'title': 'Subdomain'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
delete_webhook
Remove a webhook endpoint.
Requires: API key with write scope.
Returns:
{"id", "deleted": true}
Esquema de entrada
{'type': 'object', 'title': 'delete_webhookArguments', 'required': ['endpoint_id'], 'properties': {'endpoint_id': {'type': 'string', 'title': 'Endpoint Id'}}}
detach_compute_volume
Queue: snapshot the machine, verify it, then destroy the instance.
This is how you stop paying for compute while keeping your work.
ASYNCHRONOUS. Returns immediately with state "detaching" â it does NOT mean
the detach finished. The capture takes minutes (roughly 1 min per 10 GB plus
verification), so it runs in a background worker. Poll get_compute_volume
until state is "detached" (done) or "error" (failed).
Safety: if the snapshot or its verification fails, the instance is left
RUNNING and the volume goes to state "error". Your data is never traded
for a tidy state machine. Retry the detach once you have fixed the cause.
Requires: API key with write scope.
Returns:
Volume dict with state "detaching". Poll for the outcome.
Esquema de entrada
{'type': 'object', 'title': 'detach_compute_volumeArguments', 'required': ['volume_id'], 'properties': {'volume_id': {'type': 'string', 'title': 'Volume Id'}}}
disable_email_domain
Disable an empty email domain; refuses active or recoverable accounts.
Esquema de entrada
{'type': 'object', 'title': 'disable_email_domainArguments', 'required': ['domain'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}}}
domain_detail
Get full domain details including DNS and infrastructure status.
Requires: API key with read scope.
Args:
domain_name: Full domain name (e.g. "example.com")
Returns:
{"domain": "example.com", "status": "active",
"expires_at": "iso8601", "auto_renew": true,
"nameservers": ["ns1.borealhost.ai", "ns2.borealhost.ai"],
"dns_records": [...], "linked_site": "my-site"}
Errors:
NOT_FOUND: Domain not owned by this account
Esquema de entrada
{'type': 'object', 'title': 'domain_detailArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
domain_settings
Update domain settings (auto-renew, WHOIS privacy, registrar lock).
Only provided (non-None) fields are updated.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
auto_renew: Optional bool enabling/disabling automatic renewal
whois_privacy: Optional bool. False disables saved proxy service. Paid activation via True is refused; request an activation quote through Support.
locked: Optional bool enabling/disabling registrar lock (prevents unauthorized transfers)
Returns:
{"success": true, "domain": "example.com",
"auto_renew": true, "whois_privacy": true, "locked": true}
Errors:
NOT_FOUND: Domain not found or not owned by account
Esquema de entrada
{'type': 'object', 'title': 'domain_settingsArguments', 'required': ['domain_name'], 'properties': {'locked': {'type': 'boolean', 'title': 'Locked', 'default': None}, 'auto_renew': {'type': 'boolean', 'title': 'Auto Renew', 'default': None}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}, 'whois_privacy': {'type': 'boolean', 'title': 'Whois Privacy', 'default': None}}}
enable_email_domain
Enable an independent email domain; preserve all other email domains.
Requires a verified owned domain and email:write scope. site_slug selects
billing when ambiguous. Defaults request 2,000 users and 50,000 aliases.
Esquema de entrada
{'type': 'object', 'title': 'enable_email_domainArguments', 'required': ['domain'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'site_slug': {'type': 'string', 'title': 'Site Slug', 'default': ''}, 'alias_limit': {'type': 'integer', 'title': 'Alias Limit', 'default': 50000}, 'configure_dns': {'type': 'boolean', 'title': 'Configure Dns', 'default': True}, 'mailbox_limit': {'type': 'integer', 'title': 'Mailbox Limit', 'default': 2000}, 'dmarc_reporting_address': {'type': 'string', 'title': 'Dmarc Reporting Address', 'default': ''}}}
enable_smtp_relay
Enable an SMTP relay for a site's outbound transactional mail.
Provisions a mail-send-only credential on the platform relay and
configures SPF/DKIM DNS when the domain zone is hosted here. The SMTP
password is returned ONCE. Use TLS on port 587, username "apikey".
Requires: API key with write scope.
Returns:
{"relay_id", "domain", "smtp_host", "smtp_ports", "smtp_username",
"smtp_password", "dns_auto_configured", "message"}
Esquema de entrada
{'type': 'object', 'title': 'enable_smtp_relayArguments', 'required': ['slug', 'domain'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'domain': {'type': 'string', 'title': 'Domain'}}}
enable_wildcard
Route *.domain (every subdomain) to the domain's linked site.
Creates a wildcard DNS record and issues a wildcard certificate via
ACME DNS-01. SLOW â DNS propagation is part of the challenge, expect
2-5 minutes. Requires the domain to be linked to a site and its DNS
hosted by BorealHost.
Requires: API key with write scope.
Returns:
{"domain", "wildcard", "site", "ssl_active", "not_after"}
Esquema de entrada
{'type': 'object', 'title': 'enable_wildcardArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
execute_query
Run ONE bounded read against a site's database.
One statement, beginning with SELECT, SHOW, DESCRIBE or EXPLAIN, with no
second statement and no data-modifying clause anywhere in it. The container
proves the statement is a read before running it and caps the result: 200
rows by default, 1000 maximum, 2 MB of cell data. `truncated` in the
response says whether a cap was reached.
â THIS TOOL CANNOT CHANGE ANYTHING, AND RETRYING WITH DIFFERENT WORDING WILL
NOT MAKE IT. Anything that is not a single bounded read is refused with
READ_ONLY and nothing runs. To change data or schema, use the tool for the
job: optimize_database, database_search_replace, manage_db_user,
list_databases, list_tables â and for creating, altering, dropping,
importing or exporting tables, the database manager in the control panel,
which has no tool here.
Requires: API key with write scope (unchanged â the scope is the customer's
published permission for this operation, not a claim about what it does).
Args:
slug: Site identifier
database: Database name
query: One read statement
Returns:
{"columns": ["id", "user_email"], "rows": [[1, "a@example.com"], ...],
"row_count": 1, "truncated": false, "execution_time_ms": 12.0}
Errors:
READ_ONLY: Not a single bounded read. The error text carries the
explanation and names the operation to use instead.
Esquema de entrada
{'type': 'object', 'title': 'execute_queryArguments', 'required': ['slug', 'database', 'query'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'query': {'type': 'string', 'title': 'Query'}, 'database': {'type': 'string', 'title': 'Database'}}}
find_address
Look up mailbox/alias/forward/free in an authorized email domain.
Esquema de entrada
{'type': 'object', 'title': 'find_addressArguments', 'required': ['address'], 'properties': {'address': {'type': 'string', 'title': 'Address'}}}
get_app_status
Get app installation status and log.
Poll this after install_app() to track progress.
Requires: API key with read scope.
Args:
slug: Site identifier
app_id: App ID from install_app() response
Returns:
{"id": "uuid", "app_name": "myapp", "status": "running"|"installing"|"failed",
"install_log": "..."}
Statuses: "installing", "running", "stopped", "failed", "uninstalled"
Esquema de entrada
{'type': 'object', 'title': 'get_app_statusArguments', 'required': ['slug', 'app_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'app_id': {'type': 'string', 'title': 'App Id'}}}
get_backup_retention
Get the backup retention policy for a VPS site.
Requires: API key with read scope.
Returns:
{"site", "retention": {"keep_daily", "keep_weekly", "keep_monthly"}}
Esquema de entrada
{'type': 'object', 'title': 'get_backup_retentionArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_billing_portal
Get a Stripe billing portal URL for managing payment methods and invoices.
Returns a URL (not a redirect) that the human can open in a browser.
Requires: API key with read scope.
Args:
flow: Optional. Set to "payment_method_update" to go directly
to the payment method update page.
Returns:
{"url": "https://billing.stripe.com/p/session/..."}
Esquema de entrada
{'type': 'object', 'title': 'get_billing_portalArguments', 'properties': {'flow': {'type': 'string', 'title': 'Flow', 'default': ''}}}
get_checkout_status
Poll a checkout session for status updates.
Call this after complete_checkout to track payment and provisioning.
Polling strategy:
- First 60 seconds: every 5 seconds
- After 60 seconds: every 15 seconds
- Stop after 10 minutes if not completed
Checkout statuses (in order):
- "not_ready": Missing required fields (slug)
- "ready": All fields set, awaiting payment
- "awaiting_payment": Stripe checkout page opened, waiting for human
- "in_progress": Payment received, site being provisioned
- "completed": Site ready â API key included (shown once, then cleared)
- "canceled": Checkout was abandoned
- "failed": Payment or provisioning failed
Terminal statuses: "completed", "canceled", "failed".
Args:
checkout_id: Checkout session ID
Returns (when completed):
{"id": "uuid", "status": "completed", "api_key": "bh_...",
"api_key_message": "Store this API key securely...",
"api_key_pending": false,
"subscription_id": "uuid", "subscription_status": "active",
"site": {"slug": "my-site", "status": "active",
"url": "https://my-site.borealhost.ai"},
"completed_at": "iso8601"}
Immediately after payment `site` may be null with a `provisioning_message`
â the site is being built. Poll again in a few seconds.
Note: The api_key field appears ONCE in the first poll after completion,
then is permanently cleared. `api_key_pending` tells you whether it is still
waiting to be collected. Store it immediately.
Esquema de entrada
{'type': 'object', 'title': 'get_checkout_statusArguments', 'required': ['checkout_id'], 'properties': {'checkout_id': {'type': 'string', 'title': 'Checkout Id'}}}
get_compute_instance
Get live details for a compute instance (state, public IP, accrued cost).
State is synced from the cloud provider on each call. SSH as root once
state is "running" and public_ip is set.
Requires: API key with read scope.
Args:
instance_id: Instance UUID from launch_compute_instance / list
Returns:
{"id", "state", "public_ip", "hourly_price_cad", "accrued_cad",
"terminate_after", ...}
Esquema de entrada
{'type': 'object', 'title': 'get_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
get_compute_volume
Get a volume's live state, its instance, and its monthly storage cost.
Requires: API key with read scope.
Returns:
Volume dict plus "monthly_storage_cad". After attach, poll this until
instance.state is "running" â then allow a few more minutes for the
restore to finish and the machine to reboot into itself.
Esquema de entrada
{'type': 'object', 'title': 'get_compute_volumeArguments', 'required': ['volume_id'], 'properties': {'volume_id': {'type': 'string', 'title': 'Volume Id'}}}
get_database_info
Get WordPress database information (size, tables, row counts).
Requires: API key with read scope. WordPress sites only.
Args:
slug: Site identifier
Returns:
{"database": "wp_mysite", "size_mb": 45.2,
"tables": 12, "total_rows": 15432}
Esquema de entrada
{'type': 'object', 'title': 'get_database_infoArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_database_recovery
Poll one database recovery without waiting for completion.
Requires: API key with read scope.
Args:
slug: Site identifier
backup_id: UUID of the source backup
recovery_id: UUID returned by ``recover_backup_database``
Esquema de entrada
{'type': 'object', 'title': 'get_database_recoveryArguments', 'required': ['slug', 'backup_id', 'recovery_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}, 'recovery_id': {'type': 'string', 'title': 'Recovery Id'}}}
get_email_domain
Read effective OpenSRS limits, counts, connections and public DNS health.
Esquema de entrada
{'type': 'object', 'title': 'get_email_domainArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain'}}}
get_email_status
Email addon status and mailboxes for a site.
Requires: API key with read scope.
Returns:
{"configured": bool, "domain", "mailboxes", "mailbox_list": [...]}
Esquema de entrada
{'type': 'object', 'title': 'get_email_statusArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_email_webmail_url
Issue a one-use BorealHost link expiring in 60 seconds. Redemption mints provider SSO. Requires email:signon.
Esquema de entrada
{'type': 'object', 'title': 'get_email_webmail_urlArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'language': {'type': 'string', 'title': 'Language', 'default': 'fr'}}}
get_file_recovery
Poll one selected-file recovery without waiting for it to finish.
Requires: API key with read scope.
Args:
slug: Site identifier
backup_id: UUID of the source backup
recovery_id: UUID returned by ``recover_backup_files``
Returns:
{"id": "uuid", "backup_id": "uuid",
"status": "running"|"completed"|"failed", "paths": [...],
"error": "", ...}
Esquema de entrada
{'type': 'object', 'title': 'get_file_recoveryArguments', 'required': ['slug', 'backup_id', 'recovery_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}, 'recovery_id': {'type': 'string', 'title': 'Recovery Id'}}}
get_logs
Retrieve container logs (error, access, or PHP).
Requires: API key with read scope.
Args:
slug: Site identifier
log_type: "error" (Nginx/Apache errors), "access" (HTTP request log),
or "php" (PHP-FPM errors, WordPress sites only)
lines: Number of lines to retrieve (1â500, default: 100)
search: Optional keyword filter â only lines containing this string
Returns:
{"log_type": "error", "lines": ["2024-01-15 ... error ...", ...],
"count": 42, "truncated": false}
Errors:
NOT_FOUND: Unknown slug
VALIDATION_ERROR: Invalid log_type or lines out of range
Esquema de entrada
{'type': 'object', 'title': 'get_logsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'lines': {'type': 'integer', 'title': 'Lines', 'default': 100}, 'search': {'type': 'string', 'title': 'Search', 'default': ''}, 'log_type': {'type': 'string', 'title': 'Log Type', 'default': 'error'}}}
get_mailbox
Inspect usage, services, aliases count, forwarding/Sieve, autoresponder and label.
Esquema de entrada
{'type': 'object', 'title': 'get_mailboxArguments', 'required': ['email'], 'properties': {'email': {'type': 'string', 'title': 'Email'}}}
get_metrics
Get traffic and performance metrics for a site.
Requires: API key with read scope.
Args:
slug: Site identifier
days: Number of days of history (1â90, default: 7)
Returns:
{"requests": [...], "bandwidth": [...], "errors": [...],
"period": {"start": "iso8601", "end": "iso8601"}}
Errors:
NOT_FOUND: Unknown slug
VALIDATION_ERROR: days out of range
Esquema de entrada
{'type': 'object', 'title': 'get_metricsArguments', 'required': ['slug'], 'properties': {'days': {'type': 'integer', 'title': 'Days', 'default': 7}, 'slug': {'type': 'string', 'title': 'Slug'}}}
get_resource_snapshot
Get current resource usage (CPU, memory, disk, load average).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"cpu_percent": 12.5, "memory_mb": 384, "memory_total_mb": 512,
"disk_used_gb": 3.2, "disk_total_gb": 10,
"load_1m": 0.5, "load_5m": 0.3, "load_15m": 0.2}
Esquema de entrada
{'type': 'object', 'title': 'get_resource_snapshotArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_site_nginx_snippet
Read the custom nginx config for a domain on the BorealHost host proxy.
Your site sits behind a BorealHost reverse proxy that terminates TLS and
forwards to your container. This returns the custom nginx block applied to
that proxy for this domain (empty if you have not set one).
Requires: API key with read scope.
Args:
domain_name: Full domain name (e.g. "example.com")
Returns:
{"domain": "example.com", "content": "location ...", "exists": true}
Errors:
NOT_FOUND: Domain not found
VALIDATION_ERROR: Domain is not linked to a site
Esquema de entrada
{'type': 'object', 'title': 'get_site_nginx_snippetArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
get_site_status
Get detailed status of a hosted site including resources, domains, and modules.
Requires: API key with read scope.
Args:
slug: Site identifier (the slug chosen during checkout)
Returns:
{"slug": "my-site", "plan": "site_starter", "status": "active",
"domains": ["my-site.borealhost.ai"], "modules": {...},
"resources": {"memory_mb": 512, "cpu_cores": 1, "disk_gb": 10},
"created_at": "iso8601"}
Errors:
NOT_FOUND: Unknown slug or not owned by this account
Esquema de entrada
{'type': 'object', 'title': 'get_site_statusArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_smtp_relay
List SMTP relay credentials for a site, with domain-auth status.
Requires: API key with read scope.
Returns:
{"relays": [{"relay_id", "domain", "status",
"domain_authenticated"}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'get_smtp_relayArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_snapshot_usage
Get snapshot disk usage and quota info for a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"disk_quota_gb": 200, "max_snapshots": 5, "snapshot_count": 2,
"local_snapshot_bytes": 1234, "b2_snapshot_bytes": 5678,
"can_create": true}
Esquema de entrada
{'type': 'object', 'title': 'get_snapshot_usageArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_ssh_info
Get SSH connection info for a VPS/dedicated site.
Only available for VPS/dedicated plans (not shared hosting).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"host": "184.107.x.x", "port": 22, "username": "admin",
"ssh_command": "ssh admin@184.107.x.x"}
Errors:
NOT_FOUND: Unknown slug
FORBIDDEN: Plan does not support SSH (shared plans)
Esquema de entrada
{'type': 'object', 'title': 'get_ssh_infoArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_stack_info
Get detailed system stack information (OS, PHP, DB, web server versions).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"os": "Debian 12", "kernel": "6.1.0",
"php": "8.3.4", "mysql": "10.11.6-MariaDB",
"nginx": "1.24.0", "wordpress": "6.5"}
Esquema de entrada
{'type': 'object', 'title': 'get_stack_infoArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
get_support_ticket
Get a support ticket with its full message thread.
Requires: API key with read scope.
Args:
ticket_id: Ticket UUID from list_support_tickets
Returns:
{"id", "subject", "status", "messages": [...]}
Esquema de entrada
{'type': 'object', 'title': 'get_support_ticketArguments', 'required': ['ticket_id'], 'properties': {'ticket_id': {'type': 'string', 'title': 'Ticket Id'}}}
get_wallet
The account's prepaid balance, and what THIS key may spend from it.
Two ceilings, and both apply: the balance bounds the ACCOUNT, the allowance
bounds this KEY within it. Plan against `spendable_cents`, which is the
lower of the two â a $50 balance behind a $5 allowance means $5, and
planning against the balance is planning a purchase that gets refused.
`can_spend: false` with a non-zero balance is normal and means this key has
no budget allocated. That is not a bug: a key with no allowance may not
spend the account's money, which is the whole reason allowances exist. Ask
the human to allocate one in the panel (Compte â Clés API).
Read-only. Money goes in through a human â an agent able to top up its own
budget does not have one.
Requires: API key with read scope.
Returns:
{"currency": "CAD", "balance_cents": 5000, "spendable_cents": 500,
"can_spend": true,
"key_allowance": {"limit_cents": 2000, "spent_cents": 1500,
"remaining_cents": 500}}
To spend it: complete_checkout(..., payment_method="wallet").
Esquema de entrada
{'type': 'object', 'title': 'get_walletArguments', 'properties': {}}
get_webmail_url
One-time webmail single-sign-on URL for a mailbox.
Requires: API key with write scope.
Returns:
{"email", "url"}
Esquema de entrada
{'type': 'object', 'title': 'get_webmail_urlArguments', 'required': ['slug', 'email'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'email': {'type': 'string', 'title': 'Email'}}}
install_app
Install an app template on a VPS/Cloud site.
Starts a background installation. Poll get_app_status() for progress.
Requires: API key with write scope. VPS or Cloud plan only.
Args:
slug: Site identifier
template: App template slug. Available: django, laravel, nextjs, nodejs,
nuxtjs, rails, static, wordpress
app_name: Short name for the app (2-50 chars, lowercase alphanumeric + hyphens).
Used as subdomain: {app_name}.{site_domain}
db_type: Database type. "none", "mysql", or "postgresql" (depends on template)
domain: Custom domain override (default: {app_name}.{site_domain})
display_name: Human-friendly name (default: derived from app_name)
Returns:
{"id": "uuid", "app_name": "myapp", "status": "installing",
"message": "Installation started. Poll for progress."}
Errors:
FORBIDDEN: Plan does not support apps (shared plans)
VALIDATION_ERROR: Invalid template, app_name, or duplicate name
Esquema de entrada
{'type': 'object', 'title': 'install_appArguments', 'required': ['slug', 'template', 'app_name'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'domain': {'type': 'string', 'title': 'Domain', 'default': ''}, 'db_type': {'type': 'string', 'title': 'Db Type', 'default': 'none'}, 'app_name': {'type': 'string', 'title': 'App Name'}, 'template': {'type': 'string', 'title': 'Template'}, 'display_name': {'type': 'string', 'title': 'Display Name', 'default': ''}}}
launch_compute_instance
Launch an on-demand hourly compute instance (Canada, CAD).
Billing starts at launch (per minute, 1-hour minimum) and runs until
terminate_compute_instance â stopping does NOT stop the charge. Every
instance has a hard TTL
(max_lifetime_hours, default 72h) after which it is auto-terminated.
Usage is metered onto your existing BorealHost subscription; an active
subscription is required.
Requires: API key with write scope.
Args:
instance_type: From list_compute_types, e.g. "lsw.c3.large"
image_id: From list_compute_images, e.g. "UBUNTU_24_04_64BIT"
name: Optional label for the instance
ssh_public_key: Public key installed as root access. Mutually exclusive
with user_data (provider limitation) â provide exactly one.
user_data: cloud-init config (plain text #cloud-config). Use
ssh_authorized_keys inside it if you need a key AND user data.
root_disk_size: GB (default max(min_disk, 25))
storage_type: "CENTRAL" (redundant) or "LOCAL" (faster I/O)
max_lifetime_hours: Hard TTL, 1-336 (default 72)
Returns:
Instance dict: {"id", "state": "launching", "public_ip", "instance_type",
"hourly_price_cad", "terminate_after", ...}. Poll get_compute_instance
until state is "running" and public_ip is set (~1-3 min).
Errors:
PAYMENT_REQUIRED: No active subscription to bill against
LIMIT_EXCEEDED: Concurrent instance cap reached
SPEND_CAP_EXCEEDED: Monthly compute spend cap reached
VALIDATION_ERROR: Bad type/image/disk/TTL, or both/neither of
ssh_public_key and user_data
Esquema de entrada
{'type': 'object', 'title': 'launch_compute_instanceArguments', 'required': ['instance_type', 'image_id'], 'properties': {'name': {'type': 'string', 'title': 'Name', 'default': ''}, 'image_id': {'type': 'string', 'title': 'Image Id'}, 'user_data': {'type': 'string', 'title': 'User Data', 'default': ''}, 'storage_type': {'type': 'string', 'title': 'Storage Type', 'default': 'CENTRAL'}, 'instance_type': {'type': 'string', 'title': 'Instance Type'}, 'root_disk_size': {'type': 'integer', 'title': 'Root Disk Size', 'default': 0}, 'ssh_public_key': {'type': 'string', 'title': 'Ssh Public Key', 'default': ''}, 'max_lifetime_hours': {'type': 'integer', 'title': 'Max Lifetime Hours', 'default': 0}}}
link_domain
Link a domain to a hosted site.
Attaches the domain to the specified site and triggers automatic
DNS configuration and SSL provisioning.
WARNING: Regenerates this site's nginx vhost on the host from scratch. Any config applied to that vhost by hand is lost, silently â the site keeps serving and only the hand-added behaviour disappears. Config set via the nginx-snippet endpoint is NOT affected: it lives in a separate file the regenerated vhost re-includes, which is what that endpoint is for.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
site_slug: Site identifier to link the domain to
Returns:
{"success": true, "domain": "example.com",
"linked_site": "my-site", "message": "Domain linked"}
Errors:
NOT_FOUND: Domain or site not found
VALIDATION_ERROR: Domain already linked to another site
Esquema de entrada
{'type': 'object', 'title': 'link_domainArguments', 'required': ['domain_name', 'site_slug'], 'properties': {'site_slug': {'type': 'string', 'title': 'Site Slug'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
list_alert_rules
List user-configurable alert rules for a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
[{"id": "uuid", "metric": "disk", "operator": "gt",
"threshold": 90, "severity": "warning", "enabled": true,
"cooldown_minutes": 30, "notify_email": true}]
Esquema de entrada
{'type': 'object', 'title': 'list_alert_rulesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_api_keys
List all API keys for the account.
Shows key metadata (name, prefix, scopes, last used) but never the
full key value.
Requires: API key with read scope.
Returns:
[{"id": "uuid", "name": "My Key", "prefix": "bh_a2...",
"scopes": ["read", "write"], "is_active": true,
"created_at": "iso8601", "last_used_at": "iso8601"|null,
"site_slug": null|"my-site"}]
Esquema de entrada
{'type': 'object', 'title': 'list_api_keysArguments', 'properties': {}}
list_apps
List installed apps on a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"apps": [{"id": "uuid", "app_name": "myapp", "template_slug": "django",
"status": "running", "domain": "myapp.mysite.borealhost.ai"}]}
Esquema de entrada
{'type': 'object', 'title': 'list_appsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_backups
List all backups for a site (automatic and manual).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
[{"id": "uuid", "backup_type": "auto"|"manual", "status": "completed",
"size_bytes": 1234, "size_display": "1.2 Mo",
"timestamp": "iso8601", "notes": "..."}]
Esquema de entrada
{'type': 'object', 'title': 'list_backupsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_checkouts
List checkouts belonging to the authenticated account.
Requires: API key. Only checkouts with a recorded owner appear â every
checkout created while authenticated, plus every checkout that reached
payment. An anonymous checkout whose one-shot secret was lost cannot be
listed; create checkouts authenticated to keep them addressable.
Args:
status: Optional filter â "not_ready", "ready", "awaiting_payment",
"completed", "canceled", "failed".
Returns:
{"checkouts": [{...same shape as get_checkout_status...}], "note": "..."}
Esquema de entrada
{'type': 'object', 'title': 'list_checkoutsArguments', 'properties': {'status': {'type': 'string', 'title': 'Status', 'default': ''}}}
list_compute_images
List OS images available for on-demand compute instances.
Requires: API key with read scope.
Returns:
{"images": [{"id": "UBUNTU_24_04_64BIT", "name": "Ubuntu 24.04 LTS (x86_64)",
"family": "linux", "flavour": "ubuntu"}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_compute_imagesArguments', 'properties': {}}
list_compute_instances
List your on-demand compute instances with month-to-date spend.
Requires: API key with read scope.
Returns:
{"instances": [...], "month_to_date_spend_cad": 12.34,
"monthly_spend_cap_cad": 500.0}
Esquema de entrada
{'type': 'object', 'title': 'list_compute_instancesArguments', 'properties': {'include_terminated': {'type': 'boolean', 'title': 'Include Terminated', 'default': False}}}
list_compute_types
List on-demand compute instance types with hourly CAD prices.
On-demand instances are real cloud VMs in Canada (Montreal region),
billed per minute (1-hour minimum) post-paid onto your existing
BorealHost subscription. Use them for short-lived extra compute
(builds, batch jobs, experiments).
Requires: API key with read scope.
Returns:
{"region": "ca-central-1", "currency": "CAD",
"billing": "hourly, post-paid; billing runs until the instance is terminated",
"types": [{"type": "lsw.c3.large", "vcpu": 2, "memory_gb": 3,
"hourly_price_cad": 0.08, "min_disk_gb": 5,
"storage_types": ["CENTRAL", "LOCAL"]}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_compute_typesArguments', 'properties': {}}
list_compute_volumes
List your compute volumes â machines that survive instance termination.
A volume is a whole machine (packages, drivers, services, users, data)
stored in Canada. Detaching destroys the instance but keeps the machine;
attaching restores it onto a fresh instance, optionally of a DIFFERENT
type. That is how you move a workload from a small CPU box to a big GPU
box without rebuilding it.
Requires: API key with read scope.
Returns:
{"volumes": [{"id", "name", "state", "instance_type", "stored_gb",
"has_snapshot", "instance": {...} or null}, ...],
"price_cad_per_gb_month": 0.03}
state is one of: creating, attached, detaching, detached, attaching,
error. Only "attached" has a running instance you can log into.
Esquema de entrada
{'type': 'object', 'title': 'list_compute_volumesArguments', 'properties': {}}
list_cron
List cron jobs on a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"jobs": [{"line": 1, "schedule": "*/5 * * * *",
"command": "/usr/bin/php /var/www/html/wp-cron.php"}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_cronArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_databases
List all databases on a site's container.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"databases": ["wordpress", "app_db", ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_databasesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_db_users
List database users for a site.
Requires: API key with read scope.
Returns:
{"engine", "users": [{"user", "host", ...}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_db_usersArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'engine': {'type': 'string', 'title': 'Engine', 'default': 'mysql'}}}
list_domain_dns
List all DNS records for a domain.
Returns DNS records at the domain level (independent of site-level
manage_dns). Use this for domains that may not be linked to a site.
Requires: API key with read scope.
Args:
domain_name: Full domain name (e.g. "example.com")
Returns:
[{"id": "record-id", "type": "A", "subdomain": "www",
"value": "1.2.3.4"}]
The DNS provider manages the effective TTL and does not expose a
per-record value through this service.
Errors:
NOT_FOUND: Domain not found or not owned by account
Esquema de entrada
{'type': 'object', 'title': 'list_domain_dnsArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
list_domains
List all domains owned by the authenticated user.
Requires: API key with read scope.
Returns:
[{"domain": "example.com", "status": "active",
"expires_at": "iso8601", "auto_renew": true,
"linked_site": "my-site"}]
Esquema de entrada
{'type': 'object', 'title': 'list_domainsArguments', 'properties': {}}
list_email_audit
List email API mutation/credential issuance attempts, actor, reason and outcome.
Esquema de entrada
{'type': 'object', 'title': 'list_email_auditArguments', 'required': ['domain'], 'properties': {'email': {'type': 'string', 'title': 'Email', 'default': ''}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 100}, 'since': {'type': 'string', 'title': 'Since', 'default': ''}, 'cursor': {'type': 'string', 'title': 'Cursor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}}}
list_email_domains
List email domains visible to this key, with cluster connection settings.
Esquema de entrada
{'type': 'object', 'title': 'list_email_domainsArguments', 'properties': {'limit': {'type': 'integer', 'title': 'Limit', 'default': 100}, 'cursor': {'type': 'string', 'title': 'Cursor', 'default': ''}}}
list_files
List files and directories in a site's container.
Path scoping depends on the plan:
- Shared plans: rooted at wp-content/ (WordPress content directory)
- VPS/dedicated plans: full filesystem access
Requires: API key with read scope.
Args:
slug: Site identifier
path: Relative path to list (empty for root of accessible area)
Returns:
{"path": "/", "entries": [{"name": "index.php", "type": "file",
"size": 1234, "modified": "iso8601"}, {"name": "uploads",
"type": "directory", "modified": "iso8601"}]}
Errors:
NOT_FOUND: Unknown slug or path doesn't exist
Esquema de entrada
{'type': 'object', 'title': 'list_filesArguments', 'required': ['slug'], 'properties': {'path': {'type': 'string', 'title': 'Path', 'default': ''}, 'slug': {'type': 'string', 'title': 'Slug'}}}
list_firewall_rules
List IP allow/deny firewall rules for a site.
Rules are implemented as Nginx allow/deny directives per container.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"rules": [{"ip": "1.2.3.4", "action": "deny"},
{"ip": "10.0.0.0/8", "action": "allow"}]}
Esquema de entrada
{'type': 'object', 'title': 'list_firewall_rulesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_ftp_accounts
List SFTP accounts on a site.
Also returns the host and port to connect to. Do not use the site's domain
for SFTP: it is Cloudflare-proxied and only carries HTTP(S).
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"accounts": [{"username": "sftpuser", "home": "/wordpress", "uid": 1001}],
"configured": true,
"connection": {"host": "1.2.3.4", "port": 9312, "protocol": "SFTP"}}
Esquema de entrada
{'type': 'object', 'title': 'list_ftp_accountsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_mailbox_aliases
List a mailbox's aliases with pagination.
Esquema de entrada
{'type': 'object', 'title': 'list_mailbox_aliasesArguments', 'required': ['email'], 'properties': {'email': {'type': 'string', 'title': 'Email'}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 100}, 'cursor': {'type': 'string', 'title': 'Cursor', 'default': ''}}}
list_mailboxes
Page through a domain's mailboxes, optionally filtering by organisation label.
Esquema de entrada
{'type': 'object', 'title': 'list_mailboxesArguments', 'required': ['domain'], 'properties': {'label': {'anyOf': [{'type': 'string'}, {'type': 'null'}], 'title': 'Label', 'default': None}, 'limit': {'type': 'integer', 'title': 'Limit', 'default': 100}, 'cursor': {'type': 'string', 'title': 'Cursor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}}}
list_modules
List AI modules and their enabled/disabled state for a site.
Also returns the list of modules available for the site's plan.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"modules": {"chatbot": true, "seo": false, "translation": false,
"content": false}, "available": ["chatbot", "seo", "translation", "content"]}
Errors:
NOT_FOUND: Unknown slug
Esquema de entrada
{'type': 'object', 'title': 'list_modulesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_php_versions
List available PHP versions and the currently active one.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"versions": [{"version": "8.1", "active": false},
{"version": "8.2", "active": false},
{"version": "8.3", "active": true}]}
Esquema de entrada
{'type': 'object', 'title': 'list_php_versionsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_plans
List available hosting plans with pricing and resources.
No authentication needed.
Args:
track: Filter by plan track. Valid values: "single_site", "agency".
â The track is not the site count â most plans on BOTH tracks
include several sites (site_starter 5, site_plus 8, site_pro 12).
Read `max_sites` on the plan, and use add_site() to fill a slot.
Leave empty to list all tracks.
include_deprecated: Include deprecated plans (default: false)
Returns:
[{"slug": "site_starter", "name": "Starter", "track": "single_site",
"hosting_type": "shared", "price": {"monthly": 5, "annual": 2, "currency": "CAD"},
"resources": null, "features": {"max_sites": 1, "ai_modules": [...],
"ai_agents": [], "free_domain_annual": false}}, ...]
Esquema de entrada
{'type': 'object', 'title': 'list_plansArguments', 'properties': {'track': {'type': 'string', 'title': 'Track', 'default': ''}, 'include_deprecated': {'type': 'boolean', 'title': 'Include Deprecated', 'default': False}}}
list_plugins
List installed WordPress plugins with status.
Requires: API key with read scope. WordPress sites only.
Args:
slug: Site identifier
Returns:
{"plugins": [{"name": "akismet", "status": "active", "version": "5.3",
"update_available": false}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_pluginsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_port_forwards
List ports published from this site's container to the public internet.
These are iptables DNAT rules on the node, NOT the IP allow/deny rules that
add_firewall_rule manages â those two tools do unrelated things and neither
substitutes for the other.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"port_forwards": [{"id": "...", "external_port": 3478,
"internal_port": 3478, "protocol": "udp", "status": "active",
"public_address": "203.0.113.5:3478", "port_preserved": true}],
"limit": 15, "port_budget": 7680, "ports_used": 1,
"max_range_ports": 1024, "public_ip": "203.0.113.5"}
Esquema de entrada
{'type': 'object', 'title': 'list_port_forwardsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_redirects
List HTTP redirect rules for a site.
Requires: API key with read scope.
Returns:
[{"id", "source_path", "target_url", "redirect_type"}, ...]
Esquema de entrada
{'type': 'object', 'title': 'list_redirectsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_snapshots
List all snapshots and scheduled snapshots for a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"snapshots": [{"id": "uuid", "name": "snap-...", "status": "completed",
"storage_type": "local"|"b2", "size_bytes": 1234, "size_display": "1.2 Mo",
"created_at": "iso8601"}], "scheduled": [...]}
Esquema de entrada
{'type': 'object', 'title': 'list_snapshotsArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_subdomains
List subdomain DNS records for a domain you own.
Requires: API key with read scope.
Args:
domain_name: Registrable domain (e.g. "example.com")
Returns:
[{"fqdn": "blog.example.com", "subdomain": "blog",
"record_type": "A", "value": "1.2.3.4", "is_auto": true}, ...]
Errors:
NOT_FOUND: Domain not found
Esquema de entrada
{'type': 'object', 'title': 'list_subdomainsArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
list_subscriptions
List all subscriptions with plan details, pricing, status, and site slug.
Requires: API key with read scope.
Returns:
[{"id": "uuid", "plan_slug": "site_starter", "plan_name": "Starter",
"status": "active", "billing_period": "monthly",
"price": {"amount": 500, "currency": "cad"},
"site_slug": "my-site", "created_at": "iso8601"}]
Esquema de entrada
{'type': 'object', 'title': 'list_subscriptionsArguments', 'properties': {}}
list_support_tickets
List the account's support tickets.
Requires: API key with read scope.
Args:
status: Optional filter (e.g. "open", "closed")
Returns:
[{"id", "subject", "status", "category", "created_at", ...}, ...]
Esquema de entrada
{'type': 'object', 'title': 'list_support_ticketsArguments', 'properties': {'status': {'type': 'string', 'title': 'Status', 'default': ''}}}
list_tables
List tables in a database.
Requires: API key with read scope.
Args:
slug: Site identifier
database: Database name
Returns:
{"tables": [{"name": "wp_posts", "rows": 1234, "size_mb": 5.2}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_tablesArguments', 'required': ['slug', 'database'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'database': {'type': 'string', 'title': 'Database'}}}
list_themes
List installed WordPress themes with status.
Requires: API key with read scope. WordPress sites only.
Args:
slug: Site identifier
Returns:
{"themes": [{"name": "twentytwentyfour", "status": "active",
"version": "1.0", "update_available": false}, ...]}
Esquema de entrada
{'type': 'object', 'title': 'list_themesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
list_webhooks
List webhook endpoints registered on the account.
Requires: API key with read scope.
Returns:
[{"id", "url", "events", "is_active", "last_status",
"failure_count"}, ...]
Esquema de entrada
{'type': 'object', 'title': 'list_webhooksArguments', 'properties': {}}
logout_mailbox_sessions
Terminate established IMAP and POP sessions through OpenSRS logout_user.
Esquema de entrada
{'type': 'object', 'title': 'logout_mailbox_sessionsArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}}}
manage_db_user
Manage a database user on a site.
Actions: "create" (user+password), "drop" (user),
"set_password" (user+password), "grants" (list a user's grants),
"grant" / "revoke" (user+database, optional privileges e.g. "ALL"
or "SELECT,INSERT").
Requires: API key with write scope.
Returns:
{"engine", "action", "result": {...}}
Esquema de entrada
{'type': 'object', 'title': 'manage_db_userArguments', 'required': ['slug', 'action'], 'properties': {'host': {'type': 'string', 'title': 'Host', 'default': ''}, 'slug': {'type': 'string', 'title': 'Slug'}, 'user': {'type': 'string', 'title': 'User', 'default': ''}, 'action': {'type': 'string', 'title': 'Action'}, 'engine': {'type': 'string', 'title': 'Engine', 'default': 'mysql'}, 'database': {'type': 'string', 'title': 'Database', 'default': ''}, 'password': {'type': 'string', 'title': 'Password', 'default': ''}, 'privileges': {'type': 'string', 'title': 'Privileges', 'default': ''}}}
manage_dns
Create or delete DNS records for a site.
Requires: API key with write scope.
Args:
slug: Site identifier
action: "create" or "delete"
record_type: "A", "AAAA", "CNAME", "MX", "TXT", or "SRV"
subdomain: Subdomain part (e.g. "www", "mail"). Leave empty for
the apex/root domain.
value: Record value. Required for "create". Examples:
A: "1.2.3.4", CNAME: "example.com", MX: "mail.example.com",
TXT: "v=spf1 include:_spf.google.com ~all"
The DNS provider manages the effective TTL and does not expose a
per-record value through this service.
Returns:
{"success": true, "record": {"type": "A", "subdomain": "www",
"value": "1.2.3.4"}}
Errors:
VALIDATION_ERROR: Missing value for create, invalid record type
NOT_FOUND: Unknown slug
Esquema de entrada
{'type': 'object', 'title': 'manage_dnsArguments', 'required': ['slug', 'action', 'record_type'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'value': {'type': 'string', 'title': 'Value', 'default': ''}, 'action': {'type': 'string', 'title': 'Action'}, 'subdomain': {'type': 'string', 'title': 'Subdomain', 'default': ''}, 'record_type': {'type': 'string', 'title': 'Record Type'}}}
manage_plugin
Install, activate, deactivate, or delete a WordPress plugin.
Requires: API key with write scope.
Args:
slug: Site identifier
action: "install", "activate", "deactivate", or "delete"
plugin: Plugin slug (e.g. "akismet", "jetpack", "woocommerce")
Returns:
{"action": "install", "plugin": "jetpack", "result": {...}}
Esquema de entrada
{'type': 'object', 'title': 'manage_pluginArguments', 'required': ['slug', 'action', 'plugin'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'action': {'type': 'string', 'title': 'Action'}, 'plugin': {'type': 'string', 'title': 'Plugin'}}}
manage_theme
Install, activate, or delete a WordPress theme.
Requires: API key with write scope.
Args:
slug: Site identifier
action: "install", "activate", or "delete"
theme: Theme slug (e.g. "twentytwentyfour", "astra")
Returns:
{"action": "install", "theme": "astra", "result": {...}}
Esquema de entrada
{'type': 'object', 'title': 'manage_themeArguments', 'required': ['slug', 'action', 'theme'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'theme': {'type': 'string', 'title': 'Theme'}, 'action': {'type': 'string', 'title': 'Action'}}}
optimize_database
Optimize WordPress database tables (reduces bloat).
Requires: API key with write scope.
Args:
slug: Site identifier
Returns:
{"optimized": true, "tables_optimized": 12}
Esquema de entrada
{'type': 'object', 'title': 'optimize_databaseArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
read_file
Read the contents of a file from a site's container.
Max file size: 512KB. Binary files are rejected â use the site's
file manager or SSH for binary files.
Requires: API key with read scope.
Args:
slug: Site identifier
path: Relative path to the file
Returns:
{"path": "wp-config.php", "content": "<?php ...",
"size": 1234, "encoding": "utf-8"}
Errors:
NOT_FOUND: File doesn't exist
VALIDATION_ERROR: File is binary or exceeds 512KB
Esquema de entrada
{'type': 'object', 'title': 'read_fileArguments', 'required': ['slug', 'path'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}}}
reboot_compute_instance
Reboot a running compute instance.
Requires: API key with write scope.
Esquema de entrada
{'type': 'object', 'title': 'reboot_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
recover_backup_database
Recover exactly one absent database from a completed backup.
The operation refuses an existing database and can never select ``all``.
It returns immediately; poll ``get_database_recovery`` with its durable ID.
Requires: API key with write scope.
Args:
slug: Site identifier
backup_id: UUID of a completed backup
database: One database name, never ``all``
Esquema de entrada
{'type': 'object', 'title': 'recover_backup_databaseArguments', 'required': ['slug', 'backup_id', 'database'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'database': {'type': 'string', 'title': 'Database'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}}}
recover_backup_files
Start a selected-file recovery and return its durable ID immediately.
Existing destination paths are never replaced. The operation is
asynchronous; poll ``get_file_recovery`` with the returned ID.
Requires: API key with write scope.
Args:
slug: Site identifier
backup_id: UUID of a completed backup
paths: One or more absolute paths from that backup
Returns:
{"id": "uuid", "backup_id": "uuid", "status": "running",
"paths": ["/absolute/path"], ...}
Esquema de entrada
{'type': 'object', 'title': 'recover_backup_filesArguments', 'required': ['slug', 'backup_id', 'paths'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'paths': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Paths'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}}}
register_domain
Register a new domain with WHOIS contact info and Stripe billing.
First request a quote (quote_only=True), present registration_cad,
privacy_cad, total_cad, term and privacy choice, and obtain customer consent.
Then repeat the same input with quote_only=False and the quote_token.
Never automatically accept a replacement token after a price change.
Included annual registration covers registration only; selected privacy
uses the same BoC daily USD/CAD rate, rounded to CAD cents, no markup.
Registration/renewal convert their actual operation-specific USD cost first,
then apply 10% and round up to CAD .95. Rates older than four days refuse.
Requires: API key with write scope.
Args:
whois_privacy: Explicit privacy choice; defaults selected only for supported paid TLDs.
quote_only: True returns a quote without registration or payment.
quote_token: Signed five-minute quote accepted by the customer.
domain: Full domain name (e.g. "example.ca", "mybusiness.com")
first_name: Registrant first name
last_name: Registrant last name
email: Registrant email address
phone: Phone number in E.164 format: "+1.5145551234"
address1: Street address (e.g. "123 Rue Principale")
city: City (e.g. "Montreal")
state: Province/state code (e.g. "QC", "ON", "BC")
postal_code: Postal/ZIP code (e.g. "H2X 1Y4")
country: ISO 3166-1 alpha-2 country code (default: "CA")
period: Registration period in years (1â10, default: 1)
usage_mode: What the domain points at.
"site" (default) links it to the billing subscription's
site with automatic DNS + Nginx + SSL.
"external_ns" delegates it to `nameservers` â the domain is
registered here but hosted elsewhere; we manage no DNS.
"dns_only" keeps it on our DNS with no site behind it.
"forward" redirects visitors to `forward_url`.
nameservers: Ordered list of 2â6 nameserver hostnames. Required when
usage_mode="external_ns" (e.g. ["ns1.other.com", "ns2.other.com"])
forward_url: Redirect target, required when usage_mode="forward"
(e.g. "https://example.org")
forward_type: "301" permanent (default) or "302" temporary
forward_include_path: Append the visitor's path to the target (default: True)
ca_legal_type: Required for .ca domains. CIRA legal types:
"CCT" (Canadian citizen), "RES" (permanent resident),
"CCO" (corporation), "GOV" (government), "EDU" (education),
"ASS" (association), "HOP" (hospital), "PRT" (partnership),
"TDM" (trademark), "TRD" (trade union), "PLT" (political party),
"LAM" (library/archive/museum), "MAJ" (Her Majesty),
"INB" (Indian band), "ABO" (Aboriginal peoples),
"LGR" (legal representative)
Returns:
Quote request: {"quote": {"registration_cad": "...",
"privacy_cad": "...", "total_cad": "...", "currency": "CAD",
"period": 1, "whois_privacy": false, "expires_at": "iso8601"},
"quote_token": "...", "privacy_explanation": "..."}
Purchase: {"name": "example.ca", "status": "registered",
"last_pricing_quote": {...}, ...}
Errors:
VALIDATION_ERROR: Missing required fields, invalid phone format,
missing ca_legal_type for .ca domains
NOT_FOUND: Domain not available (already registered by someone else)
Esquema de entrada
{'type': 'object', 'title': 'register_domainArguments', 'required': ['domain', 'first_name', 'last_name', 'email', 'phone', 'address1', 'city', 'state', 'postal_code'], 'properties': {'city': {'type': 'string', 'title': 'City'}, 'email': {'type': 'string', 'title': 'Email'}, 'phone': {'type': 'string', 'title': 'Phone'}, 'state': {'type': 'string', 'title': 'State'}, 'domain': {'type': 'string', 'title': 'Domain'}, 'period': {'type': 'integer', 'title': 'Period', 'default': 1}, 'country': {'type': 'string', 'title': 'Country', 'default': 'CA'}, 'address1': {'type': 'string', 'title': 'Address1'}, 'last_name': {'type': 'string', 'title': 'Last Name'}, 'first_name': {'type': 'string', 'title': 'First Name'}, 'quote_only': {'type': 'boolean', 'title': 'Quote Only', 'default': True}, 'usage_mode': {'type': 'string', 'title': 'Usage Mode', 'default': 'site'}, 'forward_url': {'type': 'string', 'title': 'Forward Url', 'default': ''}, 'nameservers': {'type': 'array', 'items': {}, 'title': 'Nameservers', 'default': None}, 'postal_code': {'type': 'string', 'title': 'Postal Code'}, 'quote_token': {'type': 'string', 'title': 'Quote Token', 'default': ''}, 'forward_type': {'type': 'string', 'title': 'Forward Type', 'default': '301'}, 'ca_legal_type': {'type': 'string', 'title': 'Ca Legal Type', 'default': ''}, 'whois_privacy': {'anyOf': [{'type': 'boolean'}, {'type': 'null'}], 'title': 'Whois Privacy', 'default': None}, 'forward_include_path': {'type': 'boolean', 'title': 'Forward Include Path', 'default': True}}}
remove_firewall_rule
Remove an IP firewall rule and reload Nginx.
Requires: API key with write scope.
Args:
slug: Site identifier
ip: IP address or CIDR to remove (must match exactly)
Returns:
{"removed": true, "ip": "1.2.3.4"}
Esquema de entrada
{'type': 'object', 'title': 'remove_firewall_ruleArguments', 'required': ['slug', 'ip'], 'properties': {'ip': {'type': 'string', 'title': 'Ip'}, 'slug': {'type': 'string', 'title': 'Slug'}}}
remove_ftp_account
Remove an SFTP account from a site.
Requires: API key with write scope.
Args:
slug: Site identifier
username: SFTP username to remove
Returns:
{"removed": true, "username": "sftpuser"}
Esquema de entrada
{'type': 'object', 'title': 'remove_ftp_accountArguments', 'required': ['slug', 'username'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'username': {'type': 'string', 'title': 'Username'}}}
remove_mailbox_alias
Remove one alias, preserving the mailbox and other aliases.
Esquema de entrada
{'type': 'object', 'title': 'remove_mailbox_aliasArguments', 'required': ['email', 'alias'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'alias': {'type': 'string', 'title': 'Alias'}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}}}
remove_port_forward
Stop publishing a port, by the rule id from list_port_forwards.
Requires: API key with write scope.
Args:
slug: Site identifier
forward_id: Rule id (uuid) from list_port_forwards
Returns:
{"removed": true, "forward_id": "..."}
Esquema de entrada
{'type': 'object', 'title': 'remove_port_forwardArguments', 'required': ['slug', 'forward_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'forward_id': {'type': 'string', 'title': 'Forward Id'}}}
reply_support_ticket
Add a message to an existing support ticket.
Requires: API key with write scope.
Args:
ticket_id: Ticket UUID
message: Reply text
Returns:
{"id", "status", ...}
Esquema de entrada
{'type': 'object', 'title': 'reply_support_ticketArguments', 'required': ['ticket_id', 'message'], 'properties': {'message': {'type': 'string', 'title': 'Message'}, 'ticket_id': {'type': 'string', 'title': 'Ticket Id'}}}
request_api_key
Request an API key for a site YOU ARE RUNNING ON (challenge-response).
â ONLY USE THIS IF YOU ARE EXECUTING INSIDE THAT SITE'S OWN CONTAINER. If
you bought or ordered the site from somewhere else, this is the wrong tool:
it returns "pending" and the pending never resolves, because the proof it
asks for is a file you cannot reach. Use `get_checkout_status(checkout_id)`
on the checkout that paid for the site â that hands over the site-scoped key
over plain HTTP with no container access. The refusal and the pending
response both name it under `alternative` when one is available.
Two-step verification flow:
1. A claim token is written into that site's container, at the per-site path
the response gives you in `claim_path` (mode 600, owner admin â readable
only from on the container). Do not hardcode the path.
2. Read that file and call claim_api_key(token) within 1 hour
Refused for sites on SHARED containers. One container there serves up to 40
customers behind one agent, so reading a file proves you are on the machine,
not which customer you are â the token would authenticate the wrong thing.
No authentication needed â the proof is reading the file from the container.
Args:
site_slug: The site identifier (your BorealHost site slug)
Returns:
{"status": "pending", "site_slug": "my-site", "expires_in_seconds": 3600,
"claim_path": "/home/admin/.borealhost/.claim_token_my-site",
"requires_container_access": true,
"instructions": "Read the claim token and call claim_api_key()...",
"alternative": {"checkout_id": "...", "command": "bh checkout status ..."}}
Errors:
VALIDATION_ERROR: Unknown site slug, no active subscription, shared
container, or a key already exists (rotate it, never revoke it to
reach this route). Carries `alternative` when another route works.
RATE_LIMITED: Too many pending claim tokens
Esquema de entrada
{'type': 'object', 'title': 'request_api_keyArguments', 'required': ['site_slug'], 'properties': {'site_slug': {'type': 'string', 'title': 'Site Slug'}}}
resend_registrant_verification
Request OpenSRS verification email to its existing owner contact.
Requires a write-scope API key and an owned registered/transferred domain.
Call only when the customer requests a resend. No recipient override.
Returns domain, send_acknowledged, inbox_delivery_confirmed (always false),
registrant_verified, and the refreshed registrant_verification snapshot.
A send acknowledgement confirms neither inbox delivery nor verification;
status can remain unknown if the subsequent status refresh fails.
PROVIDER_REFUSED (502) means no email should be assumed sent. CONFLICT (409)
means another resend is in progress; RATE_LIMITED (429) has Retry-After 3600.
Never automatically retry a refused, busy or throttled resend.
Esquema de entrada
{'type': 'object', 'title': 'resend_registrant_verificationArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
reset_email_mailbox_password
Reset password and terminate IMAP/POP sessions. Requires email:signon.
Esquema de entrada
{'type': 'object', 'title': 'reset_email_mailbox_passwordArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'new_password': {'type': 'string', 'title': 'New Password', 'default': ''}}}
reset_mailbox_password
Reset a mailbox password (generated when omitted, returned ONCE).
Requires: API key with write scope.
Returns:
{"email", "password", "message"}
Esquema de entrada
{'type': 'object', 'title': 'reset_mailbox_passwordArguments', 'required': ['slug', 'email'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'email': {'type': 'string', 'title': 'Email'}, 'new_password': {'type': 'string', 'title': 'New Password', 'default': ''}}}
restore_backup
Restore a site from a backup.
WARNING: This is destructive. The current state of the site will be
replaced. Runs asynchronously â may take several minutes.
Requires: API key with admin scope.
Args:
slug: Site identifier
backup_id: UUID of the backup to restore from
Returns:
{"success": true, "message": "Restore started..."}
Errors:
VALIDATION_ERROR: Backup not found or not in completed state
Esquema de entrada
{'type': 'object', 'title': 'restore_backupArguments', 'required': ['slug', 'backup_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'backup_id': {'type': 'string', 'title': 'Backup Id'}}}
restore_mailbox
Restore a uniquely identifiable soft-deleted mailbox under its original address.
Esquema de entrada
{'type': 'object', 'title': 'restore_mailboxArguments', 'required': ['email'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}}}
revoke_api_key
Revoke (deactivate) an API key. The key stops working immediately.
Requires: API key with write scope.
Args:
key_id: UUID of the key to revoke (from list_api_keys or whoami)
Returns:
{"success": true, "message": "API key revoked"}
Errors:
NOT_FOUND: Key not found or already revoked
Esquema de entrada
{'type': 'object', 'title': 'revoke_api_keyArguments', 'required': ['key_id'], 'properties': {'key_id': {'type': 'string', 'title': 'Key Id'}}}
revoke_smtp_relay
Revoke an SMTP relay credential (immediate at the relay).
Requires: API key with write scope.
Returns:
{"relay_id", "revoked": true}
Esquema de entrada
{'type': 'object', 'title': 'revoke_smtp_relayArguments', 'required': ['slug', 'relay_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'relay_id': {'type': 'string', 'title': 'Relay Id'}}}
rollback_snapshot
Rollback a site to a previous snapshot.
WARNING: This is destructive. The current state of the container will be
replaced with the snapshot contents.
Requires: API key with admin scope.
Args:
slug: Site identifier
snapshot_id: UUID of the snapshot to rollback to
Returns:
{"success": true, "message": "Rolled back to snapshot ..."}
Errors:
NOT_FOUND: Snapshot not found or not in completed state
Esquema de entrada
{'type': 'object', 'title': 'rollback_snapshotArguments', 'required': ['slug', 'snapshot_id'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'snapshot_id': {'type': 'string', 'title': 'Snapshot Id'}}}
rotate_email_key
Rotate the current email-only key with overlap, preserving scope and expiry.
Esquema de entrada
{'type': 'object', 'title': 'rotate_email_keyArguments', 'properties': {'grace_minutes': {'type': 'integer', 'title': 'Grace Minutes', 'default': 60}}}
rotate_key
Rotate an API key, optionally keeping the old key valid for up to 1,440 minutes.
Creates a new key with the same name, scopes, and rate limits.
The new key is returned once â store it immediately.
Requires: API key with write scope.
Args:
key_id: UUID of the API key to rotate (get from whoami())
Returns:
{"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...",
"scopes": ["read", "write"], "message": "Key rotated. Store securely."}
Expiry and all restrictions are preserved. Without a grace period the old
key stops working immediately.
Esquema de entrada
{'type': 'object', 'title': 'rotate_keyArguments', 'required': ['key_id'], 'properties': {'key_id': {'type': 'string', 'title': 'Key Id'}, 'grace_minutes': {'type': 'integer', 'title': 'Grace Minutes', 'default': 0}}}
run_malware_scan
Run a ClamAV malware scan on a site's container.
Scans the web root (or specified path) for malware, viruses, and trojans.
ClamAV is installed automatically if not present. Excludes node_modules,
vendor, .git, and cache directories.
May take up to 5 minutes for large sites.
Requires: API key with write scope.
Args:
slug: Site identifier
path: Directory to scan (default: /var/www/html)
Returns:
{"infected_files": [{"path": "/var/www/html/shell.php", "threat": "Php.Malware.Agent"}],
"scanned_count": 1234, "infected_count": 1, "scan_time_s": 45.2}
Esquema de entrada
{'type': 'object', 'title': 'run_malware_scanArguments', 'required': ['slug'], 'properties': {'path': {'type': 'string', 'title': 'Path', 'default': ''}, 'slug': {'type': 'string', 'title': 'Slug'}}}
scale
Change a site's hosting plan (upgrade or downgrade).
Requires: API key with admin scope. Best practice: create a snapshot
before downgrading.
Args:
slug: Site identifier
new_plan: Target plan slug (e.g. "site_pro", "site_managed").
Call list_plans() to see available plans.
Returns:
{"success": true, "old_plan": "site_starter", "new_plan": "site_pro",
"message": "Plan changed successfully"}
Errors:
NOT_FOUND: Unknown slug
VALIDATION_ERROR: Invalid plan slug or same plan
Esquema de entrada
{'type': 'object', 'title': 'scaleArguments', 'required': ['slug', 'new_plan'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'new_plan': {'type': 'string', 'title': 'New Plan'}}}
schedule_snapshot
Schedule a snapshot for future execution.
Requires: API key with write scope. Max 3 pending schedules per site.
Args:
slug: Site identifier
scheduled_at: ISO 8601 datetime (must be in the future)
description: Optional description (max 200 chars)
Returns:
{"id": "uuid", "scheduled_at": "iso8601", "status": "scheduled"}
Errors:
VALIDATION_ERROR: Invalid datetime, not in future, or too many pending
Esquema de entrada
{'type': 'object', 'title': 'schedule_snapshotArguments', 'required': ['slug', 'scheduled_at'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'description': {'type': 'string', 'title': 'Description', 'default': ''}, 'scheduled_at': {'type': 'string', 'title': 'Scheduled At'}}}
search_domain
Check domain availability and get pricing.
Requires: API key with read scope.
Args:
domain: Full domain name (e.g. "example.com", "mybiz.ca")
Returns:
{"domain": "example.com", "available": true,
"registration_estimate_cad": "15.99", "currency": "CAD",
"price_cad_includes_privacy": false, "total_cad": null,
"quote_required": true}
Note: .ca domains require ca_legal_type when registering.
Esquema de entrada
{'type': 'object', 'title': 'search_domainArguments', 'required': ['domain'], 'properties': {'domain': {'type': 'string', 'title': 'Domain'}}}
set_api_key
Set your BorealHost API key for this session.
Call this if you already have an API key (from checkout completion,
the BorealHost panel, or a container claim). All subsequent tool calls
will use this key for authentication.
Args:
api_key: Your BorealHost API key (format: bh_<48 hex chars>)
Returns:
{"success": true, "message": "API key set for this session",
"key_prefix": "bh_..."}
Esquema de entrada
{'type': 'object', 'title': 'set_api_keyArguments', 'required': ['api_key'], 'properties': {'api_key': {'type': 'string', 'title': 'Api Key'}}}
set_backup_retention
Set the backup retention policy for a VPS site.
Storage is billed on real stored bytes, so deeper history costs the
customer, not the platform. Values are clamped to platform bounds; the
response reports what was actually stored. Pass -1 to leave a knob
unchanged, or reset=true to restore defaults.
Requires: API key with write scope.
Returns:
{"site", "retention": {...}}
Esquema de entrada
{'type': 'object', 'title': 'set_backup_retentionArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'reset': {'type': 'boolean', 'title': 'Reset', 'default': False}, 'keep_daily': {'type': 'integer', 'title': 'Keep Daily', 'default': -1}, 'keep_weekly': {'type': 'integer', 'title': 'Keep Weekly', 'default': -1}, 'keep_monthly': {'type': 'integer', 'title': 'Keep Monthly', 'default': -1}}}
set_domain_usage
Set what a registered domain points at â a site, someone else's
nameservers, our DNS with no site, or a redirect to another URL.
Use this to park a domain, hand it to an external host, or forward it.
Switching modes tears down the previous one (a forwarded domain that
becomes a site domain loses its redirect, and vice versa).
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
usage_mode: "site" â link it to a hosted site (needs site_slug);
"external_ns" â delegate to the customer's own nameservers
(needs nameservers), we stop managing its DNS entirely;
"dns_only" â our nameservers, records edited by hand,
nothing served;
"forward" â our nameservers plus an HTTP redirect to
forward_url (needs forward_url)
site_slug: Site to link to, when usage_mode="site"
nameservers: Ordered list of 2â6 nameserver hostnames, when
usage_mode="external_ns"
forward_url: Redirect target, when usage_mode="forward"
forward_type: "301" permanent (default) or "302" temporary
forward_include_path: Append the visitor's path to the target (default: True)
Returns:
{"domain": "example.com", "usage_mode": "forward",
"forward_url": "https://example.org",
"configuration": {"dns": true, "nginx": true, "ssl": false, ...}}
For forward mode, ssl=false usually just means DNS has not propagated
yet â call this tool again a few minutes later to finish the cert.
Errors:
NOT_FOUND: Domain or site not found
VALIDATION_ERROR: Bad nameserver hostname, bad redirect URL,
missing site_slug, or a self-referential redirect
Esquema de entrada
{'type': 'object', 'title': 'set_domain_usageArguments', 'required': ['domain_name', 'usage_mode'], 'properties': {'site_slug': {'type': 'string', 'title': 'Site Slug', 'default': ''}, 'usage_mode': {'type': 'string', 'title': 'Usage Mode'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}, 'forward_url': {'type': 'string', 'title': 'Forward Url', 'default': ''}, 'nameservers': {'type': 'array', 'items': {}, 'title': 'Nameservers', 'default': None}, 'forward_type': {'type': 'string', 'title': 'Forward Type', 'default': '301'}, 'forward_include_path': {'type': 'boolean', 'title': 'Forward Include Path', 'default': True}}}
set_force_https
Enable or disable the HTTPâHTTPS redirect for a site.
Requires: API key with write scope.
Returns:
{"site", "force_https": true|false, "message"}
Esquema de entrada
{'type': 'object', 'title': 'set_force_httpsArguments', 'required': ['slug', 'enabled'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'enabled': {'type': 'boolean', 'title': 'Enabled'}}}
set_mailbox_aliases
Replace the complete alias list idempotently (maximum 2,000).
Esquema de entrada
{'type': 'object', 'title': 'set_mailbox_aliasesArguments', 'required': ['email', 'aliases'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'aliases': {'type': 'array', 'items': {'type': 'string'}, 'title': 'Aliases'}}}
set_site_nginx_snippet
Set custom nginx config on the BorealHost host proxy â WebSocket, timeouts, headers.
Use this when configuring your container's own nginx is not enough because
something in front of it is interfering. The host proxy sits between the
internet and your container, and by default its catch-all `location /` does
not do anything special per-site.
WEBSOCKETS: if your WebSocket endpoint returns 400 through your domain but
upgrades correctly (101) when tested inside your container, the Upgrade
header is being dropped in front of you. Add a location block that relays it:
location ^~ /your/ws/path/ {
proxy_pass <your site's existing upstream>;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_read_timeout 3600;
proxy_send_timeout 3600;
error_page 502 503 504 =502;
}
When testing with curl, force HTTP/1.1 (curl --http1.1). A WebSocket handshake uses the Upgrade header, which is invalid in HTTP/2 â
curl negotiates h2 with a CDN by default and the edge answers 400, which looks exactly like the bug you are trying to fix.
This config lives OUTSIDE the generated vhost, so it survives domain
re-linking, autoconfig, plan changes and reprovisioning. Sending "" clears it.
Bounds â the file is parsed by a root process on a machine shared with
BorealHost infrastructure, so only per-site proxy directives are accepted:
location, proxy_pass, proxy_set_header, proxy_http_version, proxy_*_timeout,
proxy_buffering, client_max_body_size, add_header, error_page, expires, gzip.
`root`, `alias`, `include`, `access_log`, `error_log`, `server` and `upstream`
are refused, and proxy_pass must target your own site's existing upstream.
A rejection names the directive and why.
The config is validated with `nginx -t` before it is applied and rolled back
automatically if it does not pass, so a mistake cannot take your site down.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e.g. "example.com")
content: nginx config, or "" to clear it
Returns:
{"domain": "example.com", "bytes": 214, "replaced": false}
Errors:
NOT_FOUND: Domain not found
VALIDATION_ERROR: Domain not linked to a site, a directive is not
permitted, proxy_pass targets something other than your own
upstream, or nginx rejected the config (the message says which)
Esquema de entrada
{'type': 'object', 'title': 'set_site_nginx_snippetArguments', 'required': ['domain_name', 'content'], 'properties': {'content': {'type': 'string', 'title': 'Content'}, 'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
set_site_type
Change what a site's docroot IS, without deleting anything.
Types:
wordpress WordPress, PHP and a database (the default)
php PHP and a database, no WordPress
php-nodb PHP, no database
static-site HTML/CSS/JS only, no PHP and no database
â NON-DESTRUCTIVE. Existing files stay on disk and existing databases are
not dropped. They remain the customer's data and keep counting against
their plan's quota â this changes how the site is SERVED, not what it
holds. Converting back later finds everything where it was.
â Moving to a type without PHP does not merely stop executing .php â it
stops serving them. The vhost returns 404 for php/phtml, because falling
through to the static handler would return the file's SOURCE, and a
docroot converted from WordPress still contains wp-config.php with the
database password in it.
Shared hosting only. On a VPS the whole container is the customer's and
they reconfigure it with the tools inside it.
Requires: API key with write scope.
Args:
slug: Site identifier
site_type: One of the four values above
Returns:
{"from": "wordpress", "to": "static-site", "database_created": false,
"placeholder_seeded": false, "pool_removed": true}
`placeholder_seeded` is true only when the docroot was EMPTY â an
existing site's content is never overwritten.
Errors:
VALIDATION_ERROR: Unknown type, or the site is not on shared hosting
NOT_FOUND: Unknown slug or not reachable by this account
Esquema de entrada
{'type': 'object', 'title': 'set_site_typeArguments', 'required': ['slug', 'site_type'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'site_type': {'type': 'string', 'title': 'Site Type'}}}
setup_email
Enable business email (hosted mailboxes + webmail) on a domain.
Creates the hosted-email domain, sets up outbound authentication
(DKIM/SPF), and auto-configures MX/SPF DNS when the zone is hosted by
BorealHost. Mailboxes are billed per-mailbox on the site subscription.
Requires: API key with write scope.
Returns:
{"configured": true, "domain", "dns_auto_configured", "message"}
Esquema de entrada
{'type': 'object', 'title': 'setup_emailArguments', 'required': ['slug', 'domain'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'domain': {'type': 'string', 'title': 'Domain'}}}
snapshot_compute_volume
Queue a checkpoint snapshot without detaching â before a risky change.
ASYNCHRONOUS. Returns immediately with state "snapshotting"; poll
get_compute_volume until it is back to "attached" (done) or "error".
Named systemd units are stopped for the capture so the snapshot is
application-consistent (a live database directory copied mid-write is not
reliably restorable). The worker restarts nothing â reboot or start them
yourself afterwards.
Requires: API key with write scope.
Args:
volume_id: A volume in state "attached"
quiesce_units: Services to stop during capture,
e.g. ["ollama.service", "postgresql.service"]
Returns:
Volume dict with state "snapshotting". Poll for the outcome.
Esquema de entrada
{'type': 'object', 'title': 'snapshot_compute_volumeArguments', 'required': ['volume_id'], 'properties': {'volume_id': {'type': 'string', 'title': 'Volume Id'}, 'quiesce_units': {'type': 'array', 'items': {}, 'title': 'Quiesce Units', 'default': None}}}
ssl_info
Get SSL certificate information for a site.
Returns certificate details, expiry date, and issuer.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"issuer": "Let's Encrypt", "domain": "example.com",
"expires_at": "iso8601", "days_remaining": 60,
"force_https": true}
Esquema de entrada
{'type': 'object', 'title': 'ssl_infoArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
ssl_renew
Force SSL certificate renewal via certbot.
Requires: API key with write scope.
Args:
slug: Site identifier
Returns:
{"renewed": true, "expires_at": "iso8601"}
Esquema de entrada
{'type': 'object', 'title': 'ssl_renewArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
start_compute_instance
Start a stopped compute instance.
Requires: API key with write scope.
Esquema de entrada
{'type': 'object', 'title': 'start_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
stop_compute_instance
Stop a compute instance. WARNING: hourly billing continues while stopped.
Use terminate_compute_instance to stop the charges permanently.
Requires: API key with write scope.
Esquema de entrada
{'type': 'object', 'title': 'stop_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
switch_php
Switch the active PHP version for a site.
Requires: API key with write scope.
Args:
slug: Site identifier
version: Target PHP version (e.g. "8.3", "8.2", "8.1")
Returns:
{"version": "8.3", "result": {...}}
Esquema de entrada
{'type': 'object', 'title': 'switch_phpArguments', 'required': ['slug', 'version'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'version': {'type': 'string', 'title': 'Version'}}}
terminate_compute_instance
Permanently terminate a compute instance â this stops hourly billing.
The instance and its disk are destroyed and cannot be recovered. Copy any
results off the instance before terminating.
Requires: API key with write scope.
Returns:
Final instance dict with state "terminated" and total accrued_cad.
Esquema de entrada
{'type': 'object', 'title': 'terminate_compute_instanceArguments', 'required': ['instance_id'], 'properties': {'instance_id': {'type': 'string', 'title': 'Instance Id'}}}
test_webhook
Send a test event to a webhook endpoint (async).
Poll list_webhooks afterwards for last_status.
Requires: API key with write scope.
Returns:
{"id", "message"}
Esquema de entrada
{'type': 'object', 'title': 'test_webhookArguments', 'required': ['endpoint_id'], 'properties': {'endpoint_id': {'type': 'string', 'title': 'Endpoint Id'}}}
toggle_module
Enable or disable an AI module on a site.
The module must be in the plan's available module list.
Requires: API key with write scope.
Args:
slug: Site identifier
module_name: Module to toggle. Available modules:
"chatbot" (AI chat widget), "seo" (SEO optimization),
"translation" (content translation), "content" (AI content generation)
Returns:
{"module": "chatbot", "enabled": true, "message": "Module enabled"}
Errors:
NOT_FOUND: Unknown slug or module not in plan
VALIDATION_ERROR: Invalid module name
Esquema de entrada
{'type': 'object', 'title': 'toggle_moduleArguments', 'required': ['slug', 'module_name'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'module_name': {'type': 'string', 'title': 'Module Name'}}}
transfer_out_domain
Prepare a domain to transfer to another registrar.
Unlocks the domain and emails the EPP/auth code to the registrant
contact on file (BorealHost never sees the code). The domain keeps
working here until the transfer completes.
Requires: API key with write scope.
Returns:
{"domain", "unlocked": true, "auth_code_emailed": true, "message"}
Esquema de entrada
{'type': 'object', 'title': 'transfer_out_domainArguments', 'required': ['domain_name'], 'properties': {'domain_name': {'type': 'string', 'title': 'Domain Name'}}}
update_account
Update account profile fields (email, language, name).
Requires: API key with write scope.
Only provided (non-empty) fields are updated.
Args:
email: New email address
language: Language preference â "fr" (French) or "en" (English)
first_name: First name
last_name: Last name
Returns:
{"success": true, "account": {"email": "...", "language": "fr",
"first_name": "...", "last_name": "..."}}
Errors:
VALIDATION_ERROR: Invalid email format or language code
Esquema de entrada
{'type': 'object', 'title': 'update_accountArguments', 'properties': {'email': {'type': 'string', 'title': 'Email', 'default': ''}, 'language': {'type': 'string', 'title': 'Language', 'default': ''}, 'last_name': {'type': 'string', 'title': 'Last Name', 'default': ''}, 'first_name': {'type': 'string', 'title': 'First Name', 'default': ''}}}
update_checkout
Set buyer email and desired site slug on a checkout session.
The checkout must be in "not_ready" status. Setting requested_slug
transitions status to "ready" (required before completing).
Args:
checkout_id: Checkout session ID from create_checkout
buyer_email: Optional email â if omitted, a synthetic agent identity
(agent-{uuid}@api.borealhost.ai) is created at completion
requested_slug: Desired site identifier. Must be 3-50 chars, lowercase
alphanumeric + hyphens, cannot start/end with hyphen.
Must be globally unique.
site_type: What the docroot should serve â wordpress (default), php,
php-nodb or static-site. â Set it HERE: the checkout locks once
buyer info is set, so choosing later means provisioning a
WordPress you then convert away from, abandoning its tree in the
docroot and paying a minute of provisioning for nothing.
Returns:
{"id": "uuid", "sku": "...", "plan_slug": "...",
"billing_period": "monthly", "status": "ready",
"buyer_email": "...", "requested_slug": "my-site",
"created_at": "iso8601"}
Errors:
VALIDATION_ERROR: Invalid slug format or slug already taken
FORBIDDEN: Missing checkout_secret
NOT_FOUND: Unknown checkout_id
Esquema de entrada
{'type': 'object', 'title': 'update_checkoutArguments', 'required': ['checkout_id'], 'properties': {'site_type': {'type': 'string', 'title': 'Site Type', 'default': ''}, 'buyer_email': {'type': 'string', 'title': 'Buyer Email', 'default': ''}, 'checkout_id': {'type': 'string', 'title': 'Checkout Id'}, 'requested_slug': {'type': 'string', 'title': 'Requested Slug', 'default': ''}}}
update_email_domain
Set mailbox_limit, alias_limit, quota_gb, smtp_sent_limit, services or language.
Esquema de entrada
{'type': 'object', 'title': 'update_email_domainArguments', 'required': ['domain', 'settings'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'domain': {'type': 'string', 'title': 'Domain'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'settings': {'type': 'object', 'title': 'Settings', 'additionalProperties': True}}}
update_mailbox
Set display_name, quota_gb, smtp_sent_limit, label, services or suspended.
Suspension disables client access and outbound SMTP while preserving receipt.
Esquema de entrada
{'type': 'object', 'title': 'update_mailboxArguments', 'required': ['email', 'settings'], 'properties': {'actor': {'type': 'string', 'title': 'Actor', 'default': ''}, 'email': {'type': 'string', 'title': 'Email'}, 'reason': {'type': 'string', 'title': 'Reason', 'default': ''}, 'settings': {'type': 'object', 'title': 'Settings', 'additionalProperties': True}}}
upload_file
Upload a base64-encoded file to a site's container.
Use this for binary files (images, archives, fonts, etc.).
For text files, prefer write_file().
Requires: API key with write scope.
Args:
slug: Site identifier
path: Relative path including filename (e.g. "images/logo.png")
content_b64: Base64-encoded file content
Returns:
{"success": true, "path": "images/logo.png", "size": 45678}
Errors:
VALIDATION_ERROR: Invalid base64 encoding
FORBIDDEN: Protected system path
Esquema de entrada
{'type': 'object', 'title': 'upload_fileArguments', 'required': ['slug', 'path', 'content_b64'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}, 'content_b64': {'type': 'string', 'title': 'Content B64'}}}
upload_ssl_cert
Install your own SSL certificate for a site's domain.
The certificate must be a PEM fullchain (leaf + intermediates) and the
key unencrypted PEM. Validated (parse, key match, domain coverage,
expiry) before nginx is touched; nginx config is tested before reload.
Requires: API key with write scope.
Returns:
{"site", "domain", "server_names", "installed": true,
"ssl_active": true, "not_after"}
Esquema de entrada
{'type': 'object', 'title': 'upload_ssl_certArguments', 'required': ['slug', 'domain', 'fullchain_pem', 'privkey_pem'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}, 'domain': {'type': 'string', 'title': 'Domain'}, 'privkey_pem': {'type': 'string', 'title': 'Privkey Pem'}, 'fullchain_pem': {'type': 'string', 'title': 'Fullchain Pem'}}}
whoami
Check the current API key's account info, scopes, and site count.
Requires: BOREALHOST_API_KEY env var (read scope).
Returns:
{"user": {"id": "uuid", "email": "...", "date_joined": "iso8601"},
"api_key": {"id": "uuid", "name": "...", "prefix": "bh_...",
"scopes": ["read", "write"], "created_at": "iso8601"},
"account": {"sites": 2, "active_subscriptions": 1}}
Errors:
UNAUTHORIZED: Missing or invalid API key
Esquema de entrada
{'type': 'object', 'title': 'whoamiArguments', 'properties': {}}
wp_check_updates
Check for available WordPress core, plugin, and theme updates.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{"core": {"current": "6.5", "update": "6.6"},
"plugins": [{"name": "...", "current": "1.0", "new": "1.1"}],
"themes": [...]}
Esquema de entrada
{'type': 'object', 'title': 'wp_check_updatesArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
wp_update_all
Update WordPress core, all plugins, and all themes.
Runs all updates in sequence. May take up to 2 minutes.
Requires: API key with write scope.
Args:
slug: Site identifier
Returns:
{"core": {...}, "plugins": [...], "themes": [...]}
Esquema de entrada
{'type': 'object', 'title': 'wp_update_allArguments', 'required': ['slug'], 'properties': {'slug': {'type': 'string', 'title': 'Slug'}}}
write_file
Write or overwrite a text file in a site's container.
Creates parent directories if they don't exist.
Requires: API key with write scope.
Args:
slug: Site identifier
path: Relative path to the file
content: File content as a UTF-8 string
Returns:
{"success": true, "path": "...", "size": 1234}
Errors:
NOT_FOUND: Unknown slug
FORBIDDEN: Protected system path
Esquema de entrada
{'type': 'object', 'title': 'write_fileArguments', 'required': ['slug', 'path', 'content'], 'properties': {'path': {'type': 'string', 'title': 'Path'}, 'slug': {'type': 'string', 'title': 'Slug'}, 'content': {'type': 'string', 'title': 'Content'}}}
Historial
Cambios recientes en herramientas
Eliminado
register
21 de September de 2026 a las 02:58
Añadido
list_email_audit
21 de September de 2026 a las 02:58
Añadido
set_mailbox_aliases
21 de September de 2026 a las 02:58
Añadido
remove_mailbox_alias
21 de September de 2026 a las 02:58
Añadido
add_mailbox_alias
21 de September de 2026 a las 02:58
Añadido
list_mailbox_aliases
21 de September de 2026 a las 02:58
Añadido
find_address
21 de September de 2026 a las 02:58
Añadido
get_email_webmail_url
21 de September de 2026 a las 02:58
Añadido
create_mailbox_token
21 de September de 2026 a las 02:58
Añadido
clear_mailbox_forwarding
21 de September de 2026 a las 02:58
Añadido
logout_mailbox_sessions
21 de September de 2026 a las 02:58
Añadido
reset_email_mailbox_password
21 de September de 2026 a las 02:58
Añadido
restore_mailbox
21 de September de 2026 a las 02:58
Añadido
delete_email_mailbox
21 de September de 2026 a las 02:58
Añadido
update_mailbox
21 de September de 2026 a las 02:58
Añadido
create_email_mailbox
21 de September de 2026 a las 02:58
Añadido
get_mailbox
21 de September de 2026 a las 02:58
Añadido
list_mailboxes
21 de September de 2026 a las 02:58
Añadido
disable_email_domain
21 de September de 2026 a las 02:58
Añadido
configure_email_dns
21 de September de 2026 a las 02:58
Añadido
update_email_domain
21 de September de 2026 a las 02:58
Añadido
get_email_domain
21 de September de 2026 a las 02:58
Añadido
list_email_domains
21 de September de 2026 a las 02:58
Añadido
enable_email_domain
21 de September de 2026 a las 02:58
Añadido
rotate_email_key
21 de September de 2026 a las 02:58
Modificado
add_domain_dns
21 de September de 2026 a las 02:58
Modificado
list_domain_dns
21 de September de 2026 a las 02:58
Añadido
resend_registrant_verification
21 de September de 2026 a las 02:58
Modificado
domain_settings
21 de September de 2026 a las 02:58
Modificado
register_domain
21 de September de 2026 a las 02:58
Descubrir
Servidores MCP similares
BlackVeil DNS & Email Security Scanner
com.blackveilsecurity/dns
Audits domain, DNS, email, certificate, HTTP, brand-impersonation, and agent-discovery security controls.
Hackertarget
io.github.pipeworx-io/hackertarget
Performs passive DNS, ASN, IP geolocation, HTTP header, ping, link, and network-path reconnaissance and diagnostics.
Busymate DevTools
dev.busymate/busymate-devtools
Captures, inspects, exports, and debugs HTTPS traffic from devices and applications, with request and response inspection, proxy …
Ripe Stat
io.github.pipeworx-io/ripe-stat
Provides RIPE registry and routing data for IP addresses, prefixes, ASNs, BGP state and neighbors, network ownership, geolocation…
Cloudflare Radar
io.github.pipeworx-io/cloudflare-radar
Provides Cloudflare Radar internet observatory data on DDoS attacks, BGP leaks, domain popularity, internet quality, and traffic …
Domains
io.github.pipeworx-io/domains
Checks domain registration status and availability and searches certificate-transparency records for certificates and subdomains.
Rdap
io.github.pipeworx-io/rdap
Looks up authoritative RDAP registration records for domains, IP addresses, autonomous systems, entities, and nameservers.
seekrit — secrets for agents
dev.seekrit/remote-mcp
Manages encrypted application secrets, shared secret groups, environments, access grants, service tokens, leases, KMS metadata, a…