BorealHost MCP · BorealHost
OperationalAvailability — last 30 days
Last observed 1 h ago by MCP Tools Edge Scanner · scheduled every 120 min
get_wallet was added.get_wallet was added.Raw event details
{
"beforeRev": 6,
"afterRev": 7,
"changeCount": 2
}site_type was added at add_site.inputSchema.site_type was added at add_site.inputSchema.Raw event details
{
"beforeRev": 5,
"afterRev": 6,
"changeCount": 4
}set_site_type was added.set_site_type was added.Raw event details
{
"beforeRev": 4,
"afterRev": 5,
"changeCount": 1
}add_site was added.add_site was added.Raw event details
{
"beforeRev": 3,
"afterRev": 4,
"changeCount": 2
}claim_api_key changed.| Path | Change | Classification | Detail |
|---|---|---|---|
| tools.claim_api_key | description changed | Informational | Descriptions or metadata for claim_api_key changed.No structural change. Wording changes can still influence model tool selection. |
| tools.request_api_key | description changed | Informational | Descriptions or metadata for request_api_key changed.No structural change. Wording changes can still influence model tool selection. |
cancel_checkout was added.cancel_checkout was added.Raw event details
{
"beforeRev": 2,
"afterRev": 3,
"changeCount": 6
}set_site_nginx_snippet changed.| Path | Change | Classification | Detail |
|---|---|---|---|
| tools.set_site_nginx_snippet | description changed | Informational | Descriptions or metadata for set_site_nginx_snippet changed.No structural change. Wording changes can still influence model tool selection. |
get_site_nginx_snippet was added.get_site_nginx_snippet was added.Raw event details
{
"beforeRev": 1,
"afterRev": 2,
"changeCount": 3
}Raw event details
{
"contractHash": "sha256:3fc2cc699f706370bad1ea54b816e8f73a8d84e676668aa4da28fc6a9f041891"
}Advertised capabilities
Tools 152
register
2 params
Register a new agent account and get an API key.
No authentication needed. The returned API key grants read+w…
Register a new agent account and get an API key. No authentication needed. The returned API key grants read+write access to all BorealHost API endpoints. Store it securely — it cannot be retrieved again. The key is automatically activated for this session — all subsequent tool calls will use it. No extra configuration needed. If no email is provided, a synthetic agent identity is created (agent-{uuid}@api.borealhost.ai). If an email is provided, it links to an existing or new human account. Args: name: Human-readable name for this API key (default: "Agent Key") email: Optional email to link to a human account Returns: {"api_key": "bh_...", "key_id": "uuid", "prefix": "bh_...", "scopes": ["read", "write"], "account_id": "uuid", "message": "Store this API key securely..."} Errors: RATE_LIMITED: Max 5 registrations per IP per hour VALIDATION_ERROR: Invalid email format
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| name | string | — default: "Agent Key" |
| string | — default: "" |
Raw schema JSON
{
"name": "register",
"description": "Register a new agent account and get an API key.\n\nNo authentication needed. The returned API key grants read+write access\nto all BorealHost API endpoints. Store it securely — it cannot be\nretrieved again.\n\nThe key is automatically activated for this session — all subsequent\ntool calls will use it. No extra configuration needed.\n\nIf no email is provided, a synthetic agent identity is created\n(agent-{uuid}@api.borealhost.ai). If an email is provided, it links\nto an existing or new human account.\n\nArgs:\n name: Human-readable name for this API key (default: \"Agent Key\")\n email: Optional email to link to a human account\n\nReturns:\n {\"api_key\": \"bh_...\", \"key_id\": \"uuid\", \"prefix\": \"bh_...\",\n \"scopes\": [\"read\", \"write\"], \"account_id\": \"uuid\",\n \"message\": \"Store this API key securely...\"}\n\nErrors:\n RATE_LIMITED: Max 5 registrations per IP per hour\n VALIDATION_ERROR: Invalid email format\n",
"inputSchema": {
"properties": {
"name": {
"default": "Agent Key",
"title": "Name",
"type": "string"
},
"email": {
"default": "",
"title": "Email",
"type": "string"
}
},
"title": "registerArguments",
"type": "object"
}
}set_api_key
1 param · 1 required
Set your BorealHost API key for this session.
Call this if you already have an API key (from a previous regis…
Set your BorealHost API key for this session. Call this if you already have an API key (from a previous registration, checkout completion, or the BorealHost panel). All subsequent tool calls will use this key for authentication. No need to call this after register() — the key is set automatically. 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_..."}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| api_key* | string | — |
Raw schema JSON
{
"name": "set_api_key",
"description": "Set your BorealHost API key for this session.\n\nCall this if you already have an API key (from a previous registration,\ncheckout completion, or the BorealHost panel). All subsequent tool calls\nwill use this key for authentication.\n\nNo need to call this after register() — the key is set automatically.\n\nArgs:\n api_key: Your BorealHost API key (format: bh_<48 hex chars>)\n\nReturns:\n {\"success\": true, \"message\": \"API key set for this session\",\n \"key_prefix\": \"bh_...\"}\n",
"inputSchema": {
"properties": {
"api_key": {
"title": "Api Key",
"type": "string"
}
},
"required": [
"api_key"
],
"title": "set_api_keyArguments",
"type": "object"
}
}whoami
0 params
Check the current API key's account info, scopes, and site count.
Requires: BOREALHOST_API_KEY env var (read …
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
Input schema
No parameters.
Raw schema JSON
{
"name": "whoami",
"description": "Check the current API key39;s account info, scopes, and site count.\n\nRequires: BOREALHOST_API_KEY env var (read scope).\n\nReturns:\n {\"user\": {\"id\": \"uuid\", \"email\": \"...\", \"date_joined\": \"iso8601\"},\n \"api_key\": {\"id\": \"uuid\", \"name\": \"...\", \"prefix\": \"bh_...\",\n \"scopes\": [\"read\", \"write\"], \"created_at\": \"iso8601\"},\n \"account\": {\"sites\": 2, \"active_subscriptions\": 1}}\n\nErrors:\n UNAUTHORIZED: Missing or invalid API key\n",
"inputSchema": {
"properties": {},
"title": "whoamiArguments",
"type": "object"
}
}request_api_key
1 param · 1 required
Request an API key for a site YOU ARE RUNNING ON (challenge-response).
⚠ ONLY USE THIS IF YOU ARE EXECUTING I…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| site_slug* | string | — |
Raw schema JSON
{
"name": "request_api_key",
"description": "Request an API key for a site YOU ARE RUNNING ON (challenge-response).\n\n⚠ ONLY USE THIS IF YOU ARE EXECUTING INSIDE THAT SITE39;S OWN CONTAINER. If\nyou bought or ordered the site from somewhere else, this is the wrong tool:\nit returns \"pending\" and the pending never resolves, because the proof it\nasks for is a file you cannot reach. Use `get_checkout_status(checkout_id)`\non the checkout that paid for the site — that hands over the site-scoped key\nover plain HTTP with no container access. The refusal and the pending\nresponse both name it under `alternative` when one is available.\n\nTwo-step verification flow:\n1. A claim token is written into that site39;s container, at the per-site path\n the response gives you in `claim_path` (mode 600, owner admin — readable\n only from on the container). Do not hardcode the path.\n2. Read that file and call claim_api_key(token) within 1 hour\n\nRefused for sites on SHARED containers. One container there serves up to 40\ncustomers behind one agent, so reading a file proves you are on the machine,\nnot which customer you are — the token would authenticate the wrong thing.\n\nNo authentication needed — the proof is reading the file from the container.\n\nArgs:\n site_slug: The site identifier (your BorealHost site slug)\n\nReturns:\n {\"status\": \"pending\", \"site_slug\": \"my-site\", \"expires_in_seconds\": 3600,\n \"claim_path\": \"/home/admin/.borealhost/.claim_token_my-site\",\n \"requires_container_access\": true,\n \"instructions\": \"Read the claim token and call claim_api_key()...\",\n \"alternative\": {\"checkout_id\": \"...\", \"command\": \"bh checkout status ...\"}}\n\nErrors:\n VALIDATION_ERROR: Unknown site slug, no active subscription, shared\n container, or a key already exists (rotate it, never revoke it to\n reach this route). Carries `alternative` when another route works.\n RATE_LIMITED: Too many pending claim tokens\n",
"inputSchema": {
"properties": {
"site_slug": {
"title": "Site Slug",
"type": "string"
}
},
"required": [
"site_slug"
],
"title": "request_api_keyArguments",
"type": "object"
}
}claim_api_key
1 param · 1 required
Claim an API key using a claim token from the container.
After calling request_api_key(), read the claim toke…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| claim_token* | string | — |
Raw schema JSON
{
"name": "claim_api_key",
"description": "Claim an API key using a claim token from the container.\n\nAfter calling request_api_key(), read the claim token from the path that\ncall returned in `claim_path`, on that site39;s container, and pass it here.\n\nThe token is single-use — once claimed, it cannot be used again.\nThe API key is automatically activated for this MCP session.\n\nArgs:\n claim_token: The claim token string read from the container file\n\nReturns:\n {\"api_key\": \"bh_...\", \"key_prefix\": \"bh_...\",\n \"site_slug\": \"my-site\", \"scopes\": [\"read\", \"write\"],\n \"message\": \"API key created and activated...\"}\n\nErrors:\n VALIDATION_ERROR: Invalid, expired, or already-claimed token\n",
"inputSchema": {
"properties": {
"claim_token": {
"title": "Claim Token",
"type": "string"
}
},
"required": [
"claim_token"
],
"title": "claim_api_keyArguments",
"type": "object"
}
}list_plans
2 params
List available hosting plans with pricing and resources.
No authentication needed.
Args:
track: Filter b…
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}}, ...]
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| track | string | — default: "" |
| include_deprecated | boolean | — default: false |
Raw schema JSON
{
"name": "list_plans",
"description": "List available hosting plans with pricing and resources.\n\nNo authentication needed.\n\nArgs:\n track: Filter by plan track. Valid values: \"single_site\", \"agency\".\n ⚠ The track is not the site count — most plans on BOTH tracks\n include several sites (site_starter 5, site_plus 8, site_pro 12).\n Read `max_sites` on the plan, and use add_site() to fill a slot.\n Leave empty to list all tracks.\n include_deprecated: Include deprecated plans (default: false)\n\nReturns:\n [{\"slug\": \"site_starter\", \"name\": \"Starter\", \"track\": \"single_site\",\n \"hosting_type\": \"shared\", \"price\": {\"monthly\": 5, \"annual\": 2, \"currency\": \"CAD\"},\n \"resources\": null, \"features\": {\"max_sites\": 1, \"ai_modules\": [...],\n \"ai_agents\": [], \"free_domain_annual\": false}}, ...]\n",
"inputSchema": {
"properties": {
"track": {
"default": "",
"title": "Track",
"type": "string"
},
"include_deprecated": {
"default": false,
"title": "Include Deprecated",
"type": "boolean"
}
},
"title": "list_plansArguments",
"type": "object"
}
}create_checkout
1 param · 1 required
Start a new checkout session to purchase a hosting plan.
No authentication needed. After creating, call updat…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| sku* | string | — |
Raw schema JSON
{
"name": "create_checkout",
"description": "Start a new checkout session to purchase a hosting plan.\n\nNo authentication needed. After creating, call update_checkout to set\nbuyer info, then complete_checkout to pay.\n\nThe response carries a `checkout_secret`, returned ONCE, that every later\nstep of this checkout requires. It is held in memory for this MCP session\nand sent automatically — but it is gone if the server restarts. If a session\nkey is set, the checkout is owned by that account and the API key authorizes\nthe later steps on its own, which is the durable path.\n\nArgs:\n sku: Plan SKU in format bh_{plan_slug}_{monthly|annual}.\n Examples: \"bh_site_starter_monthly\", \"bh_site_pro_annual\",\n \"bh_site_managed_monthly\", \"bh_site_business_annual\".\n Call list_plans() to discover all available plan slugs.\n\nReturns:\n {\"id\": \"uuid\", \"sku\": \"bh_site_starter_monthly\",\n \"plan_slug\": \"site_starter\", \"billing_period\": \"monthly\",\n \"status\": \"not_ready\", \"buyer_email\": \"\", \"requested_slug\": \"\",\n \"created_at\": \"iso8601\", \"checkout_secret\": \"base64-token\"}\n\nErrors:\n VALIDATION_ERROR: Invalid SKU format or unknown plan\n RATE_LIMITED: Max 10 checkouts per IP per hour\n",
"inputSchema": {
"properties": {
"sku": {
"title": "Sku",
"type": "string"
}
},
"required": [
"sku"
],
"title": "create_checkoutArguments",
"type": "object"
}
}update_checkout
4 params · 1 required
Set buyer email and desired site slug on a checkout session.
The checkout must be in "not_ready" status. Sett…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| checkout_id* | string | — |
| buyer_email | string | — default: "" |
| requested_slug | string | — default: "" |
| site_type | string | — default: "" |
Raw schema JSON
{
"name": "update_checkout",
"description": "Set buyer email and desired site slug on a checkout session.\n\nThe checkout must be in \"not_ready\" status. Setting requested_slug\ntransitions status to \"ready\" (required before completing).\n\nArgs:\n checkout_id: Checkout session ID from create_checkout\n buyer_email: Optional email — if omitted, a synthetic agent identity\n (agent-{uuid}@api.borealhost.ai) is created at completion\n requested_slug: Desired site identifier. Must be 3-50 chars, lowercase\n alphanumeric + hyphens, cannot start/end with hyphen.\n Must be globally unique.\n site_type: What the docroot should serve — wordpress (default), php,\n php-nodb or static-site. ⚠ Set it HERE: the checkout locks once\n buyer info is set, so choosing later means provisioning a\n WordPress you then convert away from, abandoning its tree in the\n docroot and paying a minute of provisioning for nothing.\n\nReturns:\n {\"id\": \"uuid\", \"sku\": \"...\", \"plan_slug\": \"...\",\n \"billing_period\": \"monthly\", \"status\": \"ready\",\n \"buyer_email\": \"...\", \"requested_slug\": \"my-site\",\n \"created_at\": \"iso8601\"}\n\nErrors:\n VALIDATION_ERROR: Invalid slug format or slug already taken\n FORBIDDEN: Missing checkout_secret\n NOT_FOUND: Unknown checkout_id\n",
"inputSchema": {
"properties": {
"checkout_id": {
"title": "Checkout Id",
"type": "string"
},
"buyer_email": {
"default": "",
"title": "Buyer Email",
"type": "string"
},
"requested_slug": {
"default": "",
"title": "Requested Slug",
"type": "string"
},
"site_type": {
"default": "",
"title": "Site Type",
"type": "string"
}
},
"required": [
"checkout_id"
],
"title": "update_checkoutArguments",
"type": "object"
}
}complete_checkout
3 params · 1 required
Complete checkout with payment and start site provisioning.
The checkout must be in "ready" status.
Two paym…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| checkout_id* | string | — |
| payment_method | string | — default: "stripe_checkout" |
| payment_method_id | string | — default: "" |
Raw schema JSON
{
"name": "complete_checkout",
"description": "Complete checkout with payment and start site provisioning.\n\nThe checkout must be in \"ready\" status.\n\nTwo payment methods:\n- \"stripe_checkout\" (default): Returns a short, chat-safe payment URL.\n **Present `payment_url` to the human — NOT `stripe_checkout_url`.**\n The raw Stripe URL has a required `#fragment` that chat UIs routinely\n strip when rendering markdown links, which causes Stripe to show\n \"page not found\". `payment_url` is a short BorealHost redirect that\n preserves the fragment via HTTP 302. After paying, the human lands on a\n confirmation page (`confirmation_url`) — not on raw JSON. Then poll\n get_checkout_status() until status becomes \"completed\". The API key\n appears in the first poll after payment (shown once, then cleared).\n Payment provisions the site; nothing else has to be called to create it.\n- \"stripe_payment_method\": Charges a Stripe PaymentMethod directly.\n Requires payment_method_id. On success, returns the API key immediately.\n\nArgs:\n checkout_id: Checkout session ID\n payment_method: \"stripe_checkout\" (returns a payment_url for a human),\n \"stripe_payment_method\" (card on file), or \"wallet\" — pay from the\n account39;s prepaid balance against THIS key39;s allowance. Check\n get_wallet() first: `spendable_cents` is what you may actually\n spend, and a wallet payment is refused for plans that order\n dedicated hardware, which are authorised against a verified card\n payment instead.\n payment_method_id: Stripe PaymentMethod ID (pm_...). Required only\n for \"stripe_payment_method\".\n\nReturns (stripe_checkout):\n {\"id\": \"uuid\", \"status\": \"awaiting_payment\",\n \"payment_url\": \"https://borealhost.ai/pay/<id>/?s=<secret>\",\n \"confirmation_url\": \"https://borealhost.ai/pay/<id>/confirmation/?s=...\",\n \"stripe_checkout_url\": \"https://checkout.stripe.com/c/pay/...\",\n \"message\": \"Present payment_url to the human...\"}\n\nReturns (stripe_payment_method):\n {\"id\": \"uuid\", \"status\": \"completed\", \"api_key\": \"bh_...\",\n \"api_key_message\": \"Store this API key securely...\",\n \"subscription_id\": \"uuid\", \"provisioning_job_id\": \"uuid\"}\n\nErrors:\n VALIDATION_ERROR: Missing payment_method_id for stripe_payment_method\n FORBIDDEN: Checkout not in \"ready\" status\n",
"inputSchema": {
"properties": {
"checkout_id": {
"title": "Checkout Id",
"type": "string"
},
"payment_method": {
"default": "stripe_checkout",
"title": "Payment Method",
"type": "string"
},
"payment_method_id": {
"default": "",
"title": "Payment Method Id",
"type": "string"
}
},
"required": [
"checkout_id"
],
"title": "complete_checkoutArguments",
"type": "object"
}
}get_checkout_status
1 param · 1 required
Poll a checkout session for status updates.
Call this after complete_checkout to track payment and provisioni…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| checkout_id* | string | — |
Raw schema JSON
{
"name": "get_checkout_status",
"description": "Poll a checkout session for status updates.\n\nCall this after complete_checkout to track payment and provisioning.\n\nPolling strategy:\n- First 60 seconds: every 5 seconds\n- After 60 seconds: every 15 seconds\n- Stop after 10 minutes if not completed\n\nCheckout statuses (in order):\n- \"not_ready\": Missing required fields (slug)\n- \"ready\": All fields set, awaiting payment\n- \"awaiting_payment\": Stripe checkout page opened, waiting for human\n- \"in_progress\": Payment received, site being provisioned\n- \"completed\": Site ready — API key included (shown once, then cleared)\n- \"canceled\": Checkout was abandoned\n- \"failed\": Payment or provisioning failed\n\nTerminal statuses: \"completed\", \"canceled\", \"failed\".\n\nArgs:\n checkout_id: Checkout session ID\n\nReturns (when completed):\n {\"id\": \"uuid\", \"status\": \"completed\", \"api_key\": \"bh_...\",\n \"api_key_message\": \"Store this API key securely...\",\n \"api_key_pending\": false,\n \"subscription_id\": \"uuid\", \"subscription_status\": \"active\",\n \"site\": {\"slug\": \"my-site\", \"status\": \"active\",\n \"url\": \"https://my-site.borealhost.ai\"},\n \"completed_at\": \"iso8601\"}\n\nImmediately after payment `site` may be null with a `provisioning_message`\n— the site is being built. Poll again in a few seconds.\n\nNote: The api_key field appears ONCE in the first poll after completion,\nthen is permanently cleared. `api_key_pending` tells you whether it is still\nwaiting to be collected. Store it immediately.\n",
"inputSchema": {
"properties": {
"checkout_id": {
"title": "Checkout Id",
"type": "string"
}
},
"required": [
"checkout_id"
],
"title": "get_checkout_statusArguments",
"type": "object"
}
}list_checkouts
1 param
List checkouts belonging to the authenticated account.
Requires: API key. Only checkouts with a recorded owne…
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": "..."}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| status | string | — default: "" |
Raw schema JSON
{
"name": "list_checkouts",
"description": "List checkouts belonging to the authenticated account.\n\nRequires: API key. Only checkouts with a recorded owner appear — every\ncheckout created while authenticated, plus every checkout that reached\npayment. An anonymous checkout whose one-shot secret was lost cannot be\nlisted; create checkouts authenticated to keep them addressable.\n\nArgs:\n status: Optional filter — \"not_ready\", \"ready\", \"awaiting_payment\",\n \"completed\", \"canceled\", \"failed\".\n\nReturns:\n {\"checkouts\": [{...same shape as get_checkout_status...}], \"note\": \"...\"}\n",
"inputSchema": {
"properties": {
"status": {
"default": "",
"title": "Status",
"type": "string"
}
},
"title": "list_checkoutsArguments",
"type": "object"
}
}cancel_checkout
1 param · 1 required
Abandon an unpaid checkout and expire its Stripe payment link.
Use this to clean up abandoned attempts rather…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| checkout_id* | string | — |
Raw schema JSON
{
"name": "cancel_checkout",
"description": "Abandon an unpaid checkout and expire its Stripe payment link.\n\nUse this to clean up abandoned attempts rather than leaving them to sit.\nA completed checkout is never cancelled here — that would be a refund, and\nit is refused.\n\nArgs:\n checkout_id: Checkout session ID\n\nReturns:\n The checkout, with status \"canceled\".\n\nErrors:\n VALIDATION_ERROR: Checkout was already paid — cancel the subscription\n from the panel instead\n FORBIDDEN: Missing checkout_secret and no owning API key\n",
"inputSchema": {
"properties": {
"checkout_id": {
"title": "Checkout Id",
"type": "string"
}
},
"required": [
"checkout_id"
],
"title": "cancel_checkoutArguments",
"type": "object"
}
}add_site
5 params · 2 required
Provision a site into a slot a plan you ALREADY PAY FOR includes.
Two different things can be meant by "creat…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| subscription_id* | string | — |
| client_name | string | — default: "" |
| domain | string | — default: "" |
| site_type | string | — default: "" |
Raw schema JSON
{
"name": "add_site",
"description": "Provision a site into a slot a plan you ALREADY PAY FOR includes.\n\nTwo different things can be meant by \"create a site\". Buying one is the\ncheckout flow (create_checkout → update → complete). This is the other: most\nplans include several sites, and this uses one of them at no extra cost.\nsite_starter includes 5, site_plus 8, site_pro 12, and the agency plans\nmore. `whoami` and `list_sites` show what the account already holds.\n\n⚠ Prefer this over buying a second subscription when a slot is free. Sites\nunder ONE subscription share one CPU pool, one disk quota and one\nrate-limit bucket — that shared budget is what the plan sells. Two\nsubscriptions split it, so the customer pays twice for capacity they had.\n\nRequires: API key with write scope, on the account that owns the plan.\n\nArgs:\n slug: Sub-domain for the new site (lowercase, digits, hyphens)\n subscription_id: The subscription whose slot to use\n client_name: Display name for the site (optional)\n domain: Custom domain; defaults to <slug>.borealhost.ai\n site_type: wordpress (default) | php | php-nodb | static-site. Choose\n here rather than provisioning WordPress and calling set_site_type\n afterwards — that installs a WordPress you then abandon in the\n docroot, and it costs a minute of provisioning.\n\nReturns:\n {\"subscription_id\": \"uuid\", \"provisioning_job_id\": \"uuid\",\n \"slug\": \"my-second-site\", \"domain\": \"my-second-site.borealhost.ai\",\n \"status\": \"provisioning\"}\n Poll get_site_status(slug) until it reports active.\n\nErrors:\n VALIDATION_ERROR: Plan includes a single site, slug taken, or every\n slot is in use (the message reports used/total)\n NOT_FOUND: Unknown subscription, or it belongs to another account\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"subscription_id": {
"title": "Subscription Id",
"type": "string"
},
"client_name": {
"default": "",
"title": "Client Name",
"type": "string"
},
"domain": {
"default": "",
"title": "Domain",
"type": "string"
},
"site_type": {
"default": "",
"title": "Site Type",
"type": "string"
}
},
"required": [
"slug",
"subscription_id"
],
"title": "add_siteArguments",
"type": "object"
}
}set_site_type
2 params · 2 required
Change what a site's docroot IS, without deleting anything.
Types:
wordpress WordPress, PHP and a databa…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| site_type* | string | — |
Raw schema JSON
{
"name": "set_site_type",
"description": "Change what a site39;s docroot IS, without deleting anything.\n\nTypes:\n wordpress WordPress, PHP and a database (the default)\n php PHP and a database, no WordPress\n php-nodb PHP, no database\n static-site HTML/CSS/JS only, no PHP and no database\n\n⚠ NON-DESTRUCTIVE. Existing files stay on disk and existing databases are\nnot dropped. They remain the customer39;s data and keep counting against\ntheir plan39;s quota — this changes how the site is SERVED, not what it\nholds. Converting back later finds everything where it was.\n\n⚠ Moving to a type without PHP does not merely stop executing .php — it\nstops serving them. The vhost returns 404 for php/phtml, because falling\nthrough to the static handler would return the file39;s SOURCE, and a\ndocroot converted from WordPress still contains wp-config.php with the\ndatabase password in it.\n\nShared hosting only. On a VPS the whole container is the customer39;s and\nthey reconfigure it with the tools inside it.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n site_type: One of the four values above\n\nReturns:\n {\"from\": \"wordpress\", \"to\": \"static-site\", \"database_created\": false,\n \"placeholder_seeded\": false, \"pool_removed\": true}\n `placeholder_seeded` is true only when the docroot was EMPTY — an\n existing site39;s content is never overwritten.\n\nErrors:\n VALIDATION_ERROR: Unknown type, or the site is not on shared hosting\n NOT_FOUND: Unknown slug or not reachable by this account\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"site_type": {
"title": "Site Type",
"type": "string"
}
},
"required": [
"slug",
"site_type"
],
"title": "set_site_typeArguments",
"type": "object"
}
}get_wallet
0 params
The account's prepaid balance, and what THIS key may spend from it.
Two ceilings, and both apply: the balance…
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").
Input schema
No parameters.
Raw schema JSON
{
"name": "get_wallet",
"description": "The account39;s prepaid balance, and what THIS key may spend from it.\n\nTwo ceilings, and both apply: the balance bounds the ACCOUNT, the allowance\nbounds this KEY within it. Plan against `spendable_cents`, which is the\nlower of the two — a $50 balance behind a $5 allowance means $5, and\nplanning against the balance is planning a purchase that gets refused.\n\n`can_spend: false` with a non-zero balance is normal and means this key has\nno budget allocated. That is not a bug: a key with no allowance may not\nspend the account39;s money, which is the whole reason allowances exist. Ask\nthe human to allocate one in the panel (Compte → Clés API).\n\nRead-only. Money goes in through a human — an agent able to top up its own\nbudget does not have one.\n\nRequires: API key with read scope.\n\nReturns:\n {\"currency\": \"CAD\", \"balance_cents\": 5000, \"spendable_cents\": 500,\n \"can_spend\": true,\n \"key_allowance\": {\"limit_cents\": 2000, \"spent_cents\": 1500,\n \"remaining_cents\": 500}}\n\nTo spend it: complete_checkout(..., payment_method=\"wallet\").\n",
"inputSchema": {
"properties": {},
"title": "get_walletArguments",
"type": "object"
}
}get_site_status
1 param · 1 required
Get detailed status of a hosted site including resources, domains, and modules.
Requires: API key with read s…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_site_status",
"description": "Get detailed status of a hosted site including resources, domains, and modules.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier (the slug chosen during checkout)\n\nReturns:\n {\"slug\": \"my-site\", \"plan\": \"site_starter\", \"status\": \"active\",\n \"domains\": [\"my-site.borealhost.ai\"], \"modules\": {...},\n \"resources\": {\"memory_mb\": 512, \"cpu_cores\": 1, \"disk_gb\": 10},\n \"created_at\": \"iso8601\"}\n\nErrors:\n NOT_FOUND: Unknown slug or not owned by this account\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_site_statusArguments",
"type": "object"
}
}manage_dns
6 params · 3 required
Create or delete DNS records for a site.
Requires: API key with write scope.
Args:
slug: Site identifier…
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" ttl: Time to live in seconds (default: 3600) Returns: {"success": true, "record": {"type": "A", "subdomain": "www", "value": "1.2.3.4", "ttl": 3600}} Errors: VALIDATION_ERROR: Missing value for create, invalid record type NOT_FOUND: Unknown slug
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| action* | string | — |
| record_type* | string | — |
| subdomain | string | — default: "" |
| value | string | — default: "" |
| ttl | integer | — default: 3600 |
Raw schema JSON
{
"name": "manage_dns",
"description": "Create or delete DNS records for a site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n action: \"create\" or \"delete\"\n record_type: \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\", or \"SRV\"\n subdomain: Subdomain part (e.g. \"www\", \"mail\"). Leave empty for\n the apex/root domain.\n value: Record value. Required for \"create\". Examples:\n A: \"1.2.3.4\", CNAME: \"example.com\", MX: \"mail.example.com\",\n TXT: \"v=spf1 include:_spf.google.com ~all\"\n ttl: Time to live in seconds (default: 3600)\n\nReturns:\n {\"success\": true, \"record\": {\"type\": \"A\", \"subdomain\": \"www\",\n \"value\": \"1.2.3.4\", \"ttl\": 3600}}\n\nErrors:\n VALIDATION_ERROR: Missing value for create, invalid record type\n NOT_FOUND: Unknown slug\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"record_type": {
"title": "Record Type",
"type": "string"
},
"subdomain": {
"default": "",
"title": "Subdomain",
"type": "string"
},
"value": {
"default": "",
"title": "Value",
"type": "string"
},
"ttl": {
"default": 3600,
"title": "Ttl",
"type": "integer"
}
},
"required": [
"slug",
"action",
"record_type"
],
"title": "manage_dnsArguments",
"type": "object"
}
}install_app
6 params · 3 required
Install an app template on a VPS/Cloud site.
Starts a background installation. Poll get_app_status() for prog…
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 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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| template* | string | — |
| app_name* | string | — |
| db_type | string | — default: "none" |
| domain | string | — default: "" |
| display_name | string | — default: "" |
Raw schema JSON
{
"name": "install_app",
"description": "Install an app template on a VPS/Cloud site.\n\nStarts a background installation. Poll get_app_status() for progress.\n\nRequires: API key with write scope. VPS or Cloud plan only.\n\nArgs:\n slug: Site identifier\n template: App template slug. Available: django, laravel, nextjs, nodejs,\n nuxtjs, rails, static\n app_name: Short name for the app (2-50 chars, lowercase alphanumeric + hyphens).\n Used as subdomain: {app_name}.{site_domain}\n db_type: Database type. \"none\", \"mysql\", or \"postgresql\" (depends on template)\n domain: Custom domain override (default: {app_name}.{site_domain})\n display_name: Human-friendly name (default: derived from app_name)\n\nReturns:\n {\"id\": \"uuid\", \"app_name\": \"myapp\", \"status\": \"installing\",\n \"message\": \"Installation started. Poll for progress.\"}\n\nErrors:\n FORBIDDEN: Plan does not support apps (shared plans)\n VALIDATION_ERROR: Invalid template, app_name, or duplicate name\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"template": {
"title": "Template",
"type": "string"
},
"app_name": {
"title": "App Name",
"type": "string"
},
"db_type": {
"default": "none",
"title": "Db Type",
"type": "string"
},
"domain": {
"default": "",
"title": "Domain",
"type": "string"
},
"display_name": {
"default": "",
"title": "Display Name",
"type": "string"
}
},
"required": [
"slug",
"template",
"app_name"
],
"title": "install_appArguments",
"type": "object"
}
}get_app_status
2 params · 2 required
Get app installation status and log.
Poll this after install_app() to track progress.
Requires: API key with…
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"
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| app_id* | string | — |
Raw schema JSON
{
"name": "get_app_status",
"description": "Get app installation status and log.\n\nPoll this after install_app() to track progress.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n app_id: App ID from install_app() response\n\nReturns:\n {\"id\": \"uuid\", \"app_name\": \"myapp\", \"status\": \"running\"|\"installing\"|\"failed\",\n \"install_log\": \"...\"}\n\nStatuses: \"installing\", \"running\", \"stopped\", \"failed\", \"uninstalled\"\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"app_id": {
"title": "App Id",
"type": "string"
}
},
"required": [
"slug",
"app_id"
],
"title": "get_app_statusArguments",
"type": "object"
}
}list_apps
1 param · 1 required
List installed apps on a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
…
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"}]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_apps",
"description": "List installed apps on a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"apps\": [{\"id\": \"uuid\", \"app_name\": \"myapp\", \"template_slug\": \"django\",\n \"status\": \"running\", \"domain\": \"myapp.mysite.borealhost.ai\"}]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_appsArguments",
"type": "object"
}
}list_snapshots
1 param · 1 required
List all snapshots and scheduled snapshots for a site.
Requires: API key with read scope.
Args:
slug: Si…
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": [...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_snapshots",
"description": "List all snapshots and scheduled snapshots for a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"snapshots\": [{\"id\": \"uuid\", \"name\": \"snap-...\", \"status\": \"completed\",\n \"storage_type\": \"local\"|\"b2\", \"size_bytes\": 1234, \"size_display\": \"1.2 Mo\",\n \"created_at\": \"iso8601\"}], \"scheduled\": [...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_snapshotsArguments",
"type": "object"
}
}create_snapshot
2 params · 1 required
Create a local container snapshot (async).
Runs in background — returns immediately with status "creating".
P…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| description | string | — default: "" |
Raw schema JSON
{
"name": "create_snapshot",
"description": "Create a local container snapshot (async).\n\nRuns in background — returns immediately with status \"creating\".\nPoll list_snapshots() to check when status becomes \"completed\" or \"failed\".\n\nAvailable for VPS, dedicated, and cloud plans (any plan with max_snapshots > 0).\nLocal snapshots are stored on the host disk and count against disk quota.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n description: Optional description (max 200 chars)\n\nReturns:\n {\"id\": \"uuid\", \"name\": \"snap-...\", \"status\": \"creating\",\n \"storage_type\": \"local\",\n \"message\": \"Snapshot started. Poll list_snapshots() to check status.\"}\n\nErrors:\n VALIDATION_ERROR: Max snapshots reached or insufficient disk quota\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
}
},
"required": [
"slug"
],
"title": "create_snapshotArguments",
"type": "object"
}
}create_b2_snapshot
2 params · 1 required
Create a B2 cloud-backed snapshot (zero local disk, async).
Streams container data directly to Backblaze B2 v…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| description | string | — default: "" |
Raw schema JSON
{
"name": "create_b2_snapshot",
"description": "Create a B2 cloud-backed snapshot (zero local disk, async).\n\nStreams container data directly to Backblaze B2 via restic.\nNo local disk impact — billed separately at cost+5%.\nRuns in background — returns immediately with status \"creating\".\nPoll list_snapshots() to check when status becomes \"completed\".\nOnly available for VPS plans.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n description: Optional description (max 200 chars)\n\nReturns:\n {\"id\": \"uuid\", \"name\": \"...\", \"status\": \"creating\",\n \"storage_type\": \"b2\",\n \"message\": \"B2 cloud snapshot started. Poll list_snapshots()...\"}\n\nErrors:\n VALIDATION_ERROR: Not a VPS plan or max snapshots reached\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
}
},
"required": [
"slug"
],
"title": "create_b2_snapshotArguments",
"type": "object"
}
}delete_snapshot
2 params · 2 required
Delete a snapshot (local or B2).
Requires: API key with write scope.
Args:
slug: Site identifier
sna…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| snapshot_id* | string | — |
Raw schema JSON
{
"name": "delete_snapshot",
"description": "Delete a snapshot (local or B2).\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n snapshot_id: UUID of the snapshot to delete\n\nReturns:\n {\"success\": true, \"message\": \"Snapshot deleted\"}\n\nErrors:\n NOT_FOUND: Snapshot not found\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"snapshot_id": {
"title": "Snapshot Id",
"type": "string"
}
},
"required": [
"slug",
"snapshot_id"
],
"title": "delete_snapshotArguments",
"type": "object"
}
}rollback_snapshot
2 params · 2 required
Rollback a site to a previous snapshot.
WARNING: This is destructive. The current state of the container will…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| snapshot_id* | string | — |
Raw schema JSON
{
"name": "rollback_snapshot",
"description": "Rollback a site to a previous snapshot.\n\nWARNING: This is destructive. The current state of the container will be\nreplaced with the snapshot contents.\n\nRequires: API key with admin scope.\n\nArgs:\n slug: Site identifier\n snapshot_id: UUID of the snapshot to rollback to\n\nReturns:\n {\"success\": true, \"message\": \"Rolled back to snapshot ...\"}\n\nErrors:\n NOT_FOUND: Snapshot not found or not in completed state\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"snapshot_id": {
"title": "Snapshot Id",
"type": "string"
}
},
"required": [
"slug",
"snapshot_id"
],
"title": "rollback_snapshotArguments",
"type": "object"
}
}get_snapshot_usage
1 param · 1 required
Get snapshot disk usage and quota info for a site.
Requires: API key with read scope.
Args:
slug: Site i…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_snapshot_usage",
"description": "Get snapshot disk usage and quota info for a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"disk_quota_gb\": 200, \"max_snapshots\": 5, \"snapshot_count\": 2,\n \"local_snapshot_bytes\": 1234, \"b2_snapshot_bytes\": 5678,\n \"can_create\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_snapshot_usageArguments",
"type": "object"
}
}schedule_snapshot
3 params · 2 required
Schedule a snapshot for future execution.
Requires: API key with write scope. Max 3 pending schedules per sit…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| scheduled_at* | string | — |
| description | string | — default: "" |
Raw schema JSON
{
"name": "schedule_snapshot",
"description": "Schedule a snapshot for future execution.\n\nRequires: API key with write scope. Max 3 pending schedules per site.\n\nArgs:\n slug: Site identifier\n scheduled_at: ISO 8601 datetime (must be in the future)\n description: Optional description (max 200 chars)\n\nReturns:\n {\"id\": \"uuid\", \"scheduled_at\": \"iso8601\", \"status\": \"scheduled\"}\n\nErrors:\n VALIDATION_ERROR: Invalid datetime, not in future, or too many pending\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"scheduled_at": {
"title": "Scheduled At",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
}
},
"required": [
"slug",
"scheduled_at"
],
"title": "schedule_snapshotArguments",
"type": "object"
}
}cancel_scheduled_snapshot
2 params · 2 required
Cancel a scheduled snapshot.
Requires: API key with write scope.
Args:
slug: Site identifier
schedul…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| schedule_id* | string | — |
Raw schema JSON
{
"name": "cancel_scheduled_snapshot",
"description": "Cancel a scheduled snapshot.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n schedule_id: UUID of the scheduled snapshot to cancel\n\nReturns:\n {\"success\": true, \"message\": \"Scheduled snapshot cancelled\"}\n\nErrors:\n NOT_FOUND: Schedule not found or already executed\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"schedule_id": {
"title": "Schedule Id",
"type": "string"
}
},
"required": [
"slug",
"schedule_id"
],
"title": "cancel_scheduled_snapshotArguments",
"type": "object"
}
}list_backups
1 param · 1 required
List all backups for a site (automatic and manual).
Requires: API key with read scope.
Args:
slug: Site …
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": "..."}]
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_backups",
"description": "List all backups for a site (automatic and manual).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n [{\"id\": \"uuid\", \"backup_type\": \"auto\"|\"manual\", \"status\": \"completed\",\n \"size_bytes\": 1234, \"size_display\": \"1.2 Mo\",\n \"timestamp\": \"iso8601\", \"notes\": \"...\"}]\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_backupsArguments",
"type": "object"
}
}create_backup
1 param · 1 required
Create a manual backup (runs asynchronously).
The backup starts in the background. Poll list_backups() to che…
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."}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "create_backup",
"description": "Create a manual backup (runs asynchronously).\n\nThe backup starts in the background. Poll list_backups() to check status.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"id\": \"uuid\", \"status\": \"pending\",\n \"message\": \"Backup started. Poll list_backups() to check status.\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "create_backupArguments",
"type": "object"
}
}restore_backup
2 params · 2 required
Restore a site from a backup.
WARNING: This is destructive. The current state of the site will be
replaced. R…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| backup_id* | string | — |
Raw schema JSON
{
"name": "restore_backup",
"description": "Restore a site from a backup.\n\nWARNING: This is destructive. The current state of the site will be\nreplaced. Runs asynchronously — may take several minutes.\n\nRequires: API key with admin scope.\n\nArgs:\n slug: Site identifier\n backup_id: UUID of the backup to restore from\n\nReturns:\n {\"success\": true, \"message\": \"Restore started...\"}\n\nErrors:\n VALIDATION_ERROR: Backup not found or not in completed state\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"backup_id": {
"title": "Backup Id",
"type": "string"
}
},
"required": [
"slug",
"backup_id"
],
"title": "restore_backupArguments",
"type": "object"
}
}get_metrics
2 params · 1 required
Get traffic and performance metrics for a site.
Requires: API key with read scope.
Args:
slug: Site iden…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| days | integer | — default: 7 |
Raw schema JSON
{
"name": "get_metrics",
"description": "Get traffic and performance metrics for a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n days: Number of days of history (1–90, default: 7)\n\nReturns:\n {\"requests\": [...], \"bandwidth\": [...], \"errors\": [...],\n \"period\": {\"start\": \"iso8601\", \"end\": \"iso8601\"}}\n\nErrors:\n NOT_FOUND: Unknown slug\n VALIDATION_ERROR: days out of range\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"days": {
"default": 7,
"title": "Days",
"type": "integer"
}
},
"required": [
"slug"
],
"title": "get_metricsArguments",
"type": "object"
}
}scale
2 params · 2 required
Change a site's hosting plan (upgrade or downgrade).
Requires: API key with admin scope. Best practice: creat…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| new_plan* | string | — |
Raw schema JSON
{
"name": "scale",
"description": "Change a site39;s hosting plan (upgrade or downgrade).\n\nRequires: API key with admin scope. Best practice: create a snapshot\nbefore downgrading.\n\nArgs:\n slug: Site identifier\n new_plan: Target plan slug (e.g. \"site_pro\", \"site_managed\").\n Call list_plans() to see available plans.\n\nReturns:\n {\"success\": true, \"old_plan\": \"site_starter\", \"new_plan\": \"site_pro\",\n \"message\": \"Plan changed successfully\"}\n\nErrors:\n NOT_FOUND: Unknown slug\n VALIDATION_ERROR: Invalid plan slug or same plan\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"new_plan": {
"title": "New Plan",
"type": "string"
}
},
"required": [
"slug",
"new_plan"
],
"title": "scaleArguments",
"type": "object"
}
}decommission
1 param · 1 required
Delete a site and schedule resource cleanup (7-day grace period).
WARNING: This is destructive. The site will…
Delete a site and schedule resource cleanup (7-day grace period). WARNING: This is destructive. The site will be inaccessible immediately but data is retained for 7 days before permanent deletion. 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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "decommission",
"description": "Delete a site and schedule resource cleanup (7-day grace period).\n\nWARNING: This is destructive. The site will be inaccessible immediately\nbut data is retained for 7 days before permanent deletion.\n\nBest practice: create a snapshot before decommissioning.\n\nRequires: API key with admin scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"success\": true, \"message\": \"Site scheduled for deletion\",\n \"grace_period_days\": 7}\n\nErrors:\n NOT_FOUND: Unknown slug\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "decommissionArguments",
"type": "object"
}
}update_account
4 params
Update account profile fields (email, language, name).
Requires: API key with write scope.
Only provided (non…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| string | — default: "" |
|
| language | string | — default: "" |
| first_name | string | — default: "" |
| last_name | string | — default: "" |
Raw schema JSON
{
"name": "update_account",
"description": "Update account profile fields (email, language, name).\n\nRequires: API key with write scope.\nOnly provided (non-empty) fields are updated.\n\nArgs:\n email: New email address\n language: Language preference — \"fr\" (French) or \"en\" (English)\n first_name: First name\n last_name: Last name\n\nReturns:\n {\"success\": true, \"account\": {\"email\": \"...\", \"language\": \"fr\",\n \"first_name\": \"...\", \"last_name\": \"...\"}}\n\nErrors:\n VALIDATION_ERROR: Invalid email format or language code\n",
"inputSchema": {
"properties": {
"email": {
"default": "",
"title": "Email",
"type": "string"
},
"language": {
"default": "",
"title": "Language",
"type": "string"
},
"first_name": {
"default": "",
"title": "First Name",
"type": "string"
},
"last_name": {
"default": "",
"title": "Last Name",
"type": "string"
}
},
"title": "update_accountArguments",
"type": "object"
}
}delete_account
0 params
Permanently anonymize the account. Cancels subscriptions, deactivates keys.
WARNING: This is irreversible. Th…
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"}
Input schema
No parameters.
Raw schema JSON
{
"name": "delete_account",
"description": "Permanently anonymize the account. Cancels subscriptions, deactivates keys.\n\nWARNING: This is irreversible. The account will be soft-deleted and all\npersonal data anonymized. All sites will be decommissioned.\n\nRequires: API key with admin scope.\n\nReturns:\n {\"success\": true, \"message\": \"Account anonymized\"}\n",
"inputSchema": {
"properties": {},
"title": "delete_accountArguments",
"type": "object"
}
}list_subscriptions
0 params
List all subscriptions with plan details, pricing, status, and site slug.
Requires: API key with read scope.
…
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"}]
Input schema
No parameters.
Raw schema JSON
{
"name": "list_subscriptions",
"description": "List all subscriptions with plan details, pricing, status, and site slug.\n\nRequires: API key with read scope.\n\nReturns:\n [{\"id\": \"uuid\", \"plan_slug\": \"site_starter\", \"plan_name\": \"Starter\",\n \"status\": \"active\", \"billing_period\": \"monthly\",\n \"price\": {\"amount\": 500, \"currency\": \"cad\"},\n \"site_slug\": \"my-site\", \"created_at\": \"iso8601\"}]\n",
"inputSchema": {
"properties": {},
"title": "list_subscriptionsArguments",
"type": "object"
}
}get_billing_portal
1 param
Get a Stripe billing portal URL for managing payment methods and invoices.
Returns a URL (not a redirect) tha…
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/..."}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| flow | string | — default: "" |
Raw schema JSON
{
"name": "get_billing_portal",
"description": "Get a Stripe billing portal URL for managing payment methods and invoices.\n\nReturns a URL (not a redirect) that the human can open in a browser.\n\nRequires: API key with read scope.\n\nArgs:\n flow: Optional. Set to \"payment_method_update\" to go directly\n to the payment method update page.\n\nReturns:\n {\"url\": \"https://billing.stripe.com/p/session/...\"}\n",
"inputSchema": {
"properties": {
"flow": {
"default": "",
"title": "Flow",
"type": "string"
}
},
"title": "get_billing_portalArguments",
"type": "object"
}
}rotate_key
1 param · 1 required
Atomically rotate an API key. Old key is immediately invalidated.
Creates a new key with the same name, scope…
Atomically rotate an API key. Old key is immediately invalidated. 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."} Note: The old key stops working immediately. Update BOREALHOST_API_KEY right away.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| key_id* | string | — |
Raw schema JSON
{
"name": "rotate_key",
"description": "Atomically rotate an API key. Old key is immediately invalidated.\n\nCreates a new key with the same name, scopes, and rate limits.\nThe new key is returned once — store it immediately.\n\nRequires: API key with write scope.\n\nArgs:\n key_id: UUID of the API key to rotate (get from whoami())\n\nReturns:\n {\"api_key\": \"bh_...\", \"key_id\": \"uuid\", \"prefix\": \"bh_...\",\n \"scopes\": [\"read\", \"write\"], \"message\": \"Key rotated. Store securely.\"}\n\nNote: The old key stops working immediately. Update BOREALHOST_API_KEY\nright away.\n",
"inputSchema": {
"properties": {
"key_id": {
"title": "Key Id",
"type": "string"
}
},
"required": [
"key_id"
],
"title": "rotate_keyArguments",
"type": "object"
}
}create_api_key
3 params · 1 required
Create a new API key with specified scopes.
Cannot create keys with higher scopes than the current key.
Site-…
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. 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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| name* | string | — |
| scopes | string | — default: "read" |
| site_slug | string | — default: "" |
Raw schema JSON
{
"name": "create_api_key",
"description": "Create a new API key with specified scopes.\n\nCannot create keys with higher scopes than the current key.\nSite-scoped keys restrict access to a single site.\n\nRequires: API key with write scope.\n\nArgs:\n name: Human-readable name for the key (1-100 chars)\n scopes: Comma-separated scopes. Options: \"read\", \"read,write\",\n \"read,write,admin\". Default: \"read\"\n site_slug: Optional — restrict the key to a single site.\n Omit for account-wide access.\n\nReturns:\n {\"api_key\": \"bh_...\", \"key_id\": \"uuid\", \"prefix\": \"bh_...\",\n \"name\": \"My Key\", \"scopes\": [\"read\", \"write\"],\n \"message\": \"Store this API key securely — it will not be shown again.\"}\n\nErrors:\n VALIDATION_ERROR: Invalid name, scopes, or max 25 active keys\n FORBIDDEN: Cannot create keys with higher scopes than current key\n",
"inputSchema": {
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"scopes": {
"default": "read",
"title": "Scopes",
"type": "string"
},
"site_slug": {
"default": "",
"title": "Site Slug",
"type": "string"
}
},
"required": [
"name"
],
"title": "create_api_keyArguments",
"type": "object"
}
}list_api_keys
0 params
List all API keys for the account.
Shows key metadata (name, prefix, scopes, last used) but never the
full ke…
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"}]
Input schema
No parameters.
Raw schema JSON
{
"name": "list_api_keys",
"description": "List all API keys for the account.\n\nShows key metadata (name, prefix, scopes, last used) but never the\nfull key value.\n\nRequires: API key with read scope.\n\nReturns:\n [{\"id\": \"uuid\", \"name\": \"My Key\", \"prefix\": \"bh_a2...\",\n \"scopes\": [\"read\", \"write\"], \"is_active\": true,\n \"created_at\": \"iso8601\", \"last_used_at\": \"iso8601\"|null,\n \"site_slug\": null|\"my-site\"}]\n",
"inputSchema": {
"properties": {},
"title": "list_api_keysArguments",
"type": "object"
}
}revoke_api_key
1 param · 1 required
Revoke (deactivate) an API key. The key stops working immediately.
Requires: API key with write scope.
Args:…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| key_id* | string | — |
Raw schema JSON
{
"name": "revoke_api_key",
"description": "Revoke (deactivate) an API key. The key stops working immediately.\n\nRequires: API key with write scope.\n\nArgs:\n key_id: UUID of the key to revoke (from list_api_keys or whoami)\n\nReturns:\n {\"success\": true, \"message\": \"API key revoked\"}\n\nErrors:\n NOT_FOUND: Key not found or already revoked\n",
"inputSchema": {
"properties": {
"key_id": {
"title": "Key Id",
"type": "string"
}
},
"required": [
"key_id"
],
"title": "revoke_api_keyArguments",
"type": "object"
}
}get_ssh_info
1 param · 1 required
Get SSH connection info for a VPS/dedicated site.
Only available for VPS/dedicated plans (not shared hosting)…
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)
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_ssh_info",
"description": "Get SSH connection info for a VPS/dedicated site.\n\nOnly available for VPS/dedicated plans (not shared hosting).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"host\": \"184.107.x.x\", \"port\": 22, \"username\": \"admin\",\n \"ssh_command\": \"ssh admin@184.107.x.x\"}\n\nErrors:\n NOT_FOUND: Unknown slug\n FORBIDDEN: Plan does not support SSH (shared plans)\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_ssh_infoArguments",
"type": "object"
}
}add_ssh_key
2 params · 2 required
Inject your SSH public key into a site's container for direct SSH access.
The key is appended to /home/admin/…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| public_key* | string | — |
Raw schema JSON
{
"name": "add_ssh_key",
"description": "Inject your SSH public key into a site39;s container for direct SSH access.\n\nThe key is appended to /home/admin/.ssh/authorized_keys.\nOnly available for VPS/dedicated plans.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n public_key: SSH public key string. Supported types:\n ssh-ed25519, ssh-rsa, ecdsa-sha2-nistp256/384/521\n\nReturns:\n {\"success\": true, \"message\": \"SSH key added\",\n \"ssh_command\": \"ssh admin@184.107.x.x\"}\n\nErrors:\n VALIDATION_ERROR: Invalid or unsupported key format\n FORBIDDEN: Plan does not support SSH\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"public_key": {
"title": "Public Key",
"type": "string"
}
},
"required": [
"slug",
"public_key"
],
"title": "add_ssh_keyArguments",
"type": "object"
}
}list_files
2 params · 1 required
List files and directories in a site's container.
Path scoping depends on the plan:
- Shared plans: rooted at…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path | string | — default: "" |
Raw schema JSON
{
"name": "list_files",
"description": "List files and directories in a site39;s container.\n\nPath scoping depends on the plan:\n- Shared plans: rooted at wp-content/ (WordPress content directory)\n- VPS/dedicated plans: full filesystem access\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n path: Relative path to list (empty for root of accessible area)\n\nReturns:\n {\"path\": \"/\", \"entries\": [{\"name\": \"index.php\", \"type\": \"file\",\n \"size\": 1234, \"modified\": \"iso8601\"}, {\"name\": \"uploads\",\n \"type\": \"directory\", \"modified\": \"iso8601\"}]}\n\nErrors:\n NOT_FOUND: Unknown slug or path doesn39;t exist\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"default": "",
"title": "Path",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_filesArguments",
"type": "object"
}
}read_file
2 params · 2 required
Read the contents of a file from a site's container.
Max file size: 512KB. Binary files are rejected — use th…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path* | string | — |
Raw schema JSON
{
"name": "read_file",
"description": "Read the contents of a file from a site39;s container.\n\nMax file size: 512KB. Binary files are rejected — use the site39;s\nfile manager or SSH for binary files.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n path: Relative path to the file\n\nReturns:\n {\"path\": \"wp-config.php\", \"content\": \"<?php ...\",\n \"size\": 1234, \"encoding\": \"utf-8\"}\n\nErrors:\n NOT_FOUND: File doesn39;t exist\n VALIDATION_ERROR: File is binary or exceeds 512KB\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"slug",
"path"
],
"title": "read_fileArguments",
"type": "object"
}
}write_file
3 params · 3 required
Write or overwrite a text file in a site's container.
Creates parent directories if they don't exist.
Requir…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path* | string | — |
| content* | string | — |
Raw schema JSON
{
"name": "write_file",
"description": "Write or overwrite a text file in a site39;s container.\n\nCreates parent directories if they don39;t exist.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n path: Relative path to the file\n content: File content as a UTF-8 string\n\nReturns:\n {\"success\": true, \"path\": \"...\", \"size\": 1234}\n\nErrors:\n NOT_FOUND: Unknown slug\n FORBIDDEN: Protected system path\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
},
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"slug",
"path",
"content"
],
"title": "write_fileArguments",
"type": "object"
}
}upload_file
3 params · 3 required
Upload a base64-encoded file to a site's container.
Use this for binary files (images, archives, fonts, etc.)…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path* | string | — |
| content_b64* | string | — |
Raw schema JSON
{
"name": "upload_file",
"description": "Upload a base64-encoded file to a site39;s container.\n\nUse this for binary files (images, archives, fonts, etc.).\nFor text files, prefer write_file().\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n path: Relative path including filename (e.g. \"images/logo.png\")\n content_b64: Base64-encoded file content\n\nReturns:\n {\"success\": true, \"path\": \"images/logo.png\", \"size\": 45678}\n\nErrors:\n VALIDATION_ERROR: Invalid base64 encoding\n FORBIDDEN: Protected system path\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
},
"content_b64": {
"title": "Content B64",
"type": "string"
}
},
"required": [
"slug",
"path",
"content_b64"
],
"title": "upload_fileArguments",
"type": "object"
}
}delete_file
2 params · 2 required
Delete a file or directory from a site's container.
Directories are deleted recursively. Protected system pat…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path* | string | — |
Raw schema JSON
{
"name": "delete_file",
"description": "Delete a file or directory from a site39;s container.\n\nDirectories are deleted recursively. Protected system paths\n(e.g. /etc, /usr) cannot be deleted.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n path: Relative path to delete\n\nReturns:\n {\"success\": true, \"path\": \"...\", \"message\": \"Deleted\"}\n\nErrors:\n NOT_FOUND: Path doesn39;t exist\n FORBIDDEN: Protected system path\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"slug",
"path"
],
"title": "delete_fileArguments",
"type": "object"
}
}create_directory
2 params · 2 required
Create a directory in a site's container.
Creates parent directories if they don't exist.
Requires: API key …
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path* | string | — |
Raw schema JSON
{
"name": "create_directory",
"description": "Create a directory in a site39;s container.\n\nCreates parent directories if they don39;t exist.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n path: Relative path of the directory to create\n\nReturns:\n {\"success\": true, \"path\": \"uploads/2024\", \"message\": \"Directory created\"}\n\nErrors:\n NOT_FOUND: Unknown slug\n FORBIDDEN: Protected system path\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"title": "Path",
"type": "string"
}
},
"required": [
"slug",
"path"
],
"title": "create_directoryArguments",
"type": "object"
}
}list_plugins
1 param · 1 required
List installed WordPress plugins with status.
Requires: API key with read scope. WordPress sites only.
Args:…
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}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_plugins",
"description": "List installed WordPress plugins with status.\n\nRequires: API key with read scope. WordPress sites only.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"plugins\": [{\"name\": \"akismet\", \"status\": \"active\", \"version\": \"5.3\",\n \"update_available\": false}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_pluginsArguments",
"type": "object"
}
}list_themes
1 param · 1 required
List installed WordPress themes with status.
Requires: API key with read scope. WordPress sites only.
Args:
…
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}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_themes",
"description": "List installed WordPress themes with status.\n\nRequires: API key with read scope. WordPress sites only.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"themes\": [{\"name\": \"twentytwentyfour\", \"status\": \"active\",\n \"version\": \"1.0\", \"update_available\": false}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_themesArguments",
"type": "object"
}
}manage_plugin
3 params · 3 required
Install, activate, deactivate, or delete a WordPress plugin.
Requires: API key with write scope.
Args:
s…
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| action* | string | — |
| plugin* | string | — |
Raw schema JSON
{
"name": "manage_plugin",
"description": "Install, activate, deactivate, or delete a WordPress plugin.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n action: \"install\", \"activate\", \"deactivate\", or \"delete\"\n plugin: Plugin slug (e.g. \"akismet\", \"jetpack\", \"woocommerce\")\n\nReturns:\n {\"action\": \"install\", \"plugin\": \"jetpack\", \"result\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"plugin": {
"title": "Plugin",
"type": "string"
}
},
"required": [
"slug",
"action",
"plugin"
],
"title": "manage_pluginArguments",
"type": "object"
}
}manage_theme
3 params · 3 required
Install, activate, or delete a WordPress theme.
Requires: API key with write scope.
Args:
slug: Site ide…
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| action* | string | — |
| theme* | string | — |
Raw schema JSON
{
"name": "manage_theme",
"description": "Install, activate, or delete a WordPress theme.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n action: \"install\", \"activate\", or \"delete\"\n theme: Theme slug (e.g. \"twentytwentyfour\", \"astra\")\n\nReturns:\n {\"action\": \"install\", \"theme\": \"astra\", \"result\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"theme": {
"title": "Theme",
"type": "string"
}
},
"required": [
"slug",
"action",
"theme"
],
"title": "manage_themeArguments",
"type": "object"
}
}wp_check_updates
1 param · 1 required
Check for available WordPress core, plugin, and theme updates.
Requires: API key with read scope.
Args:
…
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": [...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "wp_check_updates",
"description": "Check for available WordPress core, plugin, and theme updates.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"core\": {\"current\": \"6.5\", \"update\": \"6.6\"},\n \"plugins\": [{\"name\": \"...\", \"current\": \"1.0\", \"new\": \"1.1\"}],\n \"themes\": [...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "wp_check_updatesArguments",
"type": "object"
}
}wp_update_all
1 param · 1 required
Update WordPress core, all plugins, and all themes.
Runs all updates in sequence. May take up to 2 minutes.
…
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": [...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "wp_update_all",
"description": "Update WordPress core, all plugins, and all themes.\n\nRuns all updates in sequence. May take up to 2 minutes.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"core\": {...}, \"plugins\": [...], \"themes\": [...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "wp_update_allArguments",
"type": "object"
}
}list_cron
1 param · 1 required
List cron jobs on a site.
Requires: API key with read scope.
Args:
slug: Site identifier
Returns:
{…
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"}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_cron",
"description": "List cron jobs on a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"jobs\": [{\"line\": 1, \"schedule\": \"*/5 * * * *\",\n \"command\": \"/usr/bin/php /var/www/html/wp-cron.php\"}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_cronArguments",
"type": "object"
}
}add_cron
3 params · 3 required
Add a cron job to a site.
Requires: API key with write scope.
Args:
slug: Site identifier
schedule: …
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| schedule* | string | — |
| command* | string | — |
Raw schema JSON
{
"name": "add_cron",
"description": "Add a cron job to a site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n schedule: Cron schedule (e.g. \"*/5 * * * *\", \"0 2 * * *\")\n command: Command to execute\n\nReturns:\n {\"added\": true, \"result\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"schedule": {
"title": "Schedule",
"type": "string"
},
"command": {
"title": "Command",
"type": "string"
}
},
"required": [
"slug",
"schedule",
"command"
],
"title": "add_cronArguments",
"type": "object"
}
}delete_cron
2 params · 2 required
Delete a cron job by line number.
Get line numbers from list_cron().
Requires: API key with write scope.
Ar…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| line_number* | integer | — |
Raw schema JSON
{
"name": "delete_cron",
"description": "Delete a cron job by line number.\n\nGet line numbers from list_cron().\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n line_number: Line number of the cron entry to delete\n\nReturns:\n {\"deleted\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"line_number": {
"title": "Line Number",
"type": "integer"
}
},
"required": [
"slug",
"line_number"
],
"title": "delete_cronArguments",
"type": "object"
}
}ssl_info
1 param · 1 required
Get SSL certificate information for a site.
Returns certificate details, expiry date, and issuer.
Requires: …
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "ssl_info",
"description": "Get SSL certificate information for a site.\n\nReturns certificate details, expiry date, and issuer.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"issuer\": \"Let39;s Encrypt\", \"domain\": \"example.com\",\n \"expires_at\": \"iso8601\", \"days_remaining\": 60,\n \"force_https\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "ssl_infoArguments",
"type": "object"
}
}ssl_renew
1 param · 1 required
Force SSL certificate renewal via certbot.
Requires: API key with write scope.
Args:
slug: Site identifi…
Force SSL certificate renewal via certbot. Requires: API key with write scope. Args: slug: Site identifier Returns: {"renewed": true, "expires_at": "iso8601"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "ssl_renew",
"description": "Force SSL certificate renewal via certbot.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"renewed\": true, \"expires_at\": \"iso8601\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "ssl_renewArguments",
"type": "object"
}
}list_php_versions
1 param · 1 required
List available PHP versions and the currently active one.
Requires: API key with read scope.
Args:
slug:…
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}]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_php_versions",
"description": "List available PHP versions and the currently active one.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"versions\": [{\"version\": \"8.1\", \"active\": false},\n {\"version\": \"8.2\", \"active\": false},\n {\"version\": \"8.3\", \"active\": true}]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_php_versionsArguments",
"type": "object"
}
}switch_php
2 params · 2 required
Switch the active PHP version for a site.
Requires: API key with write scope.
Args:
slug: Site identifie…
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| version* | string | — |
Raw schema JSON
{
"name": "switch_php",
"description": "Switch the active PHP version for a site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n version: Target PHP version (e.g. \"8.3\", \"8.2\", \"8.1\")\n\nReturns:\n {\"version\": \"8.3\", \"result\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"version": {
"title": "Version",
"type": "string"
}
},
"required": [
"slug",
"version"
],
"title": "switch_phpArguments",
"type": "object"
}
}cache_status
1 param · 1 required
Get cache status (Redis, WP object cache, hit rates).
Requires: API key with read scope.
Args:
slug: Sit…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "cache_status",
"description": "Get cache status (Redis, WP object cache, hit rates).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"redis_running\": true, \"object_cache_enabled\": true,\n \"hit_rate\": 0.95, \"memory_used_mb\": 12}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "cache_statusArguments",
"type": "object"
}
}cache_flush
1 param · 1 required
Flush all caches (Redis + WP object cache).
Requires: API key with write scope.
Args:
slug: Site identif…
Flush all caches (Redis + WP object cache). Requires: API key with write scope. Args: slug: Site identifier Returns: {"flushed": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "cache_flush",
"description": "Flush all caches (Redis + WP object cache).\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"flushed\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "cache_flushArguments",
"type": "object"
}
}cache_toggle
2 params · 2 required
Enable or disable the WordPress object cache.
Requires: API key with write scope.
Args:
slug: Site ident…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| enable* | boolean | — |
Raw schema JSON
{
"name": "cache_toggle",
"description": "Enable or disable the WordPress object cache.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n enable: true to enable, false to disable\n\nReturns:\n {\"enabled\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"enable": {
"title": "Enable",
"type": "boolean"
}
},
"required": [
"slug",
"enable"
],
"title": "cache_toggleArguments",
"type": "object"
}
}get_database_info
1 param · 1 required
Get WordPress database information (size, tables, row counts).
Requires: API key with read scope. WordPress s…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_database_info",
"description": "Get WordPress database information (size, tables, row counts).\n\nRequires: API key with read scope. WordPress sites only.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"database\": \"wp_mysite\", \"size_mb\": 45.2,\n \"tables\": 12, \"total_rows\": 15432}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_database_infoArguments",
"type": "object"
}
}optimize_database
1 param · 1 required
Optimize WordPress database tables (reduces bloat).
Requires: API key with write scope.
Args:
slug: Site…
Optimize WordPress database tables (reduces bloat). Requires: API key with write scope. Args: slug: Site identifier Returns: {"optimized": true, "tables_optimized": 12}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "optimize_database",
"description": "Optimize WordPress database tables (reduces bloat).\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"optimized\": true, \"tables_optimized\": 12}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "optimize_databaseArguments",
"type": "object"
}
}database_search_replace
4 params · 3 required
Search and replace in WordPress database (e.g. URL migration).
Handles serialized data safely. Use dry_run=tr…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| old* | string | — |
| new* | string | — |
| dry_run | boolean | — default: true |
Raw schema JSON
{
"name": "database_search_replace",
"description": "Search and replace in WordPress database (e.g. URL migration).\n\nHandles serialized data safely. Use dry_run=true first to preview changes.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n old: String to search for (e.g. \"http://old-domain.com\")\n new: Replacement string (e.g. \"https://new-domain.com\")\n dry_run: Preview only without making changes (default: true)\n\nReturns:\n {\"replacements\": 42, \"tables_affected\": 5, \"dry_run\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"old": {
"title": "Old",
"type": "string"
},
"new": {
"title": "New",
"type": "string"
},
"dry_run": {
"default": true,
"title": "Dry Run",
"type": "boolean"
}
},
"required": [
"slug",
"old",
"new"
],
"title": "database_search_replaceArguments",
"type": "object"
}
}list_databases
1 param · 1 required
List all databases on a site's container.
Requires: API key with read scope.
Args:
slug: Site identifier…
List all databases on a site's container. Requires: API key with read scope. Args: slug: Site identifier Returns: {"databases": ["wordpress", "app_db", ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_databases",
"description": "List all databases on a site39;s container.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"databases\": [\"wordpress\", \"app_db\", ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_databasesArguments",
"type": "object"
}
}list_tables
2 params · 2 required
List tables in a database.
Requires: API key with read scope.
Args:
slug: Site identifier
database: …
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}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| database* | string | — |
Raw schema JSON
{
"name": "list_tables",
"description": "List tables in a database.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n database: Database name\n\nReturns:\n {\"tables\": [{\"name\": \"wp_posts\", \"rows\": 1234, \"size_mb\": 5.2}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"database": {
"title": "Database",
"type": "string"
}
},
"required": [
"slug",
"database"
],
"title": "list_tablesArguments",
"type": "object"
}
}execute_query
3 params · 3 required
Execute a SQL query on a site's database.
Supports SELECT, INSERT, UPDATE, DELETE, and DDL statements.
Result…
Execute a SQL query on a site's database. Supports SELECT, INSERT, UPDATE, DELETE, and DDL statements. Results are limited to 1000 rows for SELECT queries. Requires: API key with write scope. Args: slug: Site identifier database: Database name query: SQL query string Returns: {"columns": ["id", "title"], "rows": [[1, "Hello"], ...], "affected_rows": 0, "query_time_ms": 12}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| database* | string | — |
| query* | string | — |
Raw schema JSON
{
"name": "execute_query",
"description": "Execute a SQL query on a site39;s database.\n\nSupports SELECT, INSERT, UPDATE, DELETE, and DDL statements.\nResults are limited to 1000 rows for SELECT queries.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n database: Database name\n query: SQL query string\n\nReturns:\n {\"columns\": [\"id\", \"title\"], \"rows\": [[1, \"Hello\"], ...],\n \"affected_rows\": 0, \"query_time_ms\": 12}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"database": {
"title": "Database",
"type": "string"
},
"query": {
"title": "Query",
"type": "string"
}
},
"required": [
"slug",
"database",
"query"
],
"title": "execute_queryArguments",
"type": "object"
}
}get_stack_info
1 param · 1 required
Get detailed system stack information (OS, PHP, DB, web server versions).
Requires: API key with read scope.
…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_stack_info",
"description": "Get detailed system stack information (OS, PHP, DB, web server versions).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"os\": \"Debian 12\", \"kernel\": \"6.1.0\",\n \"php\": \"8.3.4\", \"mysql\": \"10.11.6-MariaDB\",\n \"nginx\": \"1.24.0\", \"wordpress\": \"6.5\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_stack_infoArguments",
"type": "object"
}
}get_resource_snapshot
1 param · 1 required
Get current resource usage (CPU, memory, disk, load average).
Requires: API key with read scope.
Args:
s…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_resource_snapshot",
"description": "Get current resource usage (CPU, memory, disk, load average).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"cpu_percent\": 12.5, \"memory_mb\": 384, \"memory_total_mb\": 512,\n \"disk_used_gb\": 3.2, \"disk_total_gb\": 10,\n \"load_1m\": 0.5, \"load_5m\": 0.3, \"load_15m\": 0.2}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_resource_snapshotArguments",
"type": "object"
}
}cloudflare_proxy_status
1 param · 1 required
Get Cloudflare proxy (CDN) status for a site.
Shows whether traffic is routed through Cloudflare's CDN (orang…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "cloudflare_proxy_status",
"description": "Get Cloudflare proxy (CDN) status for a site.\n\nShows whether traffic is routed through Cloudflare39;s CDN (orange cloud)\nor goes direct to origin (grey cloud / DNS-only).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"domain\": \"my-site.borealhost.ai\", \"has_record\": true,\n \"proxied\": true, \"ip\": \"1.2.3.4\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "cloudflare_proxy_statusArguments",
"type": "object"
}
}cloudflare_set_proxy
2 params · 2 required
Enable or disable Cloudflare CDN proxy for a site.
When enabled (orange cloud): traffic goes through Cloudfla…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| proxied* | boolean | — |
Raw schema JSON
{
"name": "cloudflare_set_proxy",
"description": "Enable or disable Cloudflare CDN proxy for a site.\n\nWhen enabled (orange cloud): traffic goes through Cloudflare39;s CDN,\ngets caching, DDoS protection, and SSL termination at the edge.\nWhen disabled (grey cloud): traffic goes directly to origin server.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n proxied: true to enable CDN proxy, false to disable\n\nReturns:\n {\"domain\": \"my-site.borealhost.ai\", \"proxied\": true, \"ip\": \"1.2.3.4\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"proxied": {
"title": "Proxied",
"type": "boolean"
}
},
"required": [
"slug",
"proxied"
],
"title": "cloudflare_set_proxyArguments",
"type": "object"
}
}cloudflare_purge_cache
2 params · 1 required
Purge Cloudflare CDN cache for a site.
Without urls: purges all cached content for the site's subdomain.
With…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| urls | array<object> | — default: null |
Raw schema JSON
{
"name": "cloudflare_purge_cache",
"description": "Purge Cloudflare CDN cache for a site.\n\nWithout urls: purges all cached content for the site39;s subdomain.\nWith urls: purges only the specified URLs (max 30 per call).\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n urls: Optional list of specific URLs to purge\n (e.g. [\"https://my-site.borealhost.ai/style.css\"])\n\nReturns:\n {\"purged\": true, \"scope\": \"host\", \"domain\": \"my-site.borealhost.ai\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"urls": {
"default": null,
"items": {},
"title": "Urls",
"type": "array"
}
},
"required": [
"slug"
],
"title": "cloudflare_purge_cacheArguments",
"type": "object"
}
}list_ftp_accounts
1 param · 1 required
List SFTP accounts on a site.
Also returns the host and port to connect to. Do not use the site's domain
for …
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"}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_ftp_accounts",
"description": "List SFTP accounts on a site.\n\nAlso returns the host and port to connect to. Do not use the site39;s domain\nfor SFTP: it is Cloudflare-proxied and only carries HTTP(S).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"accounts\": [{\"username\": \"sftpuser\", \"home\": \"/wordpress\", \"uid\": 1001}],\n \"configured\": true,\n \"connection\": {\"host\": \"1.2.3.4\", \"port\": 9312, \"protocol\": \"SFTP\"}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_ftp_accountsArguments",
"type": "object"
}
}create_ftp_account
4 params · 3 required
Create an SFTP account on a site.
The account is chrooted to /var/www and lands in home_dir. Password must be…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| username* | string | — |
| password* | string | — |
| home_dir | string | — default: "" |
Raw schema JSON
{
"name": "create_ftp_account",
"description": "Create an SFTP account on a site.\n\nThe account is chrooted to /var/www and lands in home_dir. Password must be\nat least 8 characters. Username must be lowercase alphanumeric.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n username: SFTP username (lowercase, max 32 chars)\n password: Password (min 8 chars)\n home_dir: Landing directory inside /var/www. Leave empty to land at\n /var/www itself, which lists every site directory.\n\nReturns:\n {\"success\": true, \"username\": \"sftpuser\", \"home_dir\": \"/wordpress\",\n \"protocol\": \"sftp\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
},
"password": {
"title": "Password",
"type": "string"
},
"home_dir": {
"default": "",
"title": "Home Dir",
"type": "string"
}
},
"required": [
"slug",
"username",
"password"
],
"title": "create_ftp_accountArguments",
"type": "object"
}
}remove_ftp_account
2 params · 2 required
Remove an SFTP account from a site.
Requires: API key with write scope.
Args:
slug: Site identifier
…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| username* | string | — |
Raw schema JSON
{
"name": "remove_ftp_account",
"description": "Remove an SFTP account from a site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n username: SFTP username to remove\n\nReturns:\n {\"removed\": true, \"username\": \"sftpuser\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"username": {
"title": "Username",
"type": "string"
}
},
"required": [
"slug",
"username"
],
"title": "remove_ftp_accountArguments",
"type": "object"
}
}list_alert_rules
1 param · 1 required
List user-configurable alert rules for a site.
Requires: API key with read scope.
Args:
slug: Site ident…
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}]
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_alert_rules",
"description": "List user-configurable alert rules for a site.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n [{\"id\": \"uuid\", \"metric\": \"disk\", \"operator\": \"gt\",\n \"threshold\": 90, \"severity\": \"warning\", \"enabled\": true,\n \"cooldown_minutes\": 30, \"notify_email\": true}]\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_alert_rulesArguments",
"type": "object"
}
}create_alert_rule
8 params · 3 required
Create an alert rule to monitor CPU, memory, or disk usage.
When the metric crosses the threshold, a notifica…
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, ...}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| metric* | string | — |
| threshold* | number | — |
| operator | string | — default: "gt" |
| severity | string | — default: "warning" |
| cooldown_minutes | integer | — default: 30 |
| notify_email | boolean | — default: true |
| notify_webhook | string | — default: "" |
Raw schema JSON
{
"name": "create_alert_rule",
"description": "Create an alert rule to monitor CPU, memory, or disk usage.\n\nWhen the metric crosses the threshold, a notification is sent via\nemail and/or webhook. Max 10 rules per site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n metric: \"cpu\", \"memory\", or \"disk\" (percentage-based)\n threshold: Threshold value 0-100 (e.g. 90 for 90%)\n operator: \"gt\" (greater than) or \"lt\" (less than). Default: \"gt\"\n severity: \"warning\" or \"critical\". Default: \"warning\"\n cooldown_minutes: Min minutes between repeated alerts. Default: 30\n notify_email: Send email notification. Default: true\n notify_webhook: Optional webhook URL for POST notifications\n\nReturns:\n {\"id\": \"uuid\", \"metric\": \"disk\", \"threshold\": 90, ...}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"metric": {
"title": "Metric",
"type": "string"
},
"threshold": {
"title": "Threshold",
"type": "number"
},
"operator": {
"default": "gt",
"title": "Operator",
"type": "string"
},
"severity": {
"default": "warning",
"title": "Severity",
"type": "string"
},
"cooldown_minutes": {
"default": 30,
"title": "Cooldown Minutes",
"type": "integer"
},
"notify_email": {
"default": true,
"title": "Notify Email",
"type": "boolean"
},
"notify_webhook": {
"default": "",
"title": "Notify Webhook",
"type": "string"
}
},
"required": [
"slug",
"metric",
"threshold"
],
"title": "create_alert_ruleArguments",
"type": "object"
}
}delete_alert_rule
2 params · 2 required
Delete an alert rule.
Requires: API key with write scope.
Args:
slug: Site identifier
rule_id: UUID …
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| rule_id* | string | — |
Raw schema JSON
{
"name": "delete_alert_rule",
"description": "Delete an alert rule.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n rule_id: UUID of the alert rule to delete\n\nReturns:\n {\"deleted\": true, \"id\": \"uuid\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"rule_id": {
"title": "Rule Id",
"type": "string"
}
},
"required": [
"slug",
"rule_id"
],
"title": "delete_alert_ruleArguments",
"type": "object"
}
}run_malware_scan
2 params · 1 required
Run a ClamAV malware scan on a site's container.
Scans the web root (or specified path) for malware, viruses,…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| path | string | — default: "" |
Raw schema JSON
{
"name": "run_malware_scan",
"description": "Run a ClamAV malware scan on a site39;s container.\n\nScans the web root (or specified path) for malware, viruses, and trojans.\nClamAV is installed automatically if not present. Excludes node_modules,\nvendor, .git, and cache directories.\n\nMay take up to 5 minutes for large sites.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n path: Directory to scan (default: /var/www/html)\n\nReturns:\n {\"infected_files\": [{\"path\": \"/var/www/html/shell.php\", \"threat\": \"Php.Malware.Agent\"}],\n \"scanned_count\": 1234, \"infected_count\": 1, \"scan_time_s\": 45.2}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"path": {
"default": "",
"title": "Path",
"type": "string"
}
},
"required": [
"slug"
],
"title": "run_malware_scanArguments",
"type": "object"
}
}list_firewall_rules
1 param · 1 required
List IP allow/deny firewall rules for a site.
Rules are implemented as Nginx allow/deny directives per contai…
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"}]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_firewall_rules",
"description": "List IP allow/deny firewall rules for a site.\n\nRules are implemented as Nginx allow/deny directives per container.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"rules\": [{\"ip\": \"1.2.3.4\", \"action\": \"deny\"},\n {\"ip\": \"10.0.0.0/8\", \"action\": \"allow\"}]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_firewall_rulesArguments",
"type": "object"
}
}add_firewall_rule
3 params · 2 required
Add an IP firewall rule (allow or deny) and reload Nginx.
Supports IPv4, IPv6, and CIDR notation. Max 100 rul…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| ip* | string | — |
| action | string | — default: "deny" |
Raw schema JSON
{
"name": "add_firewall_rule",
"description": "Add an IP firewall rule (allow or deny) and reload Nginx.\n\nSupports IPv4, IPv6, and CIDR notation. Max 100 rules per site.\nIf a rule already exists for the IP, the action is updated.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n ip: IP address or CIDR (e.g. \"1.2.3.4\", \"10.0.0.0/8\", \"2001:db8::/32\")\n action: \"deny\" (block) or \"allow\" (whitelist). Default: \"deny\"\n\nReturns:\n {\"added\": true, \"ip\": \"1.2.3.4\", \"action\": \"deny\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"ip": {
"title": "Ip",
"type": "string"
},
"action": {
"default": "deny",
"title": "Action",
"type": "string"
}
},
"required": [
"slug",
"ip"
],
"title": "add_firewall_ruleArguments",
"type": "object"
}
}remove_firewall_rule
2 params · 2 required
Remove an IP firewall rule and reload Nginx.
Requires: API key with write scope.
Args:
slug: Site identi…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| ip* | string | — |
Raw schema JSON
{
"name": "remove_firewall_rule",
"description": "Remove an IP firewall rule and reload Nginx.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n ip: IP address or CIDR to remove (must match exactly)\n\nReturns:\n {\"removed\": true, \"ip\": \"1.2.3.4\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"ip": {
"title": "Ip",
"type": "string"
}
},
"required": [
"slug",
"ip"
],
"title": "remove_firewall_ruleArguments",
"type": "object"
}
}get_logs
4 params · 1 required
Retrieve container logs (error, access, or PHP).
Requires: API key with read scope.
Args:
slug: Site ide…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| log_type | string | — default: "error" |
| lines | integer | — default: 100 |
| search | string | — default: "" |
Raw schema JSON
{
"name": "get_logs",
"description": "Retrieve container logs (error, access, or PHP).\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n log_type: \"error\" (Nginx/Apache errors), \"access\" (HTTP request log),\n or \"php\" (PHP-FPM errors, WordPress sites only)\n lines: Number of lines to retrieve (1–500, default: 100)\n search: Optional keyword filter — only lines containing this string\n\nReturns:\n {\"log_type\": \"error\", \"lines\": [\"2024-01-15 ... error ...\", ...],\n \"count\": 42, \"truncated\": false}\n\nErrors:\n NOT_FOUND: Unknown slug\n VALIDATION_ERROR: Invalid log_type or lines out of range\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"log_type": {
"default": "error",
"title": "Log Type",
"type": "string"
},
"lines": {
"default": 100,
"title": "Lines",
"type": "integer"
},
"search": {
"default": "",
"title": "Search",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_logsArguments",
"type": "object"
}
}list_domains
0 params
List all domains owned by the authenticated user.
Requires: API key with read scope.
Returns:
[{"domain"…
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"}]
Input schema
No parameters.
Raw schema JSON
{
"name": "list_domains",
"description": "List all domains owned by the authenticated user.\n\nRequires: API key with read scope.\n\nReturns:\n [{\"domain\": \"example.com\", \"status\": \"active\",\n \"expires_at\": \"iso8601\", \"auto_renew\": true,\n \"linked_site\": \"my-site\"}]\n",
"inputSchema": {
"properties": {},
"title": "list_domainsArguments",
"type": "object"
}
}search_domain
1 param · 1 required
Check domain availability and get pricing.
Requires: API key with read scope.
Args:
domain: Full 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, "price": {"amount": 15.99, "currency": "CAD", "period": "1 year"}, "premium": false} Note: .ca domains require ca_legal_type when registering.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain* | string | — |
Raw schema JSON
{
"name": "search_domain",
"description": "Check domain availability and get pricing.\n\nRequires: API key with read scope.\n\nArgs:\n domain: Full domain name (e.g. \"example.com\", \"mybiz.ca\")\n\nReturns:\n {\"domain\": \"example.com\", \"available\": true,\n \"price\": {\"amount\": 15.99, \"currency\": \"CAD\", \"period\": \"1 year\"},\n \"premium\": false}\n\nNote: .ca domains require ca_legal_type when registering.\n",
"inputSchema": {
"properties": {
"domain": {
"title": "Domain",
"type": "string"
}
},
"required": [
"domain"
],
"title": "search_domainArguments",
"type": "object"
}
}register_domain
17 params · 9 required
Register a new domain with WHOIS contact info and Stripe billing.
The domain cost is charged to the user's ac…
Register a new domain with WHOIS contact info and Stripe billing. The domain cost is charged to the user's active subscription. Free domain if plan includes free_domain_annual + annual billing + first domain. Requires: API key with write scope. Args: 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: "CCO" (Canadian citizen), "RES" (permanent resident), "CCT" (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: {"domain": "example.ca", "status": "registered", "expires_at": "iso8601", "message": "Domain registered successfully"} 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)
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain* | string | — |
| first_name* | string | — |
| last_name* | string | — |
| email* | string | — |
| phone* | string | — |
| address1* | string | — |
| city* | string | — |
| state* | string | — |
| postal_code* | string | — |
| country | string | — default: "CA" |
| period | integer | — default: 1 |
| ca_legal_type | string | — default: "" |
| usage_mode | string | — default: "site" |
| nameservers | array<object> | — default: null |
| forward_url | string | — default: "" |
| forward_type | string | — default: "301" |
| forward_include_path | boolean | — default: true |
Raw schema JSON
{
"name": "register_domain",
"description": "Register a new domain with WHOIS contact info and Stripe billing.\n\nThe domain cost is charged to the user39;s active subscription.\nFree domain if plan includes free_domain_annual + annual billing + first domain.\n\nRequires: API key with write scope.\n\nArgs:\n domain: Full domain name (e.g. \"example.ca\", \"mybusiness.com\")\n first_name: Registrant first name\n last_name: Registrant last name\n email: Registrant email address\n phone: Phone number in E.164 format: \"+1.5145551234\"\n address1: Street address (e.g. \"123 Rue Principale\")\n city: City (e.g. \"Montreal\")\n state: Province/state code (e.g. \"QC\", \"ON\", \"BC\")\n postal_code: Postal/ZIP code (e.g. \"H2X 1Y4\")\n country: ISO 3166-1 alpha-2 country code (default: \"CA\")\n period: Registration period in years (1–10, default: 1)\n usage_mode: What the domain points at.\n \"site\" (default) links it to the billing subscription39;s\n site with automatic DNS + Nginx + SSL.\n \"external_ns\" delegates it to `nameservers` — the domain is\n registered here but hosted elsewhere; we manage no DNS.\n \"dns_only\" keeps it on our DNS with no site behind it.\n \"forward\" redirects visitors to `forward_url`.\n nameservers: Ordered list of 2–6 nameserver hostnames. Required when\n usage_mode=\"external_ns\" (e.g. [\"ns1.other.com\", \"ns2.other.com\"])\n forward_url: Redirect target, required when usage_mode=\"forward\"\n (e.g. \"https://example.org\")\n forward_type: \"301\" permanent (default) or \"302\" temporary\n forward_include_path: Append the visitor39;s path to the target (default: True)\n ca_legal_type: Required for .ca domains. CIRA legal types:\n \"CCO\" (Canadian citizen), \"RES\" (permanent resident),\n \"CCT\" (corporation), \"GOV\" (government), \"EDU\" (education),\n \"ASS\" (association), \"HOP\" (hospital), \"PRT\" (partnership),\n \"TDM\" (trademark), \"TRD\" (trade union), \"PLT\" (political party),\n \"LAM\" (library/archive/museum), \"MAJ\" (Her Majesty),\n \"INB\" (Indian band), \"ABO\" (Aboriginal peoples),\n \"LGR\" (legal representative)\n\nReturns:\n {\"domain\": \"example.ca\", \"status\": \"registered\",\n \"expires_at\": \"iso8601\", \"message\": \"Domain registered successfully\"}\n\nErrors:\n VALIDATION_ERROR: Missing required fields, invalid phone format,\n missing ca_legal_type for .ca domains\n NOT_FOUND: Domain not available (already registered by someone else)\n",
"inputSchema": {
"properties": {
"domain": {
"title": "Domain",
"type": "string"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
},
"phone": {
"title": "Phone",
"type": "string"
},
"address1": {
"title": "Address1",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"type": "string"
},
"country": {
"default": "CA",
"title": "Country",
"type": "string"
},
"period": {
"default": 1,
"title": "Period",
"type": "integer"
},
"ca_legal_type": {
"default": "",
"title": "Ca Legal Type",
"type": "string"
},
"usage_mode": {
"default": "site",
"title": "Usage Mode",
"type": "string"
},
"nameservers": {
"default": null,
"items": {},
"title": "Nameservers",
"type": "array"
},
"forward_url": {
"default": "",
"title": "Forward Url",
"type": "string"
},
"forward_type": {
"default": "301",
"title": "Forward Type",
"type": "string"
},
"forward_include_path": {
"default": true,
"title": "Forward Include Path",
"type": "boolean"
}
},
"required": [
"domain",
"first_name",
"last_name",
"email",
"phone",
"address1",
"city",
"state",
"postal_code"
],
"title": "register_domainArguments",
"type": "object"
}
}domain_detail
1 param · 1 required
Get full domain details including DNS and infrastructure status.
Requires: API key with read scope.
Args:
…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "domain_detail",
"description": "Get full domain details including DNS and infrastructure status.\n\nRequires: API key with read scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n\nReturns:\n {\"domain\": \"example.com\", \"status\": \"active\",\n \"expires_at\": \"iso8601\", \"auto_renew\": true,\n \"nameservers\": [\"ns1.borealhost.ai\", \"ns2.borealhost.ai\"],\n \"dns_records\": [...], \"linked_site\": \"my-site\"}\n\nErrors:\n NOT_FOUND: Domain not owned by this account\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "domain_detailArguments",
"type": "object"
}
}list_subdomains
1 param · 1 required
List subdomain DNS records for a domain you own.
Requires: API key with read scope.
Args:
domain_name: R…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "list_subdomains",
"description": "List subdomain DNS records for a domain you own.\n\nRequires: API key with read scope.\n\nArgs:\n domain_name: Registrable domain (e.g. \"example.com\")\n\nReturns:\n [{\"fqdn\": \"blog.example.com\", \"subdomain\": \"blog\",\n \"record_type\": \"A\", \"value\": \"1.2.3.4\", \"is_auto\": true}, ...]\n\nErrors:\n NOT_FOUND: Domain not found\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "list_subdomainsArguments",
"type": "object"
}
}add_subdomain
2 params · 2 required
Create and route a subdomain of a site-linked domain.
Creates the DNS A record (if absent) pointing at the si…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| subdomain* | string | — |
Raw schema JSON
{
"name": "add_subdomain",
"description": "Create and route a subdomain of a site-linked domain.\n\nCreates the DNS A record (if absent) pointing at the site39;s server,\nthen configures the nginx vhost and SSL certificate on that server.\nThe domain must already be linked to a site (see link_domain).\n\nIdempotent: if the DNS record already exists and points at the site39;s\nserver, the nginx/SSL steps are (re)applied — safe to re-call, e.g. to\nretry SSL after DNS propagation. May take up to 3 minutes when a\ncertificate is issued.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Registrable domain linked to a site (e.g. \"example.com\")\n subdomain: Subdomain label only, no dots (e.g. \"blog\")\n\nReturns:\n {\"fqdn\": \"blog.example.com\", \"domain\": \"example.com\",\n \"site\": \"my-site\", \"message\": \"...\"}\n\nErrors:\n NOT_FOUND: Domain not found\n VALIDATION_ERROR: Domain not linked to a site, invalid label, or\n an existing record points at a different server\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"subdomain": {
"title": "Subdomain",
"type": "string"
}
},
"required": [
"domain_name",
"subdomain"
],
"title": "add_subdomainArguments",
"type": "object"
}
}delete_subdomain
2 params · 2 required
Remove a subdomain: its DNS record, nginx vhost and certificate.
The inverse of add_subdomain. Removes the DN…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| subdomain* | string | — |
Raw schema JSON
{
"name": "delete_subdomain",
"description": "Remove a subdomain: its DNS record, nginx vhost and certificate.\n\nThe inverse of add_subdomain. Removes the DNS record AND the server-side\nvhost and cert, so the name stops resolving and stops being served. Nothing\nelse on the domain is touched.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Registrable domain linked to a site (e.g. \"example.com\")\n subdomain: Subdomain label only, no dots (e.g. \"blog\")\n\nReturns:\n {\"fqdn\": \"blog.example.com\", \"domain\": \"example.com\",\n \"removed\": [\"dns\", \"vhost\", \"cert\"], \"message\": \"...\"}\n\nErrors:\n NOT_FOUND: Domain or subdomain not found\n VALIDATION_ERROR: Domain not linked to a site, or invalid label\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"subdomain": {
"title": "Subdomain",
"type": "string"
}
},
"required": [
"domain_name",
"subdomain"
],
"title": "delete_subdomainArguments",
"type": "object"
}
}link_domain
2 params · 2 required
Link a domain to a hosted site.
Attaches the domain to the specified site and triggers automatic
DNS configur…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| site_slug* | string | — |
Raw schema JSON
{
"name": "link_domain",
"description": "Link a domain to a hosted site.\n\nAttaches the domain to the specified site and triggers automatic\nDNS configuration and SSL provisioning.\n\nWARNING: Regenerates this site39;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.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n site_slug: Site identifier to link the domain to\n\nReturns:\n {\"success\": true, \"domain\": \"example.com\",\n \"linked_site\": \"my-site\", \"message\": \"Domain linked\"}\n\nErrors:\n NOT_FOUND: Domain or site not found\n VALIDATION_ERROR: Domain already linked to another site\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"site_slug": {
"title": "Site Slug",
"type": "string"
}
},
"required": [
"domain_name",
"site_slug"
],
"title": "link_domainArguments",
"type": "object"
}
}get_site_nginx_snippet
1 param · 1 required
Read the custom nginx config for a domain on the BorealHost host proxy.
Your site sits behind a BorealHost re…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "get_site_nginx_snippet",
"description": "Read the custom nginx config for a domain on the BorealHost host proxy.\n\nYour site sits behind a BorealHost reverse proxy that terminates TLS and\nforwards to your container. This returns the custom nginx block applied to\nthat proxy for this domain (empty if you have not set one).\n\nRequires: API key with read scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n\nReturns:\n {\"domain\": \"example.com\", \"content\": \"location ...\", \"exists\": true}\n\nErrors:\n NOT_FOUND: Domain not found\n VALIDATION_ERROR: Domain is not linked to a site\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "get_site_nginx_snippetArguments",
"type": "object"
}
}set_site_nginx_snippet
2 params · 2 required
Set custom nginx config on the BorealHost host proxy — WebSocket, timeouts, headers.
Use this when configurin…
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)
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| content* | string | — |
Raw schema JSON
{
"name": "set_site_nginx_snippet",
"description": "Set custom nginx config on the BorealHost host proxy — WebSocket, timeouts, headers.\n\nUse this when configuring your container39;s own nginx is not enough because\nsomething in front of it is interfering. The host proxy sits between the\ninternet and your container, and by default its catch-all `location /` does\nnot do anything special per-site.\n\nWEBSOCKETS: if your WebSocket endpoint returns 400 through your domain but\nupgrades correctly (101) when tested inside your container, the Upgrade\nheader is being dropped in front of you. Add a location block that relays it:\n\n location ^~ /your/ws/path/ {\n proxy_pass <your site39;s existing upstream>;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection \"upgrade\";\n proxy_read_timeout 3600;\n proxy_send_timeout 3600;\n error_page 502 503 504 =502;\n }\n\nWhen testing with curl, force HTTP/1.1 (curl --http1.1). A WebSocket handshake uses the Upgrade header, which is invalid in HTTP/2 —\ncurl negotiates h2 with a CDN by default and the edge answers 400, which looks exactly like the bug you are trying to fix.\n\nThis config lives OUTSIDE the generated vhost, so it survives domain\nre-linking, autoconfig, plan changes and reprovisioning. Sending \"\" clears it.\n\nBounds — the file is parsed by a root process on a machine shared with\nBorealHost infrastructure, so only per-site proxy directives are accepted:\nlocation, proxy_pass, proxy_set_header, proxy_http_version, proxy_*_timeout,\nproxy_buffering, client_max_body_size, add_header, error_page, expires, gzip.\n`root`, `alias`, `include`, `access_log`, `error_log`, `server` and `upstream`\nare refused, and proxy_pass must target your own site39;s existing upstream.\nA rejection names the directive and why.\n\nThe config is validated with `nginx -t` before it is applied and rolled back\nautomatically if it does not pass, so a mistake cannot take your site down.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n content: nginx config, or \"\" to clear it\n\nReturns:\n {\"domain\": \"example.com\", \"bytes\": 214, \"replaced\": false}\n\nErrors:\n NOT_FOUND: Domain not found\n VALIDATION_ERROR: Domain not linked to a site, a directive is not\n permitted, proxy_pass targets something other than your own\n upstream, or nginx rejected the config (the message says which)\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"content": {
"title": "Content",
"type": "string"
}
},
"required": [
"domain_name",
"content"
],
"title": "set_site_nginx_snippetArguments",
"type": "object"
}
}set_domain_usage
7 params · 2 required
Set what a registered domain points at — a site, someone else's
nameservers, our DNS with no site, or a redire…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| usage_mode* | string | — |
| site_slug | string | — default: "" |
| nameservers | array<object> | — default: null |
| forward_url | string | — default: "" |
| forward_type | string | — default: "301" |
| forward_include_path | boolean | — default: true |
Raw schema JSON
{
"name": "set_domain_usage",
"description": "Set what a registered domain points at — a site, someone else39;s\nnameservers, our DNS with no site, or a redirect to another URL.\n\nUse this to park a domain, hand it to an external host, or forward it.\nSwitching modes tears down the previous one (a forwarded domain that\nbecomes a site domain loses its redirect, and vice versa).\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n usage_mode: \"site\" — link it to a hosted site (needs site_slug);\n \"external_ns\" — delegate to the customer39;s own nameservers\n (needs nameservers), we stop managing its DNS entirely;\n \"dns_only\" — our nameservers, records edited by hand,\n nothing served;\n \"forward\" — our nameservers plus an HTTP redirect to\n forward_url (needs forward_url)\n site_slug: Site to link to, when usage_mode=\"site\"\n nameservers: Ordered list of 2–6 nameserver hostnames, when\n usage_mode=\"external_ns\"\n forward_url: Redirect target, when usage_mode=\"forward\"\n forward_type: \"301\" permanent (default) or \"302\" temporary\n forward_include_path: Append the visitor39;s path to the target (default: True)\n\nReturns:\n {\"domain\": \"example.com\", \"usage_mode\": \"forward\",\n \"forward_url\": \"https://example.org\",\n \"configuration\": {\"dns\": true, \"nginx\": true, \"ssl\": false, ...}}\n\n For forward mode, ssl=false usually just means DNS has not propagated\n yet — call this tool again a few minutes later to finish the cert.\n\nErrors:\n NOT_FOUND: Domain or site not found\n VALIDATION_ERROR: Bad nameserver hostname, bad redirect URL,\n missing site_slug, or a self-referential redirect\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"usage_mode": {
"title": "Usage Mode",
"type": "string"
},
"site_slug": {
"default": "",
"title": "Site Slug",
"type": "string"
},
"nameservers": {
"default": null,
"items": {},
"title": "Nameservers",
"type": "array"
},
"forward_url": {
"default": "",
"title": "Forward Url",
"type": "string"
},
"forward_type": {
"default": "301",
"title": "Forward Type",
"type": "string"
},
"forward_include_path": {
"default": true,
"title": "Forward Include Path",
"type": "boolean"
}
},
"required": [
"domain_name",
"usage_mode"
],
"title": "set_domain_usageArguments",
"type": "object"
}
}domain_settings
4 params · 1 required
Update domain settings (auto-renew, WHOIS privacy, registrar lock).
Only provided (non-None) fields are updat…
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: Enable/disable automatic renewal whois_privacy: Enable/disable WHOIS privacy protection locked: Enable/disable 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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| auto_renew | boolean | — default: null |
| whois_privacy | boolean | — default: null |
| locked | boolean | — default: null |
Raw schema JSON
{
"name": "domain_settings",
"description": "Update domain settings (auto-renew, WHOIS privacy, registrar lock).\n\nOnly provided (non-None) fields are updated.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n auto_renew: Enable/disable automatic renewal\n whois_privacy: Enable/disable WHOIS privacy protection\n locked: Enable/disable registrar lock (prevents unauthorized transfers)\n\nReturns:\n {\"success\": true, \"domain\": \"example.com\",\n \"auto_renew\": true, \"whois_privacy\": true, \"locked\": true}\n\nErrors:\n NOT_FOUND: Domain not found or not owned by account\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"auto_renew": {
"default": null,
"title": "Auto Renew",
"type": "boolean"
},
"whois_privacy": {
"default": null,
"title": "Whois Privacy",
"type": "boolean"
},
"locked": {
"default": null,
"title": "Locked",
"type": "boolean"
}
},
"required": [
"domain_name"
],
"title": "domain_settingsArguments",
"type": "object"
}
}list_domain_dns
1 param · 1 required
List all DNS records for a domain.
Returns DNS records at the domain level (independent of site-level
manage_…
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", "ttl": 3600}] Errors: NOT_FOUND: Domain not found or not owned by account
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "list_domain_dns",
"description": "List all DNS records for a domain.\n\nReturns DNS records at the domain level (independent of site-level\nmanage_dns). Use this for domains that may not be linked to a site.\n\nRequires: API key with read scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n\nReturns:\n [{\"id\": \"record-id\", \"type\": \"A\", \"subdomain\": \"www\",\n \"value\": \"1.2.3.4\", \"ttl\": 3600}]\n\nErrors:\n NOT_FOUND: Domain not found or not owned by account\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "list_domain_dnsArguments",
"type": "object"
}
}add_domain_dns
6 params · 3 required
Add a DNS record to a domain.
Requires: API key with write scope.
Args:
domain_name: Full domain name (e…
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. ttl: Time to live in seconds (default: 3600) priority: MX priority (required for MX records) Returns: {"success": true, "record": {"id": "...", "type": "A", "subdomain": "www", "value": "1.2.3.4", "ttl": 3600}} Errors: VALIDATION_ERROR: Missing value, invalid record type NOT_FOUND: Domain not found
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| record_type* | string | — |
| value* | string | — |
| subdomain | string | — default: "" |
| ttl | integer | — default: 3600 |
| priority | integer | — default: null |
Raw schema JSON
{
"name": "add_domain_dns",
"description": "Add a DNS record to a domain.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n record_type: \"A\", \"AAAA\", \"CNAME\", \"MX\", \"TXT\", or \"SRV\"\n value: Record value (e.g. \"1.2.3.4\" for A, \"mail.example.com\" for MX)\n subdomain: Subdomain part (e.g. \"www\", \"mail\"). Empty for apex domain.\n ttl: Time to live in seconds (default: 3600)\n priority: MX priority (required for MX records)\n\nReturns:\n {\"success\": true, \"record\": {\"id\": \"...\", \"type\": \"A\",\n \"subdomain\": \"www\", \"value\": \"1.2.3.4\", \"ttl\": 3600}}\n\nErrors:\n VALIDATION_ERROR: Missing value, invalid record type\n NOT_FOUND: Domain not found\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"record_type": {
"title": "Record Type",
"type": "string"
},
"value": {
"title": "Value",
"type": "string"
},
"subdomain": {
"default": "",
"title": "Subdomain",
"type": "string"
},
"ttl": {
"default": 3600,
"title": "Ttl",
"type": "integer"
},
"priority": {
"default": null,
"title": "Priority",
"type": "integer"
}
},
"required": [
"domain_name",
"record_type",
"value"
],
"title": "add_domain_dnsArguments",
"type": "object"
}
}delete_domain_dns
2 params · 2 required
Delete a DNS record from a domain.
Requires: API key with write scope.
Args:
domain_name: Full domain na…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
| record_id* | string | — |
Raw schema JSON
{
"name": "delete_domain_dns",
"description": "Delete a DNS record from a domain.\n\nRequires: API key with write scope.\n\nArgs:\n domain_name: Full domain name (e.g. \"example.com\")\n record_id: ID of the DNS record to delete (from list_domain_dns)\n\nReturns:\n {\"success\": true, \"message\": \"DNS record deleted\"}\n\nErrors:\n NOT_FOUND: Domain or record not found\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
},
"record_id": {
"title": "Record Id",
"type": "string"
}
},
"required": [
"domain_name",
"record_id"
],
"title": "delete_domain_dnsArguments",
"type": "object"
}
}list_modules
1 param · 1 required
List AI modules and their enabled/disabled state for a site.
Also returns the list of modules available for t…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_modules",
"description": "List AI modules and their enabled/disabled state for a site.\n\nAlso returns the list of modules available for the site39;s plan.\n\nRequires: API key with read scope.\n\nArgs:\n slug: Site identifier\n\nReturns:\n {\"modules\": {\"chatbot\": true, \"seo\": false, \"translation\": false,\n \"content\": false}, \"available\": [\"chatbot\", \"seo\", \"translation\", \"content\"]}\n\nErrors:\n NOT_FOUND: Unknown slug\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_modulesArguments",
"type": "object"
}
}toggle_module
2 params · 2 required
Enable or disable an AI module on a site.
The module must be in the plan's available module list.
Requires: …
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| module_name* | string | — |
Raw schema JSON
{
"name": "toggle_module",
"description": "Enable or disable an AI module on a site.\n\nThe module must be in the plan39;s available module list.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n module_name: Module to toggle. Available modules:\n \"chatbot\" (AI chat widget), \"seo\" (SEO optimization),\n \"translation\" (content translation), \"content\" (AI content generation)\n\nReturns:\n {\"module\": \"chatbot\", \"enabled\": true, \"message\": \"Module enabled\"}\n\nErrors:\n NOT_FOUND: Unknown slug or module not in plan\n VALIDATION_ERROR: Invalid module name\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"module_name": {
"title": "Module Name",
"type": "string"
}
},
"required": [
"slug",
"module_name"
],
"title": "toggle_moduleArguments",
"type": "object"
}
}list_compute_types
0 params
List on-demand compute instance types with hourly CAD prices.
On-demand instances are real cloud VMs in Canad…
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"]}, ...]}
Input schema
No parameters.
Raw schema JSON
{
"name": "list_compute_types",
"description": "List on-demand compute instance types with hourly CAD prices.\n\nOn-demand instances are real cloud VMs in Canada (Montreal region),\nbilled per minute (1-hour minimum) post-paid onto your existing\nBorealHost subscription. Use them for short-lived extra compute\n(builds, batch jobs, experiments).\n\nRequires: API key with read scope.\n\nReturns:\n {\"region\": \"ca-central-1\", \"currency\": \"CAD\",\n \"billing\": \"hourly, post-paid; billing runs until the instance is terminated\",\n \"types\": [{\"type\": \"lsw.c3.large\", \"vcpu\": 2, \"memory_gb\": 3,\n \"hourly_price_cad\": 0.08, \"min_disk_gb\": 5,\n \"storage_types\": [\"CENTRAL\", \"LOCAL\"]}, ...]}\n",
"inputSchema": {
"properties": {},
"title": "list_compute_typesArguments",
"type": "object"
}
}list_compute_images
0 params
List OS images available for on-demand compute instances.
Requires: API key with read scope.
Returns:
{"…
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"}, ...]}
Input schema
No parameters.
Raw schema JSON
{
"name": "list_compute_images",
"description": "List OS images available for on-demand compute instances.\n\nRequires: API key with read scope.\n\nReturns:\n {\"images\": [{\"id\": \"UBUNTU_24_04_64BIT\", \"name\": \"Ubuntu 24.04 LTS (x86_64)\",\n \"family\": \"linux\", \"flavour\": \"ubuntu\"}, ...]}\n",
"inputSchema": {
"properties": {},
"title": "list_compute_imagesArguments",
"type": "object"
}
}launch_compute_instance
8 params · 2 required
Launch an on-demand hourly compute instance (Canada, CAD).
Billing starts at launch (per minute, 1-hour minim…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_type* | string | — |
| image_id* | string | — |
| name | string | — default: "" |
| ssh_public_key | string | — default: "" |
| user_data | string | — default: "" |
| root_disk_size | integer | — default: 0 |
| storage_type | string | — default: "CENTRAL" |
| max_lifetime_hours | integer | — default: 0 |
Raw schema JSON
{
"name": "launch_compute_instance",
"description": "Launch an on-demand hourly compute instance (Canada, CAD).\n\nBilling starts at launch (per minute, 1-hour minimum) and runs until\nterminate_compute_instance — stopping does NOT stop the charge. Every\ninstance has a hard TTL\n(max_lifetime_hours, default 72h) after which it is auto-terminated.\nUsage is metered onto your existing BorealHost subscription; an active\nsubscription is required.\n\nRequires: API key with write scope.\n\nArgs:\n instance_type: From list_compute_types, e.g. \"lsw.c3.large\"\n image_id: From list_compute_images, e.g. \"UBUNTU_24_04_64BIT\"\n name: Optional label for the instance\n ssh_public_key: Public key installed as root access. Mutually exclusive\n with user_data (provider limitation) — provide exactly one.\n user_data: cloud-init config (plain text #cloud-config). Use\n ssh_authorized_keys inside it if you need a key AND user data.\n root_disk_size: GB (default max(min_disk, 25))\n storage_type: \"CENTRAL\" (redundant) or \"LOCAL\" (faster I/O)\n max_lifetime_hours: Hard TTL, 1-336 (default 72)\n\nReturns:\n Instance dict: {\"id\", \"state\": \"launching\", \"public_ip\", \"instance_type\",\n \"hourly_price_cad\", \"terminate_after\", ...}. Poll get_compute_instance\n until state is \"running\" and public_ip is set (~1-3 min).\n\nErrors:\n PAYMENT_REQUIRED: No active subscription to bill against\n LIMIT_EXCEEDED: Concurrent instance cap reached\n SPEND_CAP_EXCEEDED: Monthly compute spend cap reached\n VALIDATION_ERROR: Bad type/image/disk/TTL, or both/neither of\n ssh_public_key and user_data\n",
"inputSchema": {
"properties": {
"instance_type": {
"title": "Instance Type",
"type": "string"
},
"image_id": {
"title": "Image Id",
"type": "string"
},
"name": {
"default": "",
"title": "Name",
"type": "string"
},
"ssh_public_key": {
"default": "",
"title": "Ssh Public Key",
"type": "string"
},
"user_data": {
"default": "",
"title": "User Data",
"type": "string"
},
"root_disk_size": {
"default": 0,
"title": "Root Disk Size",
"type": "integer"
},
"storage_type": {
"default": "CENTRAL",
"title": "Storage Type",
"type": "string"
},
"max_lifetime_hours": {
"default": 0,
"title": "Max Lifetime Hours",
"type": "integer"
}
},
"required": [
"instance_type",
"image_id"
],
"title": "launch_compute_instanceArguments",
"type": "object"
}
}list_compute_instances
1 param
List your on-demand compute instances with month-to-date spend.
Requires: API key with read scope.
Returns:
…
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}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| include_terminated | boolean | — default: false |
Raw schema JSON
{
"name": "list_compute_instances",
"description": "List your on-demand compute instances with month-to-date spend.\n\nRequires: API key with read scope.\n\nReturns:\n {\"instances\": [...], \"month_to_date_spend_cad\": 12.34,\n \"monthly_spend_cap_cad\": 500.0}\n",
"inputSchema": {
"properties": {
"include_terminated": {
"default": false,
"title": "Include Terminated",
"type": "boolean"
}
},
"title": "list_compute_instancesArguments",
"type": "object"
}
}get_compute_instance
1 param · 1 required
Get live details for a compute instance (state, public IP, accrued cost).
State is synced from the cloud prov…
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", ...}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
Raw schema JSON
{
"name": "get_compute_instance",
"description": "Get live details for a compute instance (state, public IP, accrued cost).\n\nState is synced from the cloud provider on each call. SSH as root once\nstate is \"running\" and public_ip is set.\n\nRequires: API key with read scope.\n\nArgs:\n instance_id: Instance UUID from launch_compute_instance / list\n\nReturns:\n {\"id\", \"state\", \"public_ip\", \"hourly_price_cad\", \"accrued_cad\",\n \"terminate_after\", ...}\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "get_compute_instanceArguments",
"type": "object"
}
}start_compute_instance
1 param · 1 required
Start a stopped compute instance.
Requires: API key with write scope.
Start a stopped compute instance. Requires: API key with write scope.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
Raw schema JSON
{
"name": "start_compute_instance",
"description": "Start a stopped compute instance.\n\nRequires: API key with write scope.\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "start_compute_instanceArguments",
"type": "object"
}
}stop_compute_instance
1 param · 1 required
Stop a compute instance. WARNING: hourly billing continues while stopped.
Use terminate_compute_instance to s…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
Raw schema JSON
{
"name": "stop_compute_instance",
"description": "Stop a compute instance. WARNING: hourly billing continues while stopped.\n\nUse terminate_compute_instance to stop the charges permanently.\n\nRequires: API key with write scope.\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "stop_compute_instanceArguments",
"type": "object"
}
}reboot_compute_instance
1 param · 1 required
Reboot a running compute instance.
Requires: API key with write scope.
Reboot a running compute instance. Requires: API key with write scope.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
Raw schema JSON
{
"name": "reboot_compute_instance",
"description": "Reboot a running compute instance.\n\nRequires: API key with write scope.\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "reboot_compute_instanceArguments",
"type": "object"
}
}terminate_compute_instance
1 param · 1 required
Permanently terminate a compute instance — this stops hourly billing.
The instance and its disk are destroyed…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
Raw schema JSON
{
"name": "terminate_compute_instance",
"description": "Permanently terminate a compute instance — this stops hourly billing.\n\nThe instance and its disk are destroyed and cannot be recovered. Copy any\nresults off the instance before terminating.\n\nRequires: API key with write scope.\n\nReturns:\n Final instance dict with state \"terminated\" and total accrued_cad.\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "terminate_compute_instanceArguments",
"type": "object"
}
}list_compute_volumes
0 params
List your compute volumes — machines that survive instance termination.
A volume is a whole machine (packages…
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.
Input schema
No parameters.
Raw schema JSON
{
"name": "list_compute_volumes",
"description": "List your compute volumes — machines that survive instance termination.\n\nA volume is a whole machine (packages, drivers, services, users, data)\nstored in Canada. Detaching destroys the instance but keeps the machine;\nattaching restores it onto a fresh instance, optionally of a DIFFERENT\ntype. That is how you move a workload from a small CPU box to a big GPU\nbox without rebuilding it.\n\nRequires: API key with read scope.\n\nReturns:\n {\"volumes\": [{\"id\", \"name\", \"state\", \"instance_type\", \"stored_gb\",\n \"has_snapshot\", \"instance\": {...} or null}, ...],\n \"price_cad_per_gb_month\": 0.03}\n\n state is one of: creating, attached, detaching, detached, attaching,\n error. Only \"attached\" has a running instance you can log into.\n",
"inputSchema": {
"properties": {},
"title": "list_compute_volumesArguments",
"type": "object"
}
}get_compute_volume
1 param · 1 required
Get a volume's live state, its instance, and its monthly storage cost.
Requires: API key with read scope.
Re…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| volume_id* | string | — |
Raw schema JSON
{
"name": "get_compute_volume",
"description": "Get a volume39;s live state, its instance, and its monthly storage cost.\n\nRequires: API key with read scope.\n\nReturns:\n Volume dict plus \"monthly_storage_cad\". After attach, poll this until\n instance.state is \"running\" — then allow a few more minutes for the\n restore to finish and the machine to reboot into itself.\n",
"inputSchema": {
"properties": {
"volume_id": {
"title": "Volume Id",
"type": "string"
}
},
"required": [
"volume_id"
],
"title": "get_compute_volumeArguments",
"type": "object"
}
}create_compute_volume
5 params · 4 required
Create a persistent machine and boot its first instance.
Start here, then set the machine up however you like…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| name* | string | — |
| image_id* | string | — |
| instance_type* | string | — |
| ssh_public_key* | string | — |
| root_disk_size | integer | — default: 0 |
Raw schema JSON
{
"name": "create_compute_volume",
"description": "Create a persistent machine and boot its first instance.\n\nStart here, then set the machine up however you like (install packages,\ndrivers, models). Everything you do becomes part of the volume the first\ntime you detach or snapshot it.\n\nWhile attached you pay hourly compute; while detached you pay only for\nstored bytes (CA$0.03/GB/month). Stopping an instance does NOT save money\non this provider — detaching is what stops the compute charge.\n\nRequires: API key with write scope, and an active subscription.\n\nArgs:\n name: Label for the volume, e.g. \"trainer\"\n image_id: From list_compute_images, e.g. \"UBUNTU_24_04_64BIT\".\n Cannot change later — restores must land on the same OS.\n instance_type: From list_compute_types, e.g. \"lsw.g6.xlarge\".\n CAN change on every later attach.\n ssh_public_key: Required. Volume instances always boot via cloud-init,\n so this is the only way in.\n root_disk_size: GB. Defaults to the type39;s minimum (or 25).\n\nReturns:\n Volume dict with state \"attached\". Poll get_compute_volume until\n instance.state is \"running\" (~1-3 min).\n\nErrors:\n PAYMENT_REQUIRED: No active subscription\n LIMIT_EXCEEDED: Volume cap reached\n NOT_AVAILABLE: Volumes not enabled on this deployment\n",
"inputSchema": {
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"image_id": {
"title": "Image Id",
"type": "string"
},
"instance_type": {
"title": "Instance Type",
"type": "string"
},
"ssh_public_key": {
"title": "Ssh Public Key",
"type": "string"
},
"root_disk_size": {
"default": 0,
"title": "Root Disk Size",
"type": "integer"
}
},
"required": [
"name",
"image_id",
"instance_type",
"ssh_public_key"
],
"title": "create_compute_volumeArguments",
"type": "object"
}
}adopt_compute_instance
2 params · 1 required
Turn an instance you are ALREADY running into a persistent volume.
Use this when you launched something, set …
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| instance_id* | string | — |
| name | string | — default: "" |
Raw schema JSON
{
"name": "adopt_compute_instance",
"description": "Turn an instance you are ALREADY running into a persistent volume.\n\nUse this when you launched something, set it up, and then decided you want\nto keep it. Nothing reboots and no data moves — the machine you have\nbecomes the volume, and you can detach it afterwards to stop paying for\ncompute while keeping the machine. Beats creating a volume and rebuilding.\n\nOnly instances launched with an ssh_public_key qualify. One launched with\nyour own user_data carries only your key, and a key cannot be added to a\nmachine we cannot already log into — check \"managed_ssh\" on the instance.\n\nRequires: API key with write scope, and an active subscription.\n\nArgs:\n instance_id: A running lsw.* instance you own\n name: Label for the volume (defaults to the instance name)\n\nReturns:\n Volume dict with state \"attached\", wrapping that same instance. No\n snapshot exists yet — the first one is taken on detach or snapshot.\n\nErrors:\n CONFLICT: Not running, already a volume, BorealHost Metal, or launched\n without BorealHost management access\n",
"inputSchema": {
"properties": {
"instance_id": {
"title": "Instance Id",
"type": "string"
},
"name": {
"default": "",
"title": "Name",
"type": "string"
}
},
"required": [
"instance_id"
],
"title": "adopt_compute_instanceArguments",
"type": "object"
}
}detach_compute_volume
1 param · 1 required
Queue: snapshot the machine, verify it, then destroy the instance.
This is how you stop paying for compute wh…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| volume_id* | string | — |
Raw schema JSON
{
"name": "detach_compute_volume",
"description": "Queue: snapshot the machine, verify it, then destroy the instance.\n\nThis is how you stop paying for compute while keeping your work.\n\nASYNCHRONOUS. Returns immediately with state \"detaching\" — it does NOT mean\nthe detach finished. The capture takes minutes (roughly 1 min per 10 GB plus\nverification), so it runs in a background worker. Poll get_compute_volume\nuntil state is \"detached\" (done) or \"error\" (failed).\n\nSafety: if the snapshot or its verification fails, the instance is left\nRUNNING and the volume goes to state \"error\". Your data is never traded\nfor a tidy state machine. Retry the detach once you have fixed the cause.\n\nRequires: API key with write scope.\n\nReturns:\n Volume dict with state \"detaching\". Poll for the outcome.\n",
"inputSchema": {
"properties": {
"volume_id": {
"title": "Volume Id",
"type": "string"
}
},
"required": [
"volume_id"
],
"title": "detach_compute_volumeArguments",
"type": "object"
}
}attach_compute_volume
4 params · 2 required
Restore a detached volume onto a fresh instance — optionally a new type.
Pass a different instance_type to mo…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| volume_id* | string | — |
| ssh_public_key* | string | — |
| instance_type | string | — default: "" |
| root_disk_size | integer | — default: 0 |
Raw schema JSON
{
"name": "attach_compute_volume",
"description": "Restore a detached volume onto a fresh instance — optionally a new type.\n\nPass a different instance_type to move the same machine to different\nhardware: this is the closest thing to changing instance type that the\nprovider allows, since it has no resize API at all.\n\nThe restore runs at first boot and the machine reboots into itself, so the\ninstance answers SSH BEFORE it is ready. Poll get_compute_volume and give\nit a few minutes (measured: ~6 min for a 10 GB GPU machine end to end).\n\nThe machine keeps its SSH host keys, so your client will not warn about a\nchanged host identity.\n\nRequires: API key with write scope.\n\nArgs:\n volume_id: A volume in state \"detached\"\n ssh_public_key: Required — installed via cloud-init at boot\n instance_type: Defaults to the type it last ran on\n root_disk_size: GB. May grow, never shrink below the volume39;s size.\n\nReturns:\n Volume dict with state \"attached\" and a new instance.\n\nErrors:\n CONFLICT: Volume is not detached, or has no snapshot yet\n",
"inputSchema": {
"properties": {
"volume_id": {
"title": "Volume Id",
"type": "string"
},
"ssh_public_key": {
"title": "Ssh Public Key",
"type": "string"
},
"instance_type": {
"default": "",
"title": "Instance Type",
"type": "string"
},
"root_disk_size": {
"default": 0,
"title": "Root Disk Size",
"type": "integer"
}
},
"required": [
"volume_id",
"ssh_public_key"
],
"title": "attach_compute_volumeArguments",
"type": "object"
}
}snapshot_compute_volume
2 params · 1 required
Queue a checkpoint snapshot without detaching — before a risky change.
ASYNCHRONOUS. Returns immediately with…
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.
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| volume_id* | string | — |
| quiesce_units | array<object> | — default: null |
Raw schema JSON
{
"name": "snapshot_compute_volume",
"description": "Queue a checkpoint snapshot without detaching — before a risky change.\n\nASYNCHRONOUS. Returns immediately with state \"snapshotting\"; poll\nget_compute_volume until it is back to \"attached\" (done) or \"error\".\n\nNamed systemd units are stopped for the capture so the snapshot is\napplication-consistent (a live database directory copied mid-write is not\nreliably restorable). The worker restarts nothing — reboot or start them\nyourself afterwards.\n\nRequires: API key with write scope.\n\nArgs:\n volume_id: A volume in state \"attached\"\n quiesce_units: Services to stop during capture,\n e.g. [\"ollama.service\", \"postgresql.service\"]\n\nReturns:\n Volume dict with state \"snapshotting\". Poll for the outcome.\n",
"inputSchema": {
"properties": {
"volume_id": {
"title": "Volume Id",
"type": "string"
},
"quiesce_units": {
"default": null,
"items": {},
"title": "Quiesce Units",
"type": "array"
}
},
"required": [
"volume_id"
],
"title": "snapshot_compute_volumeArguments",
"type": "object"
}
}delete_compute_volume
2 params · 1 required
Permanently delete a volume and everything stored in it.
Irreversible: the instance is released AND the store…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| volume_id* | string | — |
| force | boolean | — default: false |
Raw schema JSON
{
"name": "delete_compute_volume",
"description": "Permanently delete a volume and everything stored in it.\n\nIrreversible: the instance is released AND the stored data is purged from\nobject storage, so billing genuinely stops. Refuses while an instance is\nlive unless force=True, so a running machine39;s only copy cannot be\ndestroyed by reflex.\n\nRequires: API key with admin scope.\n\nReturns:\n {\"id\", \"state\": \"deleted\"}\n",
"inputSchema": {
"properties": {
"volume_id": {
"title": "Volume Id",
"type": "string"
},
"force": {
"default": false,
"title": "Force",
"type": "boolean"
}
},
"required": [
"volume_id"
],
"title": "delete_compute_volumeArguments",
"type": "object"
}
}container_action
2 params · 2 required
Start, stop, or restart a site's container.
Only for plans with a dedicated container (VPS / split-VPS / dedi…
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
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| action* | string | — |
Raw schema JSON
{
"name": "container_action",
"description": "Start, stop, or restart a site39;s container.\n\nOnly for plans with a dedicated container (VPS / split-VPS / dedicated).\nShared-hosting sites share a container and cannot restart it. The\nresponse reports the observed container state after the action.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n action: \"start\", \"stop\", or \"restart\"\n\nReturns:\n {\"site\", \"action\", \"status\": \"running|stopped\", \"observed\": true}\n\nErrors:\n VALIDATION_ERROR: Shared-hosting plan or unknown action\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
}
},
"required": [
"slug",
"action"
],
"title": "container_actionArguments",
"type": "object"
}
}list_support_tickets
1 param
List the account's support tickets.
Requires: API key with read scope.
Args:
status: Optional filter (e.…
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", ...}, ...]
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| status | string | — default: "" |
Raw schema JSON
{
"name": "list_support_tickets",
"description": "List the account39;s support tickets.\n\nRequires: API key with read scope.\n\nArgs:\n status: Optional filter (e.g. \"open\", \"closed\")\n\nReturns:\n [{\"id\", \"subject\", \"status\", \"category\", \"created_at\", ...}, ...]\n",
"inputSchema": {
"properties": {
"status": {
"default": "",
"title": "Status",
"type": "string"
}
},
"title": "list_support_ticketsArguments",
"type": "object"
}
}get_support_ticket
1 param · 1 required
Get a support ticket with its full message thread.
Requires: API key with read scope.
Args:
ticket_id: T…
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": [...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| ticket_id* | string | — |
Raw schema JSON
{
"name": "get_support_ticket",
"description": "Get a support ticket with its full message thread.\n\nRequires: API key with read scope.\n\nArgs:\n ticket_id: Ticket UUID from list_support_tickets\n\nReturns:\n {\"id\", \"subject\", \"status\", \"messages\": [...]}\n",
"inputSchema": {
"properties": {
"ticket_id": {
"title": "Ticket Id",
"type": "string"
}
},
"required": [
"ticket_id"
],
"title": "get_support_ticketArguments",
"type": "object"
}
}create_support_ticket
4 params · 2 required
Open a support ticket with the BorealHost team.
Use this to escalate platform-side problems you cannot fix wi…
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..."}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| subject* | string | — |
| message* | string | — |
| category | string | — default: "" |
| site | string | — default: "" |
Raw schema JSON
{
"name": "create_support_ticket",
"description": "Open a support ticket with the BorealHost team.\n\nUse this to escalate platform-side problems you cannot fix with the\navailable tools (billing issues, infrastructure faults, API bugs).\nA human answers every ticket — poll get_support_ticket for updates.\n\nRequires: API key with write scope.\n\nArgs:\n subject: Short summary (max 200 chars)\n message: Full description (max 20000 chars)\n category: Optional (e.g. \"technical\", \"billing\")\n site: Optional site slug the ticket concerns\n\nReturns:\n {\"id\", \"subject\", \"status\", \"message\": \"Ticket created...\"}\n",
"inputSchema": {
"properties": {
"subject": {
"title": "Subject",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"category": {
"default": "",
"title": "Category",
"type": "string"
},
"site": {
"default": "",
"title": "Site",
"type": "string"
}
},
"required": [
"subject",
"message"
],
"title": "create_support_ticketArguments",
"type": "object"
}
}reply_support_ticket
2 params · 2 required
Add a message to an existing support ticket.
Requires: API key with write scope.
Args:
ticket_id: 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", ...}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| ticket_id* | string | — |
| message* | string | — |
Raw schema JSON
{
"name": "reply_support_ticket",
"description": "Add a message to an existing support ticket.\n\nRequires: API key with write scope.\n\nArgs:\n ticket_id: Ticket UUID\n message: Reply text\n\nReturns:\n {\"id\", \"status\", ...}\n",
"inputSchema": {
"properties": {
"ticket_id": {
"title": "Ticket Id",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
}
},
"required": [
"ticket_id",
"message"
],
"title": "reply_support_ticketArguments",
"type": "object"
}
}get_backup_retention
1 param · 1 required
Get the backup retention policy for a VPS site.
Requires: API key with read scope.
Returns:
{"site", "re…
Get the backup retention policy for a VPS site. Requires: API key with read scope. Returns: {"site", "retention": {"keep_daily", "keep_weekly", "keep_monthly"}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_backup_retention",
"description": "Get the backup retention policy for a VPS site.\n\nRequires: API key with read scope.\n\nReturns:\n {\"site\", \"retention\": {\"keep_daily\", \"keep_weekly\", \"keep_monthly\"}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_backup_retentionArguments",
"type": "object"
}
}set_backup_retention
5 params · 1 required
Set the backup retention policy for a VPS site.
Storage is billed on real stored bytes, so deeper history cos…
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| keep_daily | integer | — default: -1 |
| keep_weekly | integer | — default: -1 |
| keep_monthly | integer | — default: -1 |
| reset | boolean | — default: false |
Raw schema JSON
{
"name": "set_backup_retention",
"description": "Set the backup retention policy for a VPS site.\n\nStorage is billed on real stored bytes, so deeper history costs the\ncustomer, not the platform. Values are clamped to platform bounds; the\nresponse reports what was actually stored. Pass -1 to leave a knob\nunchanged, or reset=true to restore defaults.\n\nRequires: API key with write scope.\n\nReturns:\n {\"site\", \"retention\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"keep_daily": {
"default": -1,
"title": "Keep Daily",
"type": "integer"
},
"keep_weekly": {
"default": -1,
"title": "Keep Weekly",
"type": "integer"
},
"keep_monthly": {
"default": -1,
"title": "Keep Monthly",
"type": "integer"
},
"reset": {
"default": false,
"title": "Reset",
"type": "boolean"
}
},
"required": [
"slug"
],
"title": "set_backup_retentionArguments",
"type": "object"
}
}delete_backup
2 params · 2 required
Permanently delete a single backup (metadata + stored snapshot).
Irreversible. Requires: API key with admin s…
Permanently delete a single backup (metadata + stored snapshot). Irreversible. Requires: API key with admin scope. Returns: {"site", "backup_id", "deleted": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| backup_id* | string | — |
Raw schema JSON
{
"name": "delete_backup",
"description": "Permanently delete a single backup (metadata + stored snapshot).\n\nIrreversible. Requires: API key with admin scope.\n\nReturns:\n {\"site\", \"backup_id\", \"deleted\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"backup_id": {
"title": "Backup Id",
"type": "string"
}
},
"required": [
"slug",
"backup_id"
],
"title": "delete_backupArguments",
"type": "object"
}
}list_redirects
1 param · 1 required
List HTTP redirect rules for a site.
Requires: API key with read scope.
Returns:
[{"id", "source_path", …
List HTTP redirect rules for a site. Requires: API key with read scope. Returns: [{"id", "source_path", "target_url", "redirect_type"}, ...]
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "list_redirects",
"description": "List HTTP redirect rules for a site.\n\nRequires: API key with read scope.\n\nReturns:\n [{\"id\", \"source_path\", \"target_url\", \"redirect_type\"}, ...]\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_redirectsArguments",
"type": "object"
}
}add_redirect
4 params · 3 required
Add an HTTP redirect rule to a site.
Requires: API key with write scope.
Args:
slug: Site identifier
…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| source_path* | string | — |
| target_url* | string | — |
| redirect_type | integer | — default: 301 |
Raw schema JSON
{
"name": "add_redirect",
"description": "Add an HTTP redirect rule to a site.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n source_path: Path to redirect, must start with \"/\" (e.g. \"/old-page\")\n target_url: Destination URL\n redirect_type: 301 (permanent, default) or 302 (temporary)\n\nReturns:\n {\"id\", \"source_path\", \"target_url\", \"redirect_type\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"source_path": {
"title": "Source Path",
"type": "string"
},
"target_url": {
"title": "Target Url",
"type": "string"
},
"redirect_type": {
"default": 301,
"title": "Redirect Type",
"type": "integer"
}
},
"required": [
"slug",
"source_path",
"target_url"
],
"title": "add_redirectArguments",
"type": "object"
}
}delete_redirect
3 params · 1 required
Delete a redirect rule by source path or id.
Requires: API key with write scope.
Returns:
{"site", "dele…
Delete a redirect rule by source path or id. Requires: API key with write scope. Returns: {"site", "deleted": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| source_path | string | — default: "" |
| redirect_id | string | — default: "" |
Raw schema JSON
{
"name": "delete_redirect",
"description": "Delete a redirect rule by source path or id.\n\nRequires: API key with write scope.\n\nReturns:\n {\"site\", \"deleted\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"source_path": {
"default": "",
"title": "Source Path",
"type": "string"
},
"redirect_id": {
"default": "",
"title": "Redirect Id",
"type": "string"
}
},
"required": [
"slug"
],
"title": "delete_redirectArguments",
"type": "object"
}
}set_force_https
2 params · 2 required
Enable or disable the HTTP→HTTPS redirect for a site.
Requires: API key with write scope.
Returns:
{"sit…
Enable or disable the HTTP→HTTPS redirect for a site. Requires: API key with write scope. Returns: {"site", "force_https": true|false, "message"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| enabled* | boolean | — |
Raw schema JSON
{
"name": "set_force_https",
"description": "Enable or disable the HTTP→HTTPS redirect for a site.\n\nRequires: API key with write scope.\n\nReturns:\n {\"site\", \"force_https\": true|false, \"message\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"slug",
"enabled"
],
"title": "set_force_httpsArguments",
"type": "object"
}
}list_db_users
2 params · 1 required
List database users for a site.
Requires: API key with read scope.
Returns:
{"engine", "users": [{"user"…
List database users for a site. Requires: API key with read scope. Returns: {"engine", "users": [{"user", "host", ...}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| engine | string | — default: "mysql" |
Raw schema JSON
{
"name": "list_db_users",
"description": "List database users for a site.\n\nRequires: API key with read scope.\n\nReturns:\n {\"engine\", \"users\": [{\"user\", \"host\", ...}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"engine": {
"default": "mysql",
"title": "Engine",
"type": "string"
}
},
"required": [
"slug"
],
"title": "list_db_usersArguments",
"type": "object"
}
}manage_db_user
8 params · 2 required
Manage a database user on a site.
Actions: "create" (user+password), "drop" (user),
"set_password" (user+pass…
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": {...}}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| action* | string | — |
| engine | string | — default: "mysql" |
| user | string | — default: "" |
| password | string | — default: "" |
| database | string | — default: "" |
| privileges | string | — default: "" |
| host | string | — default: "" |
Raw schema JSON
{
"name": "manage_db_user",
"description": "Manage a database user on a site.\n\nActions: \"create\" (user+password), \"drop\" (user),\n\"set_password\" (user+password), \"grants\" (list a user39;s grants),\n\"grant\" / \"revoke\" (user+database, optional privileges e.g. \"ALL\"\nor \"SELECT,INSERT\").\n\nRequires: API key with write scope.\n\nReturns:\n {\"engine\", \"action\", \"result\": {...}}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"action": {
"title": "Action",
"type": "string"
},
"engine": {
"default": "mysql",
"title": "Engine",
"type": "string"
},
"user": {
"default": "",
"title": "User",
"type": "string"
},
"password": {
"default": "",
"title": "Password",
"type": "string"
},
"database": {
"default": "",
"title": "Database",
"type": "string"
},
"privileges": {
"default": "",
"title": "Privileges",
"type": "string"
},
"host": {
"default": "",
"title": "Host",
"type": "string"
}
},
"required": [
"slug",
"action"
],
"title": "manage_db_userArguments",
"type": "object"
}
}transfer_out_domain
1 param · 1 required
Prepare a domain to transfer to another registrar.
Unlocks the domain and emails the EPP/auth code to the reg…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "transfer_out_domain",
"description": "Prepare a domain to transfer to another registrar.\n\nUnlocks the domain and emails the EPP/auth code to the registrant\ncontact on file (BorealHost never sees the code). The domain keeps\nworking here until the transfer completes.\n\nRequires: API key with write scope.\n\nReturns:\n {\"domain\", \"unlocked\": true, \"auth_code_emailed\": true, \"message\"}\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "transfer_out_domainArguments",
"type": "object"
}
}enable_wildcard
1 param · 1 required
Route *.domain (every subdomain) to the domain's linked site.
Creates a wildcard DNS record and issues a wild…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| domain_name* | string | — |
Raw schema JSON
{
"name": "enable_wildcard",
"description": "Route *.domain (every subdomain) to the domain39;s linked site.\n\nCreates a wildcard DNS record and issues a wildcard certificate via\nACME DNS-01. SLOW — DNS propagation is part of the challenge, expect\n2-5 minutes. Requires the domain to be linked to a site and its DNS\nhosted by BorealHost.\n\nRequires: API key with write scope.\n\nReturns:\n {\"domain\", \"wildcard\", \"site\", \"ssl_active\", \"not_after\"}\n",
"inputSchema": {
"properties": {
"domain_name": {
"title": "Domain Name",
"type": "string"
}
},
"required": [
"domain_name"
],
"title": "enable_wildcardArguments",
"type": "object"
}
}upload_ssl_cert
4 params · 4 required
Install your own SSL certificate for a site's domain.
The certificate must be a PEM fullchain (leaf + interme…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| domain* | string | — |
| fullchain_pem* | string | — |
| privkey_pem* | string | — |
Raw schema JSON
{
"name": "upload_ssl_cert",
"description": "Install your own SSL certificate for a site39;s domain.\n\nThe certificate must be a PEM fullchain (leaf + intermediates) and the\nkey unencrypted PEM. Validated (parse, key match, domain coverage,\nexpiry) before nginx is touched; nginx config is tested before reload.\n\nRequires: API key with write scope.\n\nReturns:\n {\"site\", \"domain\", \"server_names\", \"installed\": true,\n \"ssl_active\": true, \"not_after\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"domain": {
"title": "Domain",
"type": "string"
},
"fullchain_pem": {
"title": "Fullchain Pem",
"type": "string"
},
"privkey_pem": {
"title": "Privkey Pem",
"type": "string"
}
},
"required": [
"slug",
"domain",
"fullchain_pem",
"privkey_pem"
],
"title": "upload_ssl_certArguments",
"type": "object"
}
}get_email_status
1 param · 1 required
Email addon status and mailboxes for a site.
Requires: API key with read scope.
Returns:
{"configured": …
Email addon status and mailboxes for a site. Requires: API key with read scope. Returns: {"configured": bool, "domain", "mailboxes", "mailbox_list": [...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_email_status",
"description": "Email addon status and mailboxes for a site.\n\nRequires: API key with read scope.\n\nReturns:\n {\"configured\": bool, \"domain\", \"mailboxes\", \"mailbox_list\": [...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_email_statusArguments",
"type": "object"
}
}setup_email
2 params · 2 required
Enable business email (hosted mailboxes + webmail) on a domain.
Creates the hosted-email domain, sets up outb…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| domain* | string | — |
Raw schema JSON
{
"name": "setup_email",
"description": "Enable business email (hosted mailboxes + webmail) on a domain.\n\nCreates the hosted-email domain, sets up outbound authentication\n(DKIM/SPF), and auto-configures MX/SPF DNS when the zone is hosted by\nBorealHost. Mailboxes are billed per-mailbox on the site subscription.\n\nRequires: API key with write scope.\n\nReturns:\n {\"configured\": true, \"domain\", \"dns_auto_configured\", \"message\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"domain": {
"title": "Domain",
"type": "string"
}
},
"required": [
"slug",
"domain"
],
"title": "setup_emailArguments",
"type": "object"
}
}create_mailbox
4 params · 2 required
Create a mailbox on the site's email domain.
Password is generated when omitted and returned ONCE — store it.…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| local_part* | string | — |
| display_name | string | — default: "" |
| password | string | — default: "" |
Raw schema JSON
{
"name": "create_mailbox",
"description": "Create a mailbox on the site39;s email domain.\n\nPassword is generated when omitted and returned ONCE — store it.\nEach mailbox adds to the subscription39;s email billing.\n\nRequires: API key with write scope.\n\nArgs:\n slug: Site identifier\n local_part: Part before the @ (e.g. \"info\")\n display_name: Optional display name\n password: Optional password (generated if empty)\n\nReturns:\n {\"email\", \"password\", \"message\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"local_part": {
"title": "Local Part",
"type": "string"
},
"display_name": {
"default": "",
"title": "Display Name",
"type": "string"
},
"password": {
"default": "",
"title": "Password",
"type": "string"
}
},
"required": [
"slug",
"local_part"
],
"title": "create_mailboxArguments",
"type": "object"
}
}delete_mailbox
2 params · 2 required
Delete a mailbox (its mail is destroyed).
Requires: API key with write scope.
Returns:
{"email", "delete…
Delete a mailbox (its mail is destroyed). Requires: API key with write scope. Returns: {"email", "deleted": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| email* | string | — |
Raw schema JSON
{
"name": "delete_mailbox",
"description": "Delete a mailbox (its mail is destroyed).\n\nRequires: API key with write scope.\n\nReturns:\n {\"email\", \"deleted\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
}
},
"required": [
"slug",
"email"
],
"title": "delete_mailboxArguments",
"type": "object"
}
}reset_mailbox_password
3 params · 2 required
Reset a mailbox password (generated when omitted, returned ONCE).
Requires: API key with write scope.
Return…
Reset a mailbox password (generated when omitted, returned ONCE). Requires: API key with write scope. Returns: {"email", "password", "message"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| email* | string | — |
| new_password | string | — default: "" |
Raw schema JSON
{
"name": "reset_mailbox_password",
"description": "Reset a mailbox password (generated when omitted, returned ONCE).\n\nRequires: API key with write scope.\n\nReturns:\n {\"email\", \"password\", \"message\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
},
"new_password": {
"default": "",
"title": "New Password",
"type": "string"
}
},
"required": [
"slug",
"email"
],
"title": "reset_mailbox_passwordArguments",
"type": "object"
}
}get_webmail_url
2 params · 2 required
One-time webmail single-sign-on URL for a mailbox.
Requires: API key with write scope.
Returns:
{"email"…
One-time webmail single-sign-on URL for a mailbox. Requires: API key with write scope. Returns: {"email", "url"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| email* | string | — |
Raw schema JSON
{
"name": "get_webmail_url",
"description": "One-time webmail single-sign-on URL for a mailbox.\n\nRequires: API key with write scope.\n\nReturns:\n {\"email\", \"url\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
}
},
"required": [
"slug",
"email"
],
"title": "get_webmail_urlArguments",
"type": "object"
}
}list_webhooks
0 params
List webhook endpoints registered on the account.
Requires: API key with read scope.
Returns:
[{"id", "u…
List webhook endpoints registered on the account. Requires: API key with read scope. Returns: [{"id", "url", "events", "is_active", "last_status", "failure_count"}, ...]
Input schema
No parameters.
Raw schema JSON
{
"name": "list_webhooks",
"description": "List webhook endpoints registered on the account.\n\nRequires: API key with read scope.\n\nReturns:\n [{\"id\", \"url\", \"events\", \"is_active\", \"last_status\",\n \"failure_count\"}, ...]\n",
"inputSchema": {
"properties": {},
"title": "list_webhooksArguments",
"type": "object"
}
}create_webhook
2 params · 1 required
Register a webhook endpoint for platform events.
Events (backup failures, security notices, hosting incidents…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| url* | string | — |
| events | array<object> | — default: null |
Raw schema JSON
{
"name": "create_webhook",
"description": "Register a webhook endpoint for platform events.\n\nEvents (backup failures, security notices, hosting incidents, billing)\nare POSTed as JSON, signed with X-BH-Signature (HMAC-SHA256 of the raw\nbody). The signing secret is returned ONCE. Categories: billing,\nsecurity, hosting, decommission, general — empty list means all.\nEndpoints auto-disable after 20 consecutive failures.\n\nRequires: API key with write scope.\n\nReturns:\n {\"id\", \"url\", \"events\", \"secret\", \"message\"}\n",
"inputSchema": {
"properties": {
"url": {
"title": "Url",
"type": "string"
},
"events": {
"default": null,
"items": {},
"title": "Events",
"type": "array"
}
},
"required": [
"url"
],
"title": "create_webhookArguments",
"type": "object"
}
}delete_webhook
1 param · 1 required
Remove a webhook endpoint.
Requires: API key with write scope.
Returns:
{"id", "deleted": true}
Remove a webhook endpoint. Requires: API key with write scope. Returns: {"id", "deleted": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| endpoint_id* | string | — |
Raw schema JSON
{
"name": "delete_webhook",
"description": "Remove a webhook endpoint.\n\nRequires: API key with write scope.\n\nReturns:\n {\"id\", \"deleted\": true}\n",
"inputSchema": {
"properties": {
"endpoint_id": {
"title": "Endpoint Id",
"type": "string"
}
},
"required": [
"endpoint_id"
],
"title": "delete_webhookArguments",
"type": "object"
}
}test_webhook
1 param · 1 required
Send a test event to a webhook endpoint (async).
Poll list_webhooks afterwards for last_status.
Requires: AP…
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| endpoint_id* | string | — |
Raw schema JSON
{
"name": "test_webhook",
"description": "Send a test event to a webhook endpoint (async).\n\nPoll list_webhooks afterwards for last_status.\n\nRequires: API key with write scope.\n\nReturns:\n {\"id\", \"message\"}\n",
"inputSchema": {
"properties": {
"endpoint_id": {
"title": "Endpoint Id",
"type": "string"
}
},
"required": [
"endpoint_id"
],
"title": "test_webhookArguments",
"type": "object"
}
}get_smtp_relay
1 param · 1 required
List SMTP relay credentials for a site, with domain-auth status.
Requires: API key with read scope.
Returns:…
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"}, ...]}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
Raw schema JSON
{
"name": "get_smtp_relay",
"description": "List SMTP relay credentials for a site, with domain-auth status.\n\nRequires: API key with read scope.\n\nReturns:\n {\"relays\": [{\"relay_id\", \"domain\", \"status\",\n \"domain_authenticated\"}, ...]}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
}
},
"required": [
"slug"
],
"title": "get_smtp_relayArguments",
"type": "object"
}
}enable_smtp_relay
2 params · 2 required
Enable an SMTP relay for a site's outbound transactional mail.
Provisions a mail-send-only credential on the …
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"}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| domain* | string | — |
Raw schema JSON
{
"name": "enable_smtp_relay",
"description": "Enable an SMTP relay for a site39;s outbound transactional mail.\n\nProvisions a mail-send-only credential on the platform relay and\nconfigures SPF/DKIM DNS when the domain zone is hosted here. The SMTP\npassword is returned ONCE. Use TLS on port 587, username \"apikey\".\n\nRequires: API key with write scope.\n\nReturns:\n {\"relay_id\", \"domain\", \"smtp_host\", \"smtp_ports\", \"smtp_username\",\n \"smtp_password\", \"dns_auto_configured\", \"message\"}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"domain": {
"title": "Domain",
"type": "string"
}
},
"required": [
"slug",
"domain"
],
"title": "enable_smtp_relayArguments",
"type": "object"
}
}revoke_smtp_relay
2 params · 2 required
Revoke an SMTP relay credential (immediate at the relay).
Requires: API key with write scope.
Returns:
{…
Revoke an SMTP relay credential (immediate at the relay). Requires: API key with write scope. Returns: {"relay_id", "revoked": true}
Input schema
| Parameter | Type | Description & constraints |
|---|---|---|
| slug* | string | — |
| relay_id* | string | — |
Raw schema JSON
{
"name": "revoke_smtp_relay",
"description": "Revoke an SMTP relay credential (immediate at the relay).\n\nRequires: API key with write scope.\n\nReturns:\n {\"relay_id\", \"revoked\": true}\n",
"inputSchema": {
"properties": {
"slug": {
"title": "Slug",
"type": "string"
},
"relay_id": {
"title": "Relay Id",
"type": "string"
}
},
"required": [
"slug",
"relay_id"
],
"title": "revoke_smtp_relayArguments",
"type": "object"
}
}Resources 5
| URI | Name | MIME type | Description |
|---|---|---|---|
| borealhost://api/errors | Error Codes | text/plain |
All API error codes with HTTP status, meaning, and recovery guidance |
| borealhost://api/scopes | API Key Scopes | text/plain |
API key scope hierarchy and which tools require which scope |
| borealhost://api/enums | Enum Values | text/plain |
All valid enum values for API parameters (checkout status, DNS types, log types, plan tracks, etc.) |
| borealhost://api/response-format | Response Format | text/plain |
API response envelope format documentation |
| borealhost://plans | Plan Catalog | text/plain |
Live plan catalog with current pricing — fetched from the BorealHost API |
Prompts 5
| Name | Arguments | Description |
|---|---|---|
purchase_hosting |
plan_slug, billing | Step-by-step guide to purchase a BorealHost hosting plan, from plan discovery through payment to site provisioning |
setup_site |
slug* | Post-purchase site setup guide: configure DNS, enable AI modules |
manage_dns |
slug* | Guide for common DNS operations: A records, CNAME, MX, TXT/SPF, with examples |
register_domain |
domain | Domain registration guide with required WHOIS contact fields and .ca specifics |
claim_site_key |
site_slug* | Get an API key by proving you're running on a BorealHost container (challenge-response flow) |
Inventory recorded Aug 29, 2026 — 1:00 AM as rev 7. Listing calls only — tools are never invoked.
Canonical contract hash
sha256:bf2fad4f2348e2d707855b9371912fa911717cc8dbc4af2b0a8ba8193fecd283
Computed centrally from the normalized capability inventory (normalizer v1). Scanners submit raw observations; the control plane normalizes and hashes, so every scanner agrees on the same value.
Revisions 7
| Rev | Observed | Hash |
|---|---|---|
| rev 7 | Aug 29, 2026 — 1:00 AM (20 d ago) | |
| rev 6 | Aug 28, 2026 — 10:55 PM (20 d ago) | |
| rev 5 | Aug 28, 2026 — 8:50 PM (20 d ago) | |
| rev 4 | Aug 28, 2026 — 2:35 PM (20 d ago) | |
| rev 3 | Aug 25, 2026 — 10:00 PM (23 d ago) | |
| rev 2 | Aug 24, 2026 — 11:05 PM (24 d ago) | |
| rev 1 baseline | Aug 6, 2026 — 5:15 AM (43 d ago) |
Contract changes 6
get_wallet was added.
rev 6 → 7 · 20 d ago
site_type was added at add_site.inputSchema.
rev 5 → 6 · 20 d ago
set_site_type was added.
rev 4 → 5 · 20 d ago
add_site was added.
rev 3 → 4 · 20 d ago
cancel_checkout was added.
rev 2 → 3 · 23 d ago
get_site_nginx_snippet was added.
rev 1 → 2 · 24 d ago
Full snapshots are stored only when the canonical hash changes — unchanged observations update freshness without duplicating the contract.
Recent observations latest 30
| Observed | Result | Latency |
|---|---|---|
| Sep 17, 2026 — 7:10 PM (1 h ago) | Reachable | 137 ms |
| Sep 17, 2026 — 5:05 PM (3 h ago) | Reachable | 157 ms |
| Sep 17, 2026 — 3:00 PM (5 h ago) | Reachable | 145 ms |
| Sep 17, 2026 — 1:00 PM (7 h ago) | Reachable | 112 ms |
| Sep 17, 2026 — 11:00 AM (9 h ago) | Reachable | 126 ms |
| Sep 17, 2026 — 8:55 AM (11 h ago) | Reachable | 92 ms |
| Sep 17, 2026 — 6:50 AM (13 h ago) | Reachable | 90 ms |
| Sep 17, 2026 — 4:45 AM (15 h ago) | Reachable | 97 ms |
| Sep 17, 2026 — 2:40 AM (18 h ago) | Reachable | 99 ms |
| Sep 17, 2026 — 12:40 AM (20 h ago) | Reachable | 136 ms |
| Sep 16, 2026 — 10:35 PM (22 h ago) | Reachable | 97 ms |
| Sep 16, 2026 — 8:30 PM (24 h ago) | Reachable | 121 ms |
| Sep 16, 2026 — 6:25 PM (1 d ago) | Reachable | 154 ms |
| Sep 16, 2026 — 4:20 PM (1 d ago) | Reachable | 101 ms |
| Sep 16, 2026 — 2:20 PM (1 d ago) | Reachable | 108 ms |
| Sep 16, 2026 — 12:20 PM (1 d ago) | Reachable | 116 ms |
| Sep 16, 2026 — 10:15 AM (1 d ago) | Reachable | 139 ms |
| Sep 16, 2026 — 8:10 AM (2 d ago) | Reachable | 127 ms |
| Sep 16, 2026 — 6:10 AM (2 d ago) | Reachable | 93 ms |
| Sep 16, 2026 — 4:05 AM (2 d ago) | Reachable | 101 ms |
| Sep 16, 2026 — 2:05 AM (2 d ago) | Reachable | 128 ms |
| Sep 16, 2026 — 12:01 AM (2 d ago) | Reachable | 491 ms |
| Sep 15, 2026 — 9:55 PM (2 d ago) | Reachable | 121 ms |
| Sep 15, 2026 — 7:50 PM (2 d ago) | Reachable | 137 ms |
| Sep 15, 2026 — 5:50 PM (2 d ago) | Reachable | 153 ms |
| Sep 15, 2026 — 3:45 PM (2 d ago) | Reachable | 129 ms |
| Sep 15, 2026 — 1:45 PM (2 d ago) | Reachable | 143 ms |
| Sep 15, 2026 — 11:40 AM (2 d ago) | Reachable | 95 ms |
| Sep 15, 2026 — 9:35 AM (2 d ago) | Reachable | 127 ms |
| Sep 15, 2026 — 7:35 AM (3 d ago) | Reachable | 91 ms |
Latest check — evidence & validation Sep 17, 2026 — 7:10 PM
{
"server": "cloudflare",
"content-type": "text/event-stream",
"mcp-session-id": "1d3764db5c1e45568e7decfeb5270d80"
}{
"name": "BorealHost",
"version": "1.27.0",
"title": null
}Publisher supplied
unverified| Name | BorealHost MCP |
| Vendor | BorealHost |
| Category | infrastructure |
| Docs | — |
| Repository | — |
| Auth expected | Auth expectations unknown |
Registry and publisher metadata from the deployment seed. Displayed as supplied — MCP Tools does not verify it.
Independently observed
verified| Server name | BorealHost |
| Server version | 1.27.0 |
| Transport | Streamable HTTP |
| Protocol version | 2025-06-18 |
| First observed | Aug 6, 2026 |
| Last observed | 1 h ago |
| Last successful | 1 h ago |
| Origin | Registry seed |
Facts recorded by scanners during passive observation — initialize and list calls only, never tool invocation.