MCP tool reference

The 343 tools the PBN.LTD MCP server (https://app.pbn.ltd/mcp) offers, in the order tools/list returns them. Each one is the same operation as the REST endpoint named beside it (paths relative to https://app.pbn.ltd/api/v1), with the same permission, the same limits and the same audit trail - see the API reference for the full description of what each field means.

A connection only sees the tools its permissions allow. "Kind" is the behaviour annotation the tool carries: read never changes anything, write does, and DESTRUCTIVE replaces or deletes something that cannot be brought back.

All tools

Account

The account behind the key: profile, plan, site slots, limits and usage.

account_limits

Plan, slots, limits and frozen sites · read-only · permission account:read · REST equivalent GET /account/limits

Site slots (plan + extra-site add-ons), subscription state and paid-until date, the default per-site limits, every paused (frozen) site with the reason(s) it is paused, and the add-ons on the account. Needs the account:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "account_limits",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Account. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

account_me

Who am I · read-only · permission account:read · REST equivalent GET /me

The account and the key making the call. The cheapest call there is, which makes it a key test. Needs the account:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "account_me",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Account. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

account_usage_refresh

Measure usage of the whole account now · write · permission account:write · REST equivalent POST /account/limits/refresh

Starts a fresh disk / database / file-count measurement for the account's sites - the usage tab's "Check now", for many sites at once. It returns at once: each site is reported as started, busy, throttled (the panel's own per-site cooldown and per-account budget apply unchanged) or skipped with the reason. The new figures appear in the account limits and each site's usage a few seconds later. Needs the account:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "account_usage_refresh",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Account. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

meta_limits

API limits for this key · read-only · permission kb:read · REST equivalent GET /limits

The rate limits and size limits that apply to the key making the call. overridden is true when support has raised or lowered a limit for this key or for the whole account. Needs the kb:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "meta_limits",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Account. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Billing

Subscription, payment due, invoices and invoice PDFs, add-ons.

billing_invoice_pdf

Download an invoice PDF · read-only · permission billing:read · REST equivalent GET /billing/invoices/{number}.pdf

The PDF of an invoice or credit note of this account (Content-Type application/pdf). Needs the billing:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "billing_invoice_pdf",
    "arguments": {
      "number": "PBN-2026-001234"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Billing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

billing_invoices

Payments and invoices · read-only · permission billing:read · REST equivalent GET /billing/invoices

Every payment and refund of the account, newest first. document is the invoice / credit note when one has been issued, with its number for the PDF. Needs the billing:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "billing_invoices",
    "arguments": {
      "limit": 10
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Billing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

billing_summary

Billing overview · read-only · permission billing:read · REST equivalent GET /billing

Subscription (state, plan, paid-until date, days left, payment method), unpaid state with the date sites are removed if it stays unpaid, site slots, add-ons, VAT treatment and the panel links. Needs the billing:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "billing_summary",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Billing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Sites

Every site type: list, search, create, change, delete; status, nameservers, CDN, SEO.

sites_create

Create a site (any type) · write · permission sites:write · REST equivalent POST /sites

Creates a site exactly as the Add new site form does - same validation, same slot limit, same checks - for every type: WordPress, Static HTML, PHP hosting, Joomla, Drupal, PrestaShop, OpenCart, Grav and MediaWiki. A WordPress site also needs title, subtitle, login_url and feedback_email; no other type does, and the create options list exactly what each type requires. Installation runs in the background as a job; once installed, the domain points at the site's nameservers.required. Needs the sites:write permission. Starts a job that finishes later: the answer carries job.id, and the job reads succeeded or failed when it is done.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_create",
    "arguments": {
      "type": "Wordpress",
      "name": "myblog",
      "domain": "myblog-example.com",
      "cdn": "Cloudflare",
      "use_https": true,
      "title": "My blog",
      "subtitle": "Notes from the workshop",
      "admin_email": "[email protected]",
      "feedback_email": "[email protected]"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_create_options

Fields and choices for a new site · read-only · permission sites:write · REST equivalent GET /sites/options

The fields the Create site form accepts for this account right now, with their choices (site types, CDNs, PHP versions, templates, blueprints, groups...) and defaults. Every field name here is accepted when creating a site (unknown ones go in form_fields). required is the answer FOR THE TYPE in the response's type - a WordPress site also needs title, subtitle, login_url and feedback_email, no other type does. required_for_types on each field and the required_by_type map give the whole picture in one call. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_create_options",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_delete

Delete a site · destructive · permission sites:delete · REST equivalent DELETE /sites/{site_id}

Deletes the site for good (files, database, DNS zone, CDN), exactly like Delete site in the panel. It ALSO deletes the email of the site's domain on our mail service - every mailbox and forwarder and all their mail - when it has any; the response states it in email_deleted and warning. Refused while the site is busy or paused for non-payment/malware, while it has subdomain sites, or while a blueprint is being made from it. Runs in the background: a job is returned. Needs the sites:delete permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_delete",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_edit_options

Fields and choices to edit a site · read-only · permission sites:write · REST equivalent GET /sites/{site_id}/options

The fields the Edit site form offers for THIS site right now (they depend on type, CDN and state), with choices and current values. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_edit_options",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_get

Get one site · read-only · permission sites:read · REST equivalent GET /sites/{site_id}

Everything the site page shows: state, URL, settings, why it is paused (freeze.reasons), nameserver status (current vs required, pointed, autopilot), CDN, SEO, indexation, platform, online status and what can be done with it right now (capabilities). Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_get",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_list

List and search sites · read-only · permission sites:read · REST equivalent GET /sites

The same search, filters and order as the sites list in the panel. total is the number of matching sites. A key restricted to some sites only sees those. Needs the sites:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_list",
    "arguments": {
      "search": "blog",
      "state": "ok",
      "limit": 20
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_malware

Malware scan results · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/malware

What the nightly malware scan (and any "scan again") found on this site, in the same words as the site's Malware scan tab: open findings, files in quarantine, and the date the site would be paused if the findings stay. Files identical to the official published copies are never listed. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_malware",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_malware_rescan

Scan the site again · write · permission sites:write · REST equivalent POST /sites/{site_id}/malware/rescan

Starts a malware scan of this site now (usually one to five minutes); the site's malware report shows it as last_rescan. One scan per site at a time, ten per account an hour. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_malware_rescan",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_update

Change site settings · write · permission sites:write · REST equivalent PATCH /sites/{site_id}

Change any setting the Edit site form offers: name, domain, PHP version, HTTPS, www, group, admin e-mail, login URL, auto-updates, mailbox. Only the fields sent change. Changes that touch the server (domain, PHP, HTTPS/www) run in the background: a job is returned then. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_update",
    "arguments": {
      "site_id": 123,
      "php_version": "PHP 8.3",
      "use_www": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Sites. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Site tools

Cache purge, one-click admin login, reinstall, health checks, Site Cleaner, usage.

cleaner_get

Site Cleaner status · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/cleaner

Site Cleaner for this site: whether the add-on is active, the last scan (what can be removed and how much it saves), the running job, recent jobs (with undo_available) and the schedule. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cleaner_get",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

cleaner_run

Scan, clean or undo · write · permission sites:write · REST equivalent POST /sites/{site_id}/cleaner/{action}

Runs Site Cleaner. scan lists unused plugins/themes, junk files and database clutter (free). clean removes the selected items after taking a backup and checks the site afterwards - it needs the Site Cleaner add-on (402 addon_required otherwise). undo puts a clean back from its backup. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cleaner_run",
    "arguments": {
      "site_id": 123,
      "action": "scan"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

cleaner_schedule

Automatic cleaning · write · permission sites:write · REST equivalent PUT /sites/{site_id}/cleaner/schedule

Sets automatic cleaning for the site (needs the add-on to actually clean). Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cleaner_schedule",
    "arguments": {
      "site_id": 123,
      "schedule": "weekly"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

health_get

Health status · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/health

The online badge (online / offline / slow / paused... with the reason) and, for application sites, the last integrity check (V1 config lines, admin account, login health, core files). Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "health_get",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

health_integrity_check

Integrity check now · write · permission sites:write · REST equivalent POST /sites/{site_id}/health/integrity-check

Checks the application now (WordPress, Joomla, Drupal, PrestaShop, OpenCart, Grav, MediaWiki): V1's config lines, the site URL, the admin account, one-click login health and core file checksums. Changes nothing. Takes a few seconds. Needs the sites:write permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "health_integrity_check",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

health_recheck

Re-check if the site is up · write · permission sites:write · REST equivalent POST /sites/{site_id}/health/recheck

Probes the home page again now (same probe and recording as the platform's monitor) and asks the server why if it fails. Asynchronous: follow the job; its result has the outcome. At most 10 an hour. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "health_recheck",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

health_repair

Repair the site · write · permission sites:write · REST equivalent POST /sites/{site_id}/health/repair

"Repair site": checks, repairs everything repairable (backups first, on the server), checks again. You get an e-mail listing what was repaired. Needs the sites:write permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "health_repair",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_admin_login

One-click admin login link · write · permission sites:login · REST equivalent POST /sites/{site_id}/admin-login

A single-use login link to the site's admin (WordPress wp-admin, Joomla, Drupal, PrestaShop, OpenCart, Grav, MediaWiki), valid for 60 seconds - the panel's one-click login, for a browser, not for storing. Not for Static HTML / PHP hosting sites. Needs the sites:login permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_admin_login",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_php_version

Change the PHP version · write · permission sites:write · REST equivalent PUT /sites/{site_id}/php-version

Changes only the site's PHP version. The web server is reconfigured in the background (a job is returned). Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_php_version",
    "arguments": {
      "site_id": 123,
      "php_version": "PHP 8.3"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_purge_cache

Purge the CDN cache · write · permission sites:write · REST equivalent POST /sites/{site_id}/purge-cache

Clears the CDN cache of both hostnames (as Purge CDN cache in the panel). The site must be live. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_purge_cache",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_reinstall

Reinstall from scratch · destructive · permission sites:write · REST equivalent POST /sites/{site_id}/reinstall

Installs the site again from scratch (as Reinstall in the panel) - the current files and database are replaced. Refused while the site is busy, switched off or being deleted. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_reinstall",
    "arguments": {
      "site_id": 123,
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_temp_unfreeze

Switch a paused site on for cleanup · write · permission sites:write · REST equivalent POST /sites/{site_id}/temporary-unfreeze

A site paused ONLY for a usage limit (disk / database / files) comes back for 30 minutes so you can clean it up (3 times per site per day). At the end it is paused again only if still over the limit. The site's freeze.temporary_unfreeze says if it is available and why not. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_temp_unfreeze",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_usage

Disk, database and file usage · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/usage

The Usage & add-ons tab: disk, database and file-count use against the limits (plan + add-ons), what is over, CDN bandwidth for metered CDNs, and the add-ons on the site. Numbers are measured every few hours, or on demand. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_usage",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_usage_refresh

Measure usage now · write · permission sites:write · REST equivalent POST /sites/{site_id}/usage/refresh

Starts a fresh measurement of disk, database and files (the usage tab's "Check now"). Returns the current figures with busy=true; the site's usage reads busy=false again when it is done (seconds). Same throttles as the panel: one measurement per site every few minutes. Needs the sites:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_usage_refresh",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site tools. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

DNS records

The site's own DNS records (A, AAAA, CNAME, TXT, MX, SRV, CAA, NS).

dns_check_now

Check a waiting site's nameservers now · write · permission dns:write · REST equivalent POST /sites/{site_id}/check-dns-now

The site page's "Check again now" button, for a site that is waiting for its nameservers or finishing its CDN: reads the nameservers the registry really publishes for the domain, compares them with the ones the site needs, looks for an old DNSSEC record left at the registrar, and when everything is right starts the go-live step at once. status is one of not_pointed, dnssec, going_live, finishing, live, unknown. Once per 5 minutes per site. Needs the dns:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dns_check_now",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

dns_create

Add a DNS record · write · permission dns:write · REST equivalent POST /sites/{site_id}/dns

Adds a record with the panel's own validation. It is published to the site's DNS provider within a minute or two (follow the job); your records are never overwritten by the platform. Needs the dns:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dns_create",
    "arguments": {
      "site_id": 123,
      "type": "TXT",
      "name": "@",
      "value": "google-site-verification=abc123"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

dns_delete

Delete a DNS record · destructive · permission dns:write · REST equivalent DELETE /sites/{site_id}/dns/{record_id}

Deletes a record; it is removed at the DNS provider within a minute or two. Needs the dns:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dns_delete",
    "arguments": {
      "site_id": 123,
      "record_id": 5501
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

dns_list

List DNS records · read-only · permission dns:read · REST equivalent GET /sites/{site_id}/dns

The site's own DNS records (the DNS records tab), and the publishing state: the DNS provider, when the records were last published and any record the provider refused (with its error). Records the platform manages for the CDN are not listed and are never changed through this API. Needs the dns:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dns_list",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

dns_update

Change a DNS record · destructive · permission dns:write · REST equivalent PATCH /sites/{site_id}/dns/{record_id}

Changes a record; send only the fields that change. Needs the dns:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dns_update",
    "arguments": {
      "site_id": 123,
      "record_id": 5501,
      "value": "google-site-verification=xyz789"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_nameservers

Nameserver status · read-only · permission dns:read · REST equivalent GET /sites/{site_id}/nameservers

The nameservers the domain must use (required), what it uses now (current, checked daily), whether it is pointed, whether the DNS zone expired at the provider (zone_expired: re-create it from the site page), and the registrar autopilot status when a registrar connection sets them for you. Needs the dns:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_nameservers",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in DNS records. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Backups

List, create, download and restore backups.

backups_create

Create a backup now · write · permission backups:write · REST equivalent POST /sites/{site_id}/backups

Takes a full backup (files + database) now, as Create backup in the panel. A job is returned; the backup reads Ok when it is done. Needs the backups:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_create",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backups_delete

Delete a backup · destructive · permission backups:write · REST equivalent DELETE /sites/{site_id}/backups/{backup_id}

Deletes a backup. A backup that a blueprint uses cannot be deleted. Needs the backups:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_delete",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backups_download

Download link · read-only · permission backups:read · REST equivalent POST /sites/{site_id}/backups/{backup_id}/download-link

A temporary link to download the backup archive (tar.gz) - valid about 4 hours. Needs the backups:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_download",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backups_get

Get one backup · read-only · permission backups:read · REST equivalent GET /sites/{site_id}/backups/{backup_id}

One backup of the site. Needs the backups:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_get",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backups_list

List backups · read-only · permission backups:read · REST equivalent GET /sites/{site_id}/backups

The site's backups, newest first (automatic daily ones, manual ones and uploaded ones). Needs the backups:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_list",
    "arguments": {
      "site_id": 123,
      "limit": 10
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backups_restore

Restore a backup · destructive · permission backups:write · REST equivalent POST /sites/{site_id}/backups/{backup_id}/restore

Replaces the site's files and database with the backup (as Restore in the panel). Refused while the site is busy, switched off or the plan has expired. A job is returned. Needs the backups:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backups_restore",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001,
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Files

Browse, read, upload, rename and delete the files of a site.

files_delete

Delete a file or folder · destructive · permission files:write · REST equivalent DELETE /sites/{site_id}/files

Deletes a file, or a folder (with recursive=true when it is not empty). There is no undo - take a backup first for anything important. Needs the files:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_delete",
    "arguments": {
      "site_id": 123,
      "path": "hello.txt"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_list

List a folder · read-only · permission files:read · REST equivalent GET /sites/{site_id}/files

Folders first, then files; up to 5,000 entries. Symbolic links are listed (type "link") but never followed. Available under the same rule as the File Manager: the site is installed, the plan is active and the site is not suspended. Needs the files:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_list",
    "arguments": {
      "site_id": 123,
      "path": "wp-content"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_mkdir

Create a folder · write · permission files:write · REST equivalent POST /sites/{site_id}/files/folders

Creates a folder (and any missing parent folders). Needs the files:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_mkdir",
    "arguments": {
      "site_id": 123,
      "path": "wp-content/uploads/reports"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_move

Rename or move · write · permission files:write · REST equivalent POST /sites/{site_id}/files/move

Renames or moves a file or folder inside the site folder. Needs the files:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_move",
    "arguments": {
      "site_id": 123,
      "path": "hello.txt",
      "to": "old/hello.txt"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_read

Read (download) a file · read-only · permission files:read · REST equivalent GET /sites/{site_id}/files/content

Returns a file of up to 5 MB (the account's limits give the exact size). encoding=raw streams the bytes directly. Needs the files:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_read",
    "arguments": {
      "site_id": 123,
      "path": "robots.txt",
      "encoding": "text"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_stat

File or folder details · read-only · permission files:read · REST equivalent GET /sites/{site_id}/files/stat

Type, size, modification time and mode of one path. Needs the files:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_stat",
    "arguments": {
      "site_id": 123,
      "path": "index.php"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_write

Upload (write) a file · write · permission files:write · REST equivalent PUT /sites/{site_id}/files/content

Writes a file of up to 25 MB atomically (a temporary file renamed into place), owned by the site's web server user. Refuses to write through symbolic links and into folders the platform manages. Needs the files:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_write",
    "arguments": {
      "site_id": 123,
      "path": "hello.txt",
      "overwrite": "true",
      "content": "Hello world\n"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Files. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Logs

Error log and access log of a site.

logs_access

Access log · read-only · permission logs:read · REST equivalent GET /sites/{site_id}/logs/access

Requests that reached the web server for this site's hostnames, newest last. The client IP is the visitor as the CDN reported it. 30 fetches per 10 minutes per account. Needs the logs:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "logs_access",
    "arguments": {
      "site_id": 123,
      "hours": 1,
      "lines": 100
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Logs. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

logs_errors

Error log · read-only · permission logs:read · REST equivalent GET /sites/{site_id}/logs/errors

Recent PHP and web server errors of THIS site (the Error log tab): last 7 days, grouped, sanitised (paths shown relative to the site folder, secrets hidden). php_hint=true when the errors look like code written for an older PHP version. Cached 60 s; 20 fetches per 10 minutes per account. Needs the logs:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "logs_errors",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Logs. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Support tickets

Open support tickets and reply to them.

tickets_create

Open a ticket · write · permission tickets:write · REST equivalent POST /tickets

Opens a ticket (support is e-mailed as for a panel ticket). The ticket limits apply: at most 2 open tickets at a time (409 ticket_limit). Needs the tickets:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tickets_create",
    "arguments": {
      "title": "Question about my site",
      "message": "How do I add a subdomain?",
      "queue": "general-support-request",
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Support tickets. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

tickets_get

Read a ticket · read-only · permission tickets:read · REST equivalent GET /tickets/{ticket_id}

A ticket with every public message (yours and support's). can_reply says if you may add a message now (ticket limits: one message before support answers). Needs the tickets:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tickets_get",
    "arguments": {
      "ticket_id": 4412
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Support tickets. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

tickets_list

List tickets · read-only · permission tickets:read · REST equivalent GET /tickets

Your tickets, newest first. Needs the tickets:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tickets_list",
    "arguments": {
      "status": "open"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Support tickets. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

tickets_queues

Ticket categories · read-only · permission tickets:read · REST equivalent GET /tickets/queues

The categories (queues) a ticket can be opened in. Needs the tickets:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tickets_queues",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Support tickets. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

tickets_reply

Reply to a ticket · write · permission tickets:write · REST equivalent POST /tickets/{ticket_id}/messages

Adds your message to the ticket (support is notified). One message until support answers. Needs the tickets:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "tickets_reply",
    "arguments": {
      "ticket_id": 4412,
      "message": "Thanks, that worked."
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Support tickets. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Knowledge base

Search the knowledge base.

kb_article

Read an article · read-only · permission kb:read · REST equivalent GET /kb/articles/{slug}

One article as plain text and as sanitised HTML, with related articles. Needs the kb:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "kb_article",
    "arguments": {
      "slug": "change-nameservers"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Knowledge base. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

kb_search

Search the knowledge base · read-only · permission kb:read · REST equivalent GET /kb/search

The dashboard's knowledge-base search (keyword + meaning). Every key may use it. Needs the kb:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "kb_search",
    "arguments": {
      "q": "change nameservers"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Knowledge base. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_kb_suggestions

Help articles for this site · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/help

Knowledge-base articles that fit what is going on with this site right now (why it is paused, nameservers not pointed, offline...), with app and public links. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_kb_suggestions",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Knowledge base. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Jobs

Progress of the long-running actions the API started.

jobs_get

Job status · read-only · permission account:read · REST equivalent GET /jobs/{job_id}

The live status of a job: running, succeeded or failed, with a message. Each read counts against the rate limit like any call. Needs the account:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "jobs_get",
    "arguments": {
      "job_id": "job_4f1c0a9e2b7d6c5a3e10"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Jobs. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

jobs_list

List jobs · read-only · permission account:read · REST equivalent GET /jobs

Jobs the API started for this account, newest first. Needs the account:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "jobs_list",
    "arguments": {
      "status": "running"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Jobs. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

jobs_wait

Wait for a job to finish · read-only · permission account:read · REST equivalent GET /jobs/{job_id}, polled until it finishes

Waits for a job (site create, backup, restore, delete, reinstall, DNS publish) and returns it once it has succeeded or failed, or when the wait runs out. Needs the account:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "jobs_wait",
    "arguments": {
      "job_id": "job_4f1c0a9e2b7d6c5a3e10",
      "timeout_seconds": 120
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Jobs. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Content and publishing

Posts, pages, pictures and the AI auto-posting campaigns, on every site type.

autopost_article_action

An article's buttons · write · permission content:write · REST equivalent POST /autopost/articles/{article_id}/{action}

The same buttons as an article's page. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_article_action",
    "arguments": {
      "article_id": "article_id",
      "action": "scan"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_campaign_create

Create a campaign · write · permission content:write · REST equivalent POST /campaigns

Creates an auto-posting campaign exactly as the New campaign page does (same fields, same checks). It writes with one of your AI keys, so add a key on the AI keys page first. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_campaign_create",
    "arguments": {
      "campaign": "<campaign>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_campaign_delete

Delete a campaign · destructive · permission content:write · REST equivalent DELETE /campaigns/{campaign_id}

Deletes the campaign. Articles not written yet are cancelled; articles already published stay on your sites. Needs the content:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_campaign_delete",
    "arguments": {
      "campaign_id": 44,
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_campaign_form

The fields of a campaign · read-only · permission content:read · REST equivalent GET /autopost/campaign-fields

Every field a campaign takes when it is created or changed, from the page's own form: label, whether it is required, the allowed values and the help text. site_ids are your site ids, text_connection / image_connection are AI key ids and text_model / image_model are model ids. Needs the content:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_campaign_form",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_campaign_update

Change a campaign · write · permission content:write · REST equivalent PATCH /campaigns/{campaign_id}

Changes only the fields you send (the rest stay as they are), with the Edit campaign page's checks. Sending site_ids replaces the campaign's sites. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_campaign_update",
    "arguments": {
      "campaign_id": 44,
      "campaign": "<campaign>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_key_delete

Remove an AI key · destructive · permission content:write · REST equivalent DELETE /autopost/keys/{key_id}

Removes the key from your account (nothing changes at the provider). Campaigns using it are paused until you choose another key. Needs the content:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_key_delete",
    "arguments": {
      "key_id": "key_id",
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_key_test

Test an AI key · write · permission content:write · REST equivalent POST /autopost/keys/{key_id}/test

Asks the provider whether the key works (the page's Test button). A key that works again resumes the campaigns that were paused because of it. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_key_test",
    "arguments": {
      "key_id": "key_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_keys

Your AI keys · read-only · permission content:read · REST equivalent GET /autopost/keys

The keys to your own AI accounts that campaigns write with: provider, whether the last test worked and how many campaigns use each. The key itself is never returned, and a key is only ever added on the AI keys page (https://app.pbn.ltd/autopost/keys/). Needs the content:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_keys",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_models

AI models a campaign can use · read-only · permission content:read · REST equivalent GET /autopost/models

The text and picture models on offer. A campaign's model must belong to the provider of the key it writes with. Needs the content:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_models",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

autopost_overview

AI auto posting: overview · read-only · permission content:read · REST equivalent GET /autopost

Whether auto posting is available on the account (and why not), how many campaigns and AI keys it has and how many articles are in each state. Needs the content:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "autopost_overview",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

campaigns_get

Read one campaign · read-only · permission content:read · REST equivalent GET /campaigns/{campaign_id}

One campaign with its last ten runs. Needs the content:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "campaigns_get",
    "arguments": {
      "campaign_id": 44
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

campaigns_list

List auto-posting campaigns · read-only · permission content:read · REST equivalent GET /campaigns

The AI auto-posting campaigns on the account: what they write, when they run next and how many articles they have made. Needs the content:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "campaigns_list",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

campaigns_status

Pause or resume · write · permission content:write · REST equivalent PUT /campaigns/{campaign_id}/status

Pauses a campaign or starts it again. A campaign paused by our staff or by a problem with an AI key cannot be resumed from here - fix the cause first. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "campaigns_status",
    "arguments": {
      "campaign_id": 44,
      "status": "paused"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

campaigns_write_now

Write one now · write · permission content:write · REST equivalent POST /campaigns/{campaign_id}/write-now

Asks a campaign to write and publish now, the same as the "Write now" button. Returns the run. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "campaigns_write_now",
    "arguments": {
      "campaign_id": 44,
      "count": 1
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_create

Publish a post or page · write · permission content:write · REST equivalent POST /sites/{site_id}/content

Writes the post and puts it on the site. Works for every site type: WordPress, Joomla, Drupal, PrestaShop, OpenCart, Grav and MediaWiki get a native post/article/page, and Static HTML and PHP hosting sites get a page built in the look of their own pages, with a blog index and sitemap.xml kept up to date. The answer carries a job; the finished post has its address. Needs the content:write permission. Starts a job that finishes later: the answer carries job.id, and the job reads succeeded or failed when it is done.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_create",
    "arguments": {
      "site_id": 123,
      "title": "Five ways to speed up your shop",
      "body_markdown": "## Why speed matters\n\nA faster shop sells more.",
      "status": "publish",
      "tags": [
        "speed",
        "shop"
      ]
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_get

Read one post · read-only · permission content:read · REST equivalent GET /sites/{site_id}/content/{post_id}

One post in full, with its text and the history of what happened to it. Needs the content:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_get",
    "arguments": {
      "site_id": 123,
      "post_id": 90210
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_list

Posts on this site · read-only · permission content:read · REST equivalent GET /sites/{site_id}/content

The latest posts the site itself reports, and every post this account has written for it through PBN.LTD (including ones still being written or waiting to go out). Needs the content:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_list",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_media

Upload a picture or file · write · permission content:write · REST equivalent POST /sites/{site_id}/content/media

Puts a picture or file on the site and gives back the address to use in a post. On WordPress it goes into the media library; on every other site type it goes into the site's own files. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_media",
    "arguments": {
      "site_id": 123,
      "name": "hero.jpg",
      "content_base64": "iVBORw0KGgo=",
      "alt": "The shop front"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_options

What a post on this site can have · read-only · permission content:read · REST equivalent GET /sites/{site_id}/content/options

Before writing anything, ask this: it says how a post appears on this site type, which fields it supports (featured picture, categories, tags, author, drafts) and the real categories and authors the site has. Site types with no drafts publish straight away - the answer says so. Needs the content:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_options",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_queue

Everything being written or published · read-only · permission content:read · REST equivalent GET /content/queue

Every post on the account that is queued, being written, waiting for approval, scheduled, publishing, published, failed or cancelled - newest first, across all sites. Needs the content:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_queue",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_remove

Take a post off the site · destructive · permission content:write · REST equivalent DELETE /sites/{site_id}/content/{post_id}

Removes a published post from the site, or cancels one that has not gone out yet. There is no undo. Needs the content:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_remove",
    "arguments": {
      "site_id": 123,
      "post_id": 90210
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

content_update

Change a post · write · permission content:write · REST equivalent PATCH /sites/{site_id}/content/{post_id}

Changes a post that has not gone out yet. A post that is already on the site cannot be edited from here - remove it and write a new one. Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "content_update",
    "arguments": {
      "site_id": 123,
      "post_id": 90210,
      "title": "Five ways to speed up your shop (updated)"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

runs_get

How a run is going · read-only · permission content:read · REST equivalent GET /runs/{run_id}

One run of a campaign and every article in it. Needs the content:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "runs_get",
    "arguments": {
      "run_id": 7782
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Content and publishing. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Building, plugins and themes

Upload a built site, set the home page, install and test plugins and themes, and the sites you publish to other hosts.

code_check

Check PHP code for errors · read-only · permission sites:read · REST equivalent POST /sites/{site_id}/code-check

Runs PHP's own syntax check over a file or every .php file in a folder, in the exact PHP version the site runs. Do this before switching a plugin or theme on - a syntax error there takes the whole site down. Needs the sites:read permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "code_check",
    "arguments": {
      "site_id": 123,
      "path": "wp-content/plugins/my-plugin"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extdeploy_connection_remove

Disconnect a hosting account · destructive · permission extdeploy:write · REST equivalent DELETE /external-connections/{connection_id}

Forgets the account's credentials here. Nothing is changed at the provider. Refused while sites still publish through it. Needs the extdeploy:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extdeploy_connection_remove",
    "arguments": {
      "connection_id": "connection_id",
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extdeploy_connection_test

Test a connected account · write · permission extdeploy:write · REST equivalent POST /external-connections/{connection_id}/test

Asks the provider whether the stored credentials still work (the page's Test button). Needs the extdeploy:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extdeploy_connection_test",
    "arguments": {
      "connection_id": "connection_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extdeploy_connections

Your connected hosting accounts · read-only · permission extdeploy:read · REST equivalent GET /external-connections

The accounts at GitHub, GitLab, Cloudflare, Netlify, Vercel, Render, AWS or Azure you have connected, and whether each still works. The credentials are never returned; connecting an account is done on the connections page (https://app.pbn.ltd/extdeploy/connections). Needs the extdeploy:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extdeploy_connections",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_deploy

Deploy again or roll back · destructive · permission sites:write · REST equivalent POST /external-sites/{ext_site_id}/deploy

Publishes the site to its provider again, or rolls it back to a deploy that is already there. This replaces what is live at that provider. No files travel through this call: it publishes the files the PBN.LTD site already has. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_deploy",
    "arguments": {
      "ext_site_id": 9,
      "kind": "redeploy"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_domain_add

Attach a custom domain · write · permission extdeploy:write · REST equivalent POST /external-sites/{ext_site_id}/domains

Attaches the domain at the provider and returns the DNS records to publish wherever that domain's DNS is answered. Needs the extdeploy:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_domain_add",
    "arguments": {
      "ext_site_id": 9,
      "hostname": "<hostname>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_domain_refresh

Check a custom domain again · write · permission extdeploy:write · REST equivalent POST /external-sites/{ext_site_id}/domains/{domain_id}/refresh

Asks the provider again whether the domain's DNS and certificate are in place. Needs the extdeploy:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_domain_refresh",
    "arguments": {
      "ext_site_id": 9,
      "domain_id": "domain_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_domain_remove

Detach a custom domain · destructive · permission extdeploy:write · REST equivalent DELETE /external-sites/{ext_site_id}/domains/{domain_id}

Detaches the domain at the provider (its DNS records are yours to remove). Needs the extdeploy:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_domain_remove",
    "arguments": {
      "ext_site_id": 9,
      "domain_id": "domain_id",
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_get

One external site · read-only · permission extdeploy:read · REST equivalent GET /external-sites/{ext_site_id}

One site on a third-party host, as its page shows it: state, address, source, build settings, what its provider supports (can), its custom domains with the DNS records each needs, and the recent deploys. Needs the extdeploy:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_get",
    "arguments": {
      "ext_site_id": 9
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_history

Deploys of an external site · read-only · permission sites:read · REST equivalent GET /external-sites/{ext_site_id}/deployments

The recent deploys of one external site, newest first - what to pass to a rollback. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_history",
    "arguments": {
      "ext_site_id": 9
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_list

Sites on third-party hosts · read-only · permission sites:read · REST equivalent GET /external-sites

The sites this account publishes to outside PBN.LTD (GitHub Pages, Cloudflare Pages, Netlify, Vercel and the rest), with their address and the state of the last deploy. Connecting a provider and adding a site stay in the panel, because they need your own provider credentials. Needs the sites:read permission. Paginated: the answer's next_cursor is the cursor of the next page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_list",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_log

The log of one deploy · read-only · permission extdeploy:read · REST equivalent GET /external-sites/deployments/{deployment_id}/log

What happened during one deploy, line by line (the page's "Log"). Needs the extdeploy:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_log",
    "arguments": {
      "deployment_id": "deployment_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

extsites_remove

Remove an external site · destructive · permission extdeploy:write · REST equivalent DELETE /external-sites/{ext_site_id}

Stops managing the site here. With delete_remote the project is deleted at the provider too, and whatever it serves goes offline. Needs the extdeploy:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "extsites_remove",
    "arguments": {
      "ext_site_id": 9,
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

files_upload_archive

Upload a built site (zip) · write · permission files:write · REST equivalent POST /sites/{site_id}/files/archive

Unpacks a zip of a built website (or a plugin or theme) into the site. Every file goes through the same path a single upload uses, so the same rules hold for each one: inside the site folder only, symbolic links are never followed and the platform's own folders are refused. Up to 60 files and 25 MB in one call - send a bigger site in parts. Needs the files:write permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "files_upload_archive",
    "arguments": {
      "site_id": 123,
      "zip_base64": "UEsDBAoAAAAAA...",
      "path": "",
      "strip_top_folder": true,
      "overwrite": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

plugins_delete

Remove a plugin · destructive · permission sites:write · REST equivalent DELETE /sites/{site_id}/plugins/{slug}

Switches a plugin off and deletes its files. There is no undo; the plugin's own data in the database is removed the way the plugin asks for. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "plugins_delete",
    "arguments": {
      "site_id": 123,
      "slug": "my-plugin"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

plugins_install

Install a plugin · destructive · permission sites:write · REST equivalent POST /sites/{site_id}/plugins

Installs a plugin on a WordPress site, from wordpress.org or from a zip you send. A plugin that is on our blocked list is refused. Activating a plugin can break a site, so installing and activating are separate steps. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "plugins_install",
    "arguments": {
      "site_id": 123,
      "slug": "classic-editor",
      "activate": false
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

plugins_list

Plugins on this site · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/plugins

Every plugin installed on a WordPress site, whether it is active, its version and whether an update is waiting. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "plugins_list",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

plugins_state

Switch a plugin on or off · destructive · permission sites:write · REST equivalent POST /sites/{site_id}/plugins/{slug}/{action}

Activates or deactivates a plugin. Activating can take a site down; deactivating is how you put it back. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "plugins_state",
    "arguments": {
      "site_id": 123,
      "slug": "my-plugin",
      "action": "activate"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_set_home

Set the home page · destructive · permission sites:write · REST equivalent POST /sites/{site_id}/home-page

Makes a page the front page of the site. On WordPress this sets the site's own "front page" setting; on the other site types the file you name is copied over index.html (or index.php), which replaces what is there now. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_set_home",
    "arguments": {
      "site_id": 123,
      "page": "home.html"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

sites_verify

Fetch a page and check it · read-only · permission sites:read · REST equivalent POST /sites/{site_id}/verify

Fetches a page of the site and says exactly what came back: the HTTP status, how long it took, its size, its title and any redirect. The page is always fetched on the site's own server (so it works even before the domain points at us) and, when the address allows it, from the internet as well. The newest PHP errors are read at the same time. This is the honest test after changing anything - a plugin, a theme, a file or a setting. Needs the sites:read permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "sites_verify",
    "arguments": {
      "site_id": 123,
      "path": "/"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

themes_activate

Use this theme · destructive · permission sites:write · REST equivalent POST /sites/{site_id}/themes/{slug}/activate

Switches the site to another theme. This changes how every page looks at once; switching back undoes it. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "themes_activate",
    "arguments": {
      "site_id": 123,
      "slug": "twentytwentyfive"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

themes_list

Themes on this site · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/themes

Every theme on a WordPress site and which one is in use. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "themes_list",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Building, plugins and themes. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

SEO metrics and backlinks

The SEO figures measured for each site, and the backlink tracker with its bulk link editor.

backlinks_tracker_get

Every link to one domain · read-only · permission sites:read · REST equivalent GET /backlink-tracker/{domain_id}

One backlink domain: each distinct link to it (address + text) with how many times, posts and sites carry it, and which of your sites each address is found on. A link id is what the link editor endpoints take. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backlinks_tracker_get",
    "arguments": {
      "domain_id": "domain_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in SEO metrics and backlinks. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backlinks_tracker_link_change

Change a link everywhere · write · permission content:write · REST equivalent PATCH /backlink-tracker/links/{anchor_id}

The bulk link editor's "Edit": the link is searched and replaced in the posts of every site that carries it (one job per site, in each site's operations log). Needs the content:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backlinks_tracker_link_change",
    "arguments": {
      "anchor_id": "anchor_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in SEO metrics and backlinks. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backlinks_tracker_link_remove

Remove a link everywhere · destructive · permission content:write · REST equivalent DELETE /backlink-tracker/links/{anchor_id}

The bulk link editor's "Delete": the whole link, its text too, is removed from the posts of every site that carries it (one job per site). It cannot be undone except from a backup. Needs the content:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backlinks_tracker_link_remove",
    "arguments": {
      "anchor_id": "anchor_id",
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in SEO metrics and backlinks. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

backlinks_tracker_list

Domains your posts link to · read-only · permission sites:read · REST equivalent GET /backlink-tracker

The backlink tracker: every domain the posts on your sites link to, with how many links, posts and sites carry them (your_site_id when the domain is one of your own sites). Needs the sites:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "backlinks_tracker_list",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in SEO metrics and backlinks. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

seo_metrics_site

SEO metrics history of a site · read-only · permission sites:read · REST equivalent GET /sites/{site_id}/seo-metrics

The same figures as the site's SEO metrics charts tab: Trust Flow, Citation Flow, backlinks and referring domains at every reading, with the change since the reading before. latest is null until the first reading. Needs the sites:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "seo_metrics_site",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in SEO metrics and backlinks. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Registrar connections

Connect your domain registrar accounts so we set your sites' nameservers for you: connections, automatic updates, per-site status and history.

registrars_automatic

Automatic nameserver updates on or off · write · permission registrars:write · REST equivalent POST /registrars/connections/{connection_id}/automatic

Switches automatic nameserver updates for this connection on or off (the page's toggle, but with an explicit value, so repeating the call is safe). Needs the registrars:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_automatic",
    "arguments": {
      "connection_id": "connection_id",
      "enabled": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_connect

Connect a registrar account · write · permission registrars:write · REST equivalent POST /registrars/connections

Checks the key with the registrar FIRST and only saves a working account (same as the Registrar connections page). We then read the domain list; sites waiting for nameservers on those domains are updated automatically within a minute or two. Some registrars need our IP addresses on an allow-list first. Needs the registrars:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_connect",
    "arguments": {
      "registrar": "<registrar>",
      "secret_credentials": "<secret_credentials>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_disconnect

Disconnect a registrar account · destructive · permission registrars:write · REST equivalent DELETE /registrars/connections/{connection_id}

Deletes the connection and its stored keys (the nameserver update history is kept). Nothing changes at the registrar. Needs "confirm": true. Needs the registrars:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_disconnect",
    "arguments": {
      "connection_id": "connection_id",
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_domain_check

Will this domain get its nameservers set for me? · read-only · permission registrars:read · REST equivalent GET /registrars/domain-check

The question the add-a-site form asks while you type: is this domain in one of your connected accounts (or registered with Zinn Digital), so we point it at the site ourselves? Needs the registrars:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_domain_check",
    "arguments": {
      "domain": "<domain>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_get

One registrar connection · read-only · permission registrars:read · REST equivalent GET /registrars/connections/{connection_id}

One connection, with the domain names we can see in that registrar account (up to 1,000). Needs the registrars:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_get",
    "arguments": {
      "connection_id": "connection_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_history

Nameserver update history · read-only · permission registrars:read · REST equivalent GET /registrars/history

Every nameserver change we made (or tried) at your registrars: what the registrar had before (the value to go back to), what we set, the result, and whether the domain registry already shows it. Needs the registrars:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_history",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_list

List registrar connections · read-only · permission registrars:read · REST equivalent GET /registrars/connections

Your connected registrar accounts: status, how many domains we can see in each, and whether automatic nameserver updates are on. The keys are never returned - only a masked hint such as "key …a1b2". Needs the registrars:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_list",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_providers

Registrars you can connect · read-only · permission registrars:read · REST equivalent GET /registrars/providers

Every registrar we can set nameservers at, with the steps to create an API key there, the IP addresses to allow (when the registrar needs an allow-list) and the fields to send in secret_credentials when you connect it. Needs the registrars:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_providers",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_refresh

Re-read the domain list · write · permission registrars:write · REST equivalent POST /registrars/connections/{connection_id}/refresh

Reads the domain list of this registrar account again (about a minute). Once every 2 minutes. Needs the registrars:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_refresh",
    "arguments": {
      "connection_id": "connection_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_site_status

Automatic nameservers for a site · read-only · permission registrars:read · REST equivalent GET /sites/{site_id}/registrar

What the site page says about automatic nameserver updates for this site: whether we set its nameservers for you, through which registrar, what happened last, and the nameservers it needs. Needs the registrars:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_site_status",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_site_update_ns

Set this site's nameservers at the registrar now · write · permission registrars:write · REST equivalent POST /sites/{site_id}/registrar/update-nameservers

The site page's "Update nameservers at my registrar" button: sets the nameservers this site needs at the registrar that holds its domain, now, and returns the history entry. "already" means the registrar already had them - the site goes live as soon as DNS catches up. Needs the registrars:write permission. This can take up to a minute.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_site_update_ns",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_test

Test a registrar connection · write · permission registrars:write · REST equivalent POST /registrars/connections/{connection_id}/test

Asks the registrar whether the stored key still works and records the answer on the connection. Needs the registrars:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_test",
    "arguments": {
      "connection_id": "connection_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

registrars_update_waiting

Set nameservers for every waiting site now · write · permission registrars:write · REST equivalent POST /registrars/update-waiting

Sets the nameservers now for every site waiting for DNS whose domain is in a connected account (the page's "update all" button). Paced to stay inside the registrars' limits, so large accounts take a few minutes; each change is recorded in the registrar history. Once every 15 minutes. Needs the registrars:write permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "registrars_update_waiting",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Registrar connections. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Site security

For sites on Cloudflare: "I'm Under Attack" mode, the site's own firewall rules and blocking AI crawlers.

security_bots

Change bot protection · write · permission security:write · REST equivalent PUT /sites/{site_id}/security/bots

The same as the two bot switches on the Security tab. The change is saved at once and applied at Cloudflare within a few minutes (status reads "applying", then "active"). Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_bots",
    "arguments": {
      "site_id": 123,
      "setting": "<setting>",
      "on": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_email_protection

Email address protection on or off · write · permission security:write · REST equivalent PUT /sites/{site_id}/security/email-protection

The CDN hides e-mail addresses on the site's pages from spam bots (on by default): each address becomes a /cdn-cgi/l/email-protection link plus a small script, which SEO crawlers can report as broken links. Switch it off (or on) for this site - the same switch as the Security tab. The choice is kept if the site's DNS zone is re-created or the site moves CDN and back. choice is null while the site uses the default. Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_email_protection",
    "arguments": {
      "site_id": 123,
      "on": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_get

Security settings of a site · read-only · permission security:read · REST equivalent GET /sites/{site_id}/security

The same as the site's Security tab: whether "I'm Under Attack" is on (and when it switches itself off), the site's firewall rules and rate-limiting rules with the Cloudflare plan's limits, bot protection (AI crawlers blocked, bot fight mode), and the fields, operators and actions a new rule may use. 409 for a site that is not on Cloudflare. Needs the security:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_get",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_rule_add

Add a firewall rule · write · permission security:write · REST equivalent POST /sites/{site_id}/security/rules

Adds a firewall rule (or a rate-limiting rule) to the site at Cloudflare, within the plan's limit. Returns every rule of the site. Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_rule_add",
    "arguments": {
      "site_id": 123,
      "rule": "<rule>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_rule_delete

Delete a firewall rule · destructive · permission security:write · REST equivalent DELETE /sites/{site_id}/security/rules/{rule_id}

Removes one rule from the site at Cloudflare. Needs the security:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_rule_delete",
    "arguments": {
      "site_id": 123,
      "rule_id": "rule_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_rule_state

Switch a rule on or off, or move it · write · permission security:write · REST equivalent POST /sites/{site_id}/security/rules/{rule_id}/{action}

Rules run in order: the first that matches decides. Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_rule_state",
    "arguments": {
      "site_id": 123,
      "rule_id": "rule_id",
      "action": "scan"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_rule_update

Change a firewall rule · write · permission security:write · REST equivalent PUT /sites/{site_id}/security/rules/{rule_id}

Replaces one rule (same shape as when adding it). Only rules made on this dashboard can be changed here. Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_rule_update",
    "arguments": {
      "site_id": 123,
      "rule_id": "rule_id",
      "rule": "<rule>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

security_under_attack

"I'm Under Attack" on or off · write · permission security:write · REST equivalent PUT /sites/{site_id}/security/under-attack

Every visitor gets a short browser check before the site loads while it is on - use it while the site is being hammered, then switch it off. Needs the security:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "security_under_attack",
    "arguments": {
      "site_id": 123,
      "on": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Site security. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Wayback restore

Rebuild a website from the public web archive: look a domain up, pick a day, see what would be rebuilt and order it with a restore credit.

wayback_archive

Days the archive holds · read-only · permission wayback:read · REST equivalent GET /wayback/archive/{domain}

The days the public web archive has a copy of the domain's home page on, as the calendar shows. The first look-up of a domain reads the archive in the background: state is "pending" - ask again in a minute until it reads "ready" (or "error", with the reason). Needs the wayback:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "wayback_archive",
    "arguments": {
      "domain": "domain"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Wayback restore. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

wayback_get

One restore · read-only · permission wayback:read · REST equivalent GET /wayback/restores/{restore_id}

One restore: its progress and, while it is "planned" (ready to order), a sample of the pages that would be rebuilt and your existing sites it could be restored into. Needs the wayback:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "wayback_get",
    "arguments": {
      "restore_id": "restore_id"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Wayback restore. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

wayback_order

Order a restore with a restore credit · write · permission wayback:write · REST equivalent POST /wayback/restores/{restore_id}/order

Uses ONE restore credit and starts the rebuild (restore credits are bought in packs on the Wayback page; paying one restore by card through FastSpring, PayPal or crypto is done there too). Restoring into an existing site replaces what it serves. Needs the wayback:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "wayback_order",
    "arguments": {
      "restore_id": "restore_id",
      "output": "<output>",
      "target": "<target>",
      "accept_terms": true,
      "ack_rights": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Wayback restore. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

wayback_start

Start a restore (free) · write · permission wayback:write · REST equivalent POST /wayback/restores

Reads that day's copy from the archive and works out what would be rebuilt. Nothing is charged: the restore waits at "planned" until you order it. Needs the wayback:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "wayback_start",
    "arguments": {
      "domain": "<domain>",
      "day": "<day>"
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Wayback restore. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

wayback_status

Wayback restore: credits, prices and restores · read-only · permission wayback:read · REST equivalent GET /wayback

Your restore credits, the price of a restore of each kind (what the page would charge, with your VAT), how many new sites your plan still has room for, and your restores, newest first. Needs the wayback:read permission.

Takes no arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "wayback_status",
    "arguments": {}
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Wayback restore. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Hourly backups

The hourly backups add-on of a site: its restore points, a backup now, rolling the site back to an hour, and downloading one.

hourly_backups_download_prepare

Prepare a download of a restore point · write · permission backups:read · REST equivalent POST /sites/{site_id}/hourly-backups/{backup_id}/download

Builds a .tar.gz of that restore point (files and database), as the tab's Download button. The site's hourly backups show the download as "ready" when it can be fetched. Kept for 24 hours. Needs the backups:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "hourly_backups_download_prepare",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Hourly backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

hourly_backups_get

Hourly backups of a site · read-only · permission backups:read · REST equivalent GET /sites/{site_id}/hourly-backups

The same as the hourly part of the site's Backups tab: whether hourly backups are on for this site (and paid until when), when the next one runs, every restore point kept, any roll-back in progress and the downloads being prepared. Switching the add-on on is a purchase made in the Backups tab (manage_url); it is never bought over the API. Needs the backups:read permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "hourly_backups_get",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Hourly backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

hourly_backups_now

Take an hourly backup now · write · permission backups:write · REST equivalent POST /sites/{site_id}/hourly-backups/now

Takes a restore point now, as the "Back up now" button (once per site every 10 minutes). It appears among the site's hourly backups within a minute or two. Needs the backups:write permission.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "hourly_backups_now",
    "arguments": {
      "site_id": 123
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Hourly backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

hourly_backups_restore

Roll the site back to a restore point · destructive · permission backups:write · REST equivalent POST /sites/{site_id}/hourly-backups/{backup_id}/restore

Rolls the site back to exactly how it was at that restore point, as the tab's "Restore this backup" dialog. A backup of how the site looks now is taken first. One roll-back per site at a time; you get an e-mail when it is done. Needs the backups:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "hourly_backups_restore",
    "arguments": {
      "site_id": 123,
      "backup_id": 88001,
      "confirm": true
    }
  }
}

The answer carries the same data as the REST call, as structuredContent, with an example of every field in Hourly backups. The exact JSON Schema the answer is validated against is the tool's own outputSchema in tools/list.

Mailboxes

Mailboxes on your sites' domains, aliases, forwarders, the catch-all and out-of-office replies. Passwords are never returned.

mail_alias_delete

Remove an alias, forwarder or the catch-all · destructive · permission mail:write · REST equivalent DELETE /sites/{site_id}/mail/aliases

Removes one alias, forwarder or the catch-all. No mailbox or mail is touched. Needs the mail:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.