account_limits
ChatGPTSite 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.
account_me
ChatGPTThe account and the key making the call. The cheapest call there is, which makes it a key test. Needs the account:read permission.
account_usage_refresh
ChatGPTStarts 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.
agency_add
ChatGPTAdds domains to your list; their first reading arrives within minutes. Adds as many as your plan has room for and says why each other one was skipped. Nothing is spent on a refusal. Needs the agency:write permission.
agency_delete
ChatGPTRemoves the domain from your list. Needs the agency:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
agency_get
ChatGPTOne domain with the history of its weekly readings (newest first, up to two years). Needs the agency:read permission.
agency_list
ChatGPTEvery domain you track, with its latest weekly reading (null = not measured, never zero). Needs the agency:read permission.
agency_status
ChatGPTYour plan, how many domains it covers and how many you track. Needs the agency:read permission.
agency_update
ChatGPTChanges the client label or note, or switches the domain off / on. Needs the agency:write permission.
aivis_brand
ChatGPTThe brand, every prompt with the latest answer from each AI engine, the domains cited instead of you, the daily visibility trend and starter prompts you could add. Needs the aivis:read permission.
aivis_brand_add
ChatGPTStarts tracking a brand (any domain, hosted with us or not). Then add prompts. Adding one you track already returns it. Needs the aivis:write permission.
aivis_brand_remove
ChatGPTStops tracking the brand and all its prompts. The history is kept, but re-adding the brand does not restart its prompts. Needs "confirm": true. Needs the aivis:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
aivis_brand_update
ChatGPTThe next round of answers uses the new settings. Needs the aivis:write permission.
aivis_brands
ChatGPTEvery brand (domain) you track, with its visibility numbers. Needs the aivis:read permission.
aivis_prompt
ChatGPTWhat each AI engine answered last time (the full answer text, as on the prompt page) and the last 30 results. Needs the aivis:read permission.
aivis_prompt_check
ChatGPTAsks the prompt's AI engines again now (answers usually within the hour). The same bounds as the button: once per prompt in 24 hours and a daily number per account, and not while checks are paused. Needs the aivis:write permission.
aivis_prompt_engines
ChatGPTSets which AI engines the next round asks for this prompt. Needs the aivis:write permission.
aivis_prompt_remove
ChatGPTRemoves the prompt AND its answers history (the same as the Remove button). Needs "confirm": true. Needs the aivis:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
aivis_prompts_add
ChatGPTAdds prompts. What fits inside the account's prompt allowance is added; the rest is listed in not_added. The first answers usually arrive within the hour. Needs the aivis:write permission.
aivis_status
ChatGPTWhether AI visibility is on this account, how many prompts it covers and how many are tracked, how often they are asked, the number of tracked brands and your average visibility (% of answers that named you). Needs the aivis:read permission.
alerts_create
ChatGPTDomains matching it today are the starting point, not news: from now on you get an e-mail when a NEW one matches. Needs the vetting:write permission.
alerts_delete
ChatGPTDeletes the saved search and stops its e-mails. What it already told you about is forgotten with it. Needs the vetting:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
alerts_list
ChatGPTEvery aged-domain search you saved, what it looks for and how many domains match it now. Needs the vetting:read permission.
alerts_matches
ChatGPTThe aged domains this saved search matches at this moment, with a link to each listing. Needs the vetting:read permission.
audit_get
ChatGPTThe audit with every finding: what it is, what it means, which pages it affects and how to fix it. A finding with source: server comes from your hosting with us rather than from the crawl. Needs the audit:read permission.
audit_list
ChatGPTYour finished audits, newest first. Needs the audit:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
audit_pages
ChatGPTEvery page the crawl fetched, with what was measured on it. Needs the audit:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
audit_start
ChatGPTQueues an audit; results are usually ready within a few minutes, in the audit it returns. A site whose ownership you have not proved is crawled shallowly (see pages in the response); verifying it unlocks a full crawl. Needs the audit:write permission.
audit_status
ChatGPTYour plan, audits a month included and used, the page cap per audit, and your most recent audit. Needs the audit:read permission.
audit_verification
ChatGPTThe three ways to prove a site is yours. Any one of them is enough, and a site hosted with us needs none. Needs the audit:read permission.
audit_verify
ChatGPTLooks for the DNS record, the meta tag and the file, in that order. Needs the audit:write permission.
autopost_campaign_delete
ChatGPTDeletes 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.
autopost_campaign_form
ChatGPTEvery 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.
autopost_key_delete
ChatGPTRemoves 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.
autopost_key_test
ChatGPTAsks 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.
autopost_keys
ChatGPTThe 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.
autopost_models
ChatGPTThe 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.
autopost_overview
ChatGPTWhether 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.
backlinks_add_domain
ChatGPTRefused when it would pass the plan's domain limit, or when the chosen cadence would plan more refreshes a month than the plan includes. Needs the backlinks:write permission.
backlinks_add_links
ChatGPTAdds links to watch. Anything past the account's link limit is not added (see not_added). Needs the backlinks:write permission.
backlinks_check_link
ChatGPTFetches the page immediately and re-reads the link. Costs nothing and uses no allowance; at most once every 10 minutes per link. Needs the backlinks:write permission.
backlinks_delete_domain
ChatGPTStops watching the profile: no more scheduled refreshes, and it no longer counts towards your plan. Nothing is charged. Needs the backlinks:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
backlinks_delete_link
ChatGPTStops watching. Its history is kept and comes back if you add the link again. Needs the backlinks:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
backlinks_domain
ChatGPTThe profile with its top referring domains, anchors, linked pages and monthly history. Reads what is stored - it never spends a refresh. Needs the backlinks:read permission.
backlinks_domains
ChatGPTEvery domain whose backlink profile you watch, most recently added first, with its latest totals (backlinks, referring domains, referring domains won and lost in the last 30 days) and when it was last refreshed. Reads what is stored - it never spends a refresh. Needs the backlinks:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
backlinks_link
ChatGPTThe link and up to 100 of its most recent checks. Needs the backlinks:read permission.
backlinks_links
ChatGPTEvery link you watch, problems first. Needs the backlinks:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
backlinks_refresh_domain
ChatGPTUses one profile refresh of the monthly allowance, unless a recent shared snapshot of that domain can be reused, in which case it costs nothing. At most once a day per domain. Needs the backlinks:write permission.
backlinks_status
ChatGPTThe plan, how many links and profiles may be watched, profile refreshes a month included and used, the refreshes your chosen cadences plan for, and how many watched links are live, gone or changed. Needs the backlinks:read permission.
backlinks_tracker_get
ChatGPTOne 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.
backlinks_tracker_link_change
ChatGPTThe 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.
backlinks_tracker_link_remove
ChatGPTThe 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.
backlinks_tracker_list
ChatGPTThe 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.
backlinks_update_link
ChatGPTSets how often this one link is re-checked (daily, weekly or monthly) and schedules its next check to match. The answer is the link with its new frequency. Needs the backlinks:write permission.
backups_create
ChatGPTTakes 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.
backups_delete
ChatGPTDeletes 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.
backups_download
ChatGPTA temporary link to download the backup archive (tar.gz) - valid about 4 hours. Needs the backups:read permission.
backups_get
ChatGPTOne backup of the site. Needs the backups:read permission.
backups_list
ChatGPTThe 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.
backups_restore
ChatGPTReplaces 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.
billing_invoice_pdf
ChatGPTThe PDF of an invoice or credit note of this account (Content-Type application/pdf). Needs the billing:read permission.
billing_invoices
ChatGPTEvery 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.
billing_summary
ChatGPTSubscription (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.
boost_status
ChatGPTWhether Performance Boost is on for the account, its level and how many sites it covers. Needs the boost:read permission.
campaigns_get
ChatGPTOne campaign with its last ten runs. Needs the content:read permission.
campaigns_list
ChatGPTThe 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.
cleaner_get
ChatGPTSite 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.
cleaner_run
ChatGPTRuns Site Cleaner. scan lists unused plugins/themes, junk files and database clutter. clean removes the selected items after taking a backup and checks the site afterwards. undo puts a clean back from its backup. Needs the sites:write permission.
cleaner_schedule
ChatGPTSets automatic cleaning for the site (needs the add-on to actually clean). Needs the sites:write permission.
code_check
ChatGPTRuns 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.
competitors_add
ChatGPTAdds a domain to your watch-list; its first reading arrives within minutes. Refused before anything is spent if your packs have no room. Needs the competitors:write permission.
competitors_delete
ChatGPTRemoves the domain from your watch-list. Needs the competitors:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
competitors_get
ChatGPTOne domain with its top pages and the history of its weekly readings. Needs the competitors:read permission.
competitors_list
ChatGPTEvery domain you watch, with its latest weekly reading (null = not measured, never zero). Needs the competitors:read permission.
competitors_status
ChatGPTYour packs, how many domains they cover (plus any free domain) and how many you watch. Needs the competitors:read permission.
content_create
ChatGPTWrites 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.
content_get
ChatGPTOne post in full, with its text and the history of what happened to it. Needs the content:read permission.
content_list
ChatGPTThe 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.
content_media
ChatGPTPuts 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.
content_options
ChatGPTBefore 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.
content_queue
ChatGPTEvery 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.
content_remove
ChatGPTRemoves 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.
content_update
ChatGPTChanges 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.
country_lock_get
ChatGPTWhether the site is locked to certain countries, which ones, whether search-engine crawlers are let in, the addresses that are always let in, and whether the change is live yet (status: pending = being applied, applied = live, waiting = the site is not live on its server yet, off). Needs the sites:read permission.
country_lock_set
ChatGPTLocks the site to the countries given (or everyone except them), or switches the lock off. Live on the site within about a minute - read it back with GET until status is "applied". Needs the sites:write permission.
cron_account
ChatGPTAll cron jobs on every site of the account (at most 25), each with its site id and domain. Needs the cron:read permission.
cron_create
ChatGPTAdds a job and puts it on the site's server within about a minute. It runs as the site's own user, in the site folder, with the site's PHP version, and is stopped after 15 minutes. Refused with limit_reached at 5 jobs on the site or 25 on the account, and with validation_failed for a schedule more often than every 5 minutes, a multi-line command, or a script path outside the site folder. Needs the cron:write permission.
cron_delete
ChatGPTDeletes the job and its run history, and takes it off the server within about a minute. A run already going finishes. Needs the cron:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
cron_get
ChatGPTThe job and its last 10 runs: when, how long, the exit code, and the output (the first 1,000 and last 7,000 bytes of long output are kept). Needs the cron:read permission.
cron_list
ChatGPTEvery cron job of the site with its schedule (as written and in words, UTC), what it runs, whether it is on, why it is paused if it is (the site is frozen or suspended, it timed out 3 times in a row, or our team paused it), its next 3 run times and its last result. kinds lists what this site type may run. limits shows the per-site and per-account counts. Needs the cron:read permission.
cron_run
ChatGPTStarts the job on its server at once (once a minute per job, 10 times in 10 minutes per account). The run is recorded like a scheduled one, with trigger "manual", a few seconds later. Refused while the site is frozen or suspended. Needs the cron:write permission.
cron_runs
ChatGPTNewest first. status: ok, failed (non-zero exit code), timeout (stopped at 15 minutes), skipped (the previous run was still going, or the server was paused) or error (could not start). trigger: schedule or manual (the Run now button). Needs the cron:read permission.
cron_update
ChatGPTChange any of the fields; the others stay as they are. To change the schedule give schedule_mode with its fields. Switching a job on again (enabled: true) also clears a pause after repeated timeouts. On the server within about a minute. Needs the cron:write permission.
dns_check_now
ChatGPTThe 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.
dns_create
ChatGPTAdds 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.
dns_delete
ChatGPTDeletes 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.
dns_list
ChatGPTThe 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.
dns_update
ChatGPTChanges 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.
extdeploy_connection_remove
ChatGPTForgets 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.
extdeploy_connection_test
ChatGPTAsks the provider whether the stored credentials still work (the page's Test button). Needs the extdeploy:write permission.
extdeploy_connections
ChatGPTThe 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.
extsites_deploy
ChatGPTPublishes 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.
extsites_domain_add
ChatGPTAttaches the domain at the provider and returns the DNS records to publish wherever that domain's DNS is answered. Needs the extdeploy:write permission.
extsites_domain_refresh
ChatGPTAsks the provider again whether the domain's DNS and certificate are in place. Needs the extdeploy:write permission.
extsites_domain_remove
ChatGPTDetaches 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.
extsites_get
ChatGPTOne 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.
extsites_history
ChatGPTThe recent deploys of one external site, newest first - what to pass to a rollback. Needs the sites:read permission.
extsites_list
ChatGPTThe 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.
extsites_log
ChatGPTWhat happened during one deploy, line by line (the page's "Log"). Needs the extdeploy:read permission.
extsites_remove
ChatGPTStops 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.
files_delete
ChatGPTDeletes 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.
files_list
ChatGPTFolders 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.
files_mkdir
ChatGPTCreates a folder (and any missing parent folders). Needs the files:write permission.
files_move
ChatGPTRenames or moves a file or folder inside the site folder. Needs the files:write permission.
files_read
ChatGPTReturns 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.
files_stat
ChatGPTType, size, modification time and mode of one path. Needs the files:read permission.
files_upload_archive
ChatGPTUnpacks 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.
files_write
ChatGPTWrites 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.
firewall_get
ChatGPTThe same as the site's "Website firewall" tab: whether the firewall is on for this site, and the requests it recently refused (when, what was asked for, why, and the reference number the visitor was shown). Signing in, editing, uploads, plugin installs, the database tool and the file manager are never blocked. If something ordinary was blocked, open a ticket with its reference number. Switching the firewall off for a site is done by support. Needs the sites:read permission.
health_get
ChatGPTThe 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.
health_integrity_check
ChatGPTChecks 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.
health_recheck
ChatGPTProbes 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.
health_repair
ChatGPT"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.
hourly_backups_download_prepare
ChatGPTBuilds 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.
hourly_backups_get
ChatGPTWhether hourly backups are on for this site, when the next one runs, every restore point kept, any roll-back in progress and the downloads being prepared. Needs the backups:read permission.
hourly_backups_now
ChatGPTTakes 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.
hourly_backups_restore
ChatGPTRolls 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.
index_add
ChatGPTAdds pages with the panel's own rules: a page that would pass the plan's URL limit or its checks a month is not added (see not_added). The first check runs within a few minutes. Needs the index:write permission.
index_check
ChatGPTChecks the page immediately (usually 1-2 seconds). Uses one check of the monthly allowance; at most once an hour per page and a daily number per account. Needs the index:write permission.
index_delete
ChatGPTStops tracking. Its history is kept and comes back if you add the page again. Needs the index:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
index_get
ChatGPTThe page and up to 100 of its most recent checks. Needs the index:read permission.
index_list
ChatGPTEvery page you track, newest first, with its current status. Needs the index:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
index_status
ChatGPTThe plan, how many pages may be tracked, checks a month included and used, the checks your chosen frequencies plan for, and how many tracked pages are indexed. Needs the index:read permission.
index_update
ChatGPTRefused when the new frequency would pass the plan's checks a month. Needs the index:write permission.
jobs_get
ChatGPTThe 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.
jobs_list
ChatGPTJobs 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.
jobs_wait
ChatGPTWaits 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.
kb_article
ChatGPTOne article as plain text and as sanitised HTML, with related articles. Needs the kb:read permission.
kb_search
ChatGPTThe dashboard's knowledge-base search (keyword + meaning). Every key may use it. Needs the kb:read permission.
local_add_keywords
ChatGPTAdds keywords to one of your towns. Refused before anything is spent if the month would not fit inside your plan. Needs the local:write permission.
local_business
ChatGPTOne business: its profile facts, the towns it is searched from, and every change we have seen to its listing. Needs the local:read permission.
local_businesses
ChatGPTEvery business you track, with the facts of its Google business profile as we last read them and how it is doing in the map results. Needs the local:read permission.
local_check_now
ChatGPTPuts those keywords at the front of the queue. They are checked within a few minutes and each one uses a check from this month's allowance. Needs the local:write permission.
local_history
ChatGPTEvery check we have made of that keyword, so you can chart it yourself. Needs the local:read permission.
local_keywords
ChatGPTEvery keyword you track, where it sits in the map results and in the ordinary results, and how it moved since the check before. Needs the local:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
local_status
ChatGPTYour plan, what it covers, how much of this month's checks you have used, and how your businesses are doing on the map overall. Needs the local:read permission.
logs_access
ChatGPTRequests 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.
logs_errors
ChatGPTRecent 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.
mail_alias_delete
ChatGPTRemoves 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.
mail_alias_save
ChatGPTSaves one alias, forwarder or the catch-all (the same checks as the Mail tab). Needs the mail:write permission.
mail_get
ChatGPTThe same as the site's Mail tab: whether PBN.LTD Mail is set up (where = "external" when the domain's mail is at an outside provider), whether its records are published, how many mailboxes the site may have and has, each mailbox with its size and use and out-of-office reply, the aliases, forwarders and catch-all. No password is ever included. Needs the mail:read permission.
mail_mailbox_delete
ChatGPTDeletes the mailbox with everything in it. The site's first (included) mailbox can only go once it is the last one. Needs the mail:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
mail_out_of_office
ChatGPTThe same as the out-of-office form on the Mail tab. Needs the mail:write permission.
mail_remove
ChatGPTTakes PBN.LTD Mail off the site once it has no mailboxes, forwarders, aliases or catch-all (delete those first). The website is not affected; mail can be set up again at any time. Needs the mail:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
mail_setup
ChatGPTThe Mail tab's "Set up mail": makes the site's mail account and its signing keys and publishes its records where we answer DNS for the domain. Needs the mail:write permission.
mailroute_get
ChatGPT"route": "ours" = our mail servers (the default); "own" = the customer's own provider, with its state ("pending" while being set up on the server, "active", "error" + state_note). The key is never returned, only key_hint. Needs the sites:read permission.
mailroute_off
ChatGPTSwitches the site back to our mail servers within a minute. The settings are kept unless forget=true. Needs the sites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
mailroute_providers
ChatGPTThe providers a site can send through and what each needs: a key only (Resend, SendGrid, Postmark), a login and key (Brevo, Mailgun, Amazon SES, which also need a region), or a server, port, user name and password (provider "smtp"). Needs the sites:read permission.
mailroute_test
ChatGPTSends one real e-mail the way the website does (from inside the site, through the provider) and returns the provider's answer in plain words. At most 5 tests per site per 10 minutes. Needs the sites:write permission. This can take up to a minute.
mentions_add
ChatGPTRefused when it would pass the plan's brand limit, or when the chosen schedule would plan more checks a month than the plan includes. Needs the mentions:write permission.
mentions_brand
ChatGPTReads what is stored - it never spends a check. Needs the mentions:read permission.
mentions_brands
ChatGPTEvery brand phrase you track, most recently added first, with its mention counts by sentiment, visibility and when it was last checked. Reads what is stored - it never runs a check. Needs the mentions:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
mentions_check
ChatGPTUses one check of the monthly allowance, unless a recent shared snapshot of that phrase can be reused, in which case it costs nothing. At most once a day per brand. Needs the mentions:write permission.
mentions_delete
ChatGPTStops listening. Everything already found is kept. Needs the mentions:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
mentions_list
ChatGPTNewest first. Needs the mentions:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
mentions_status
ChatGPTThe plan, how many phrases may be tracked, checks a month included and used, the checks your chosen schedules plan for, and the overall sentiment split. Needs the mentions:read permission.
mentions_update
ChatGPTSets how often we search for new mentions of this phrase. Refused with validation_failed when the new pace would plan more checks a month than your plan includes. The next check is scheduled from now at the new pace. Needs the mentions:write permission.
meta_limits
ChatGPTThe 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.
moneysites_get
ChatGPTOne money site in full: state, plan, hostnames, PHP version, region, usage against the plan's allowances, recent jobs and errors, and the links for the few jobs that are finished in the Zinn Digital panel. Needs the moneysites:read permission.
moneysites_list
ChatGPTEvery money site on this account, with its state, plan, application and last known usage. Needs the moneysites:read permission.
moneysites_move
ChatGPTOne move: the step it is on, what it is doing now, and its log (what was checked and when). Needs the moneysites:read permission.
moneysites_move_cancel
ChatGPTCancels a move before the domain is switched. The site stays exactly as it is on PBN hosting. Refused once the domain switch has started. Needs the moneysites:write permission.
moneysites_move_check
ChatGPTWhether the site can be moved now, into which slot, and what happens. When it cannot, reason_code says why. current_move is the move in progress, if any. Needs the moneysites:read permission.
moneysites_move_start
ChatGPTStarts the one-click move. Needs the sites:delete scope too, because the PBN copy is deleted at the end. The domain keeps its nameservers and DNS account: only its web records are pointed at the new hosting, after the copy has been checked; email and other records are not touched. Nothing is charged. The move it returns shows each step. Needs the moneysites:write permission.
moneysites_moves
ChatGPTEvery move of a PBN site to money-site hosting on this account, newest first, with its steps and state. Needs the moneysites:read permission.
moneysites_order
ChatGPTOne order, re-read from Zinn Digital if it is still open. Needs the moneysites:read permission.
moneysites_order_cancel
ChatGPTCancel an order that has not been paid. Nothing was charged, so nothing is refunded. Needs the moneysites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
moneysites_orders
ChatGPTEvery money-site order on this account, newest first, with its state and what it cost. Needs the moneysites:read permission.
moneysites_refresh
ChatGPTAsks Zinn Digital for this account's sites and orders again: after paying, or when a site set up by our team is not listed yet. Needs the moneysites:read permission.
moneysites_site_plan
ChatGPTThe Zinn Digital subscription that pays for this money site, read live: its plan, price, whether it renews and on which date, or the date it ends when it will not renew, and whether it can be cancelled here (can_cancel). Needs the moneysites:read permission.
moneysites_site_plan_cancel
ChatGPTCancels the plan that pays for this money site AT THE END OF THE PAID PERIOD: renewal is switched off, the site stays live until ends_on, then the plan ends and nothing more is charged. No refund is made. Safe to repeat: a plan that is already cancelled answers its current state. A plan paid through a PayPal subscription is cancelled in PayPal instead (the error says how). Needs the moneysites:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
moneysites_woocommerce
ChatGPTWhether WooCommerce is installed on one of your PBN-line WordPress sites, which version, and the health checks: plugin active, shop/cart/checkout pages, a currency, pretty permalinks, HTTPS, and cart and checkout kept out of any page cache. Needs the moneysites:read permission.
moneysites_woocommerce_set
ChatGPTAdds WooCommerce to a WordPress site or switches it off again. The install runs in the background and usually takes a minute or two; the site's WooCommerce state shows the result. A site of another type is refused with the reason. Needs the moneysites:write permission. Starts a job that finishes later: the answer carries job.id, and the job reads succeeded or failed when it is done.
plugins_delete
ChatGPTSwitches 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.
plugins_install
ChatGPTInstalls 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.
plugins_list
ChatGPTEvery plugin installed on a WordPress site, whether it is active, its version and whether an update is waiting. Needs the sites:read permission.
plugins_state
ChatGPTActivates 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.
prodisc_offers
ChatGPTWhether the account is eligible for the Pro plugin offer, and each plugin in it with its state for you: available, active or redeemed. Needs the prodisc:read permission.
products_add
ChatGPTAdds a product and reads both shelves at once. Refused before anything is spent if your plan has no room. Needs the products:write permission.
products_delete
ChatGPTRemoves the product and its history. Needs the products:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
products_get
ChatGPTOne product with every listing we read on each shelf ("counted" = comparable to your product; "yours" = recognised by your seller name or ASIN). Needs the products:read permission.
products_list
ChatGPTEvery product you track, with the latest reading of each shelf. Needs the products:read permission.
products_status
ChatGPTYour plan, how many products it covers and how your products are doing on the shelves. Needs the products:read permission.
rank_domain
ChatGPTThe domain, each Google version it is tracked in (country, language, device), and every keyword in each with its current position (null = not in the first 100 results). Needs the rank:read permission.
rank_domain_add
ChatGPTStarts tracking a domain (hosted with us or anywhere else). Then add a Google version and keywords. Adding a domain you track already returns it. Needs the rank:write permission.
rank_domain_remove
ChatGPTStops tracking the domain and all its keywords. The history is kept, but re-adding the domain does not restart its keywords - they have to be added again. Needs "confirm": true. Needs the rank:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
rank_domains
ChatGPTEvery domain you track, with its keyword count, average position and how many keywords are in the top 10 and top 3. Needs the rank:read permission.
rank_group_add
ChatGPTWhich Google to check the keywords in: country or city, language and device. Your plan sets how many per domain. Adding one that exists returns it. Needs the rank:write permission.
rank_keyword
ChatGPTThe keyword and every completed check in the period: the position (null = not in the first 100 results) and the page of yours that ranked. Needs the rank:read permission.
rank_keyword_check
ChatGPTAsks for an extra check of this keyword now (results usually within the hour). The same bounds as the button: once per keyword in 24 hours, a daily number per account, the month's check budget (past it the check goes in the standard queue; once the month's extra checks are used up it is refused until the 1st), and not while checks are paused. Scheduled checks carry on regardless. Needs the rank:write permission.
rank_keyword_remove
ChatGPTRemoves the keyword AND its position history (the same as the Remove button). Needs "confirm": true. Needs the rank:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
rank_keywords_add
ChatGPTAdds keywords to a Google version. What fits inside the account's keyword allowance is added; the rest is listed in not_added. The first check runs within the hour. Keywords you track already are skipped. Needs the rank:write permission.
rank_languages
ChatGPTThe language codes to use for a Google version. Needs the rank:read permission.
rank_locations
ChatGPTThe location codes to use for a Google version. Up to 40 matches. Needs the rank:read permission.
rank_status
ChatGPTWhether rank tracking is on this account, how many keywords it covers and how many are tracked, how often they are checked, the Google versions allowed per domain and the number of tracked domains. Needs the rank:read permission.
redis_site
ChatGPTWhether Redis is on for this site: "queued" while a switch is being applied (up to a minute), then "on" or "off"; "error" with the reason in detail. Needs the redis:read permission.
redis_status
ChatGPTWhether Redis is on for the account and its state on each of your sites. Needs the redis:read permission.
redis_switch
ChatGPTThe same as the site's Redis switch. WordPress sites get the object cache installed and configured (and removed again when switched off); other site types get the connection settings. Refused when Redis is not on the account. Needs the redis:write permission.
registrars_automatic
ChatGPTSwitches 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.
registrars_disconnect
ChatGPTDeletes 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.
registrars_domain_check
ChatGPTThe 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.
registrars_get
ChatGPTOne connection, with the domain names we can see in that registrar account (up to 1,000). Needs the registrars:read permission.
registrars_history
ChatGPTEvery 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.
registrars_list
ChatGPTYour 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.
registrars_providers
ChatGPTEvery 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.
registrars_refresh
ChatGPTReads the domain list of this registrar account again (about a minute). Once every 2 minutes. Needs the registrars:write permission.
registrars_site_status
ChatGPTWhat 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.
registrars_site_update_ns
ChatGPTThe 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.
registrars_test
ChatGPTAsks the registrar whether the stored key still works and records the answer on the connection. Needs the registrars:write permission.
registrars_update_waiting
ChatGPTSets 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.
reports_clients
ChatGPTEvery client you report on, what of theirs a report covers and when the next one is due. Needs the reports:read permission.
reports_get
ChatGPTThe whole report: every section as it was frozen when it was made, the plain "what changed" summary, and the share link while it is live. Needs the reports:read permission.
reports_list
ChatGPTEvery report made on this account, newest first. The share link itself is only returned by the single-report endpoint. Needs the reports:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
reports_make
ChatGPTBuilds the report from what the account has already collected - it never spends any of your search credits - and returns it with its share link. Needs the reports:write permission.
reports_revoke
ChatGPTThe link stops working at once for everybody who has it. The report itself is kept and you can turn the link back on from the panel. Needs the reports:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
reports_status
ChatGPTYour plan, how many clients and reports it covers and how many you have used this month. Needs the reports:read permission.
reputation_add
ChatGPTAdds a business and searches Google, Trustpilot and Tripadvisor for its profiles. The results arrive as candidates within a minute or two, for the owner to confirm which one is theirs. Refused if your plan has no room. Needs the reputation:write permission.
reputation_confirm
ChatGPTOnly a profile you confirm is ever read. Its first reading starts at once. Needs the reputation:write permission.
reputation_countries
ChatGPTThe countries you can choose when adding a business (pass location_code as country). Needs the reputation:read permission.
reputation_delete
ChatGPTRemoves the business with its profiles, reviews, history and brand terms. Needs the reputation:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
reputation_get
ChatGPTOne business: per platform its confirmed profile (or the candidates found, waiting for you to confirm which is yours), the latest reviews (poor unanswered first), the rating history, and each brand term with its latest page one and what dropped off it. Needs the reputation:read permission.
reputation_list
ChatGPTEvery business you watch with its confirmed review profiles and their latest reading (null = not read yet, never zero). covered is false for a business your plan no longer pays to read. Needs the reputation:read permission.
reputation_profile_remove
ChatGPTForgets the confirmed profile on one platform (search again to pick another). Needs the reputation:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
reputation_refresh
ChatGPTAsks for a fresh reading of every confirmed profile and brand term of this business within the next few minutes. The same bound as the "Read now" button: once per business in the interval the page states (24 hours today). Weekly readings carry on regardless. Needs the reputation:write permission.
reputation_search
ChatGPTSearches the three platforms again for this business's profiles (the same daily limit per business as the button). New candidates replace the old ones. Needs the reputation:write permission.
reputation_status
ChatGPTYour plan, how many businesses and brand terms it covers and how many you watch. Needs the reputation:read permission.
reputation_term_add
ChatGPTAdds a brand term whose Google page one is read every week (within your plan's brand terms, up to 10 per business). Needs the reputation:write permission.
reputation_term_delete
ChatGPTRemoves a brand term and its page-one history. Needs the reputation:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
research_domain
ChatGPTRanked keywords (top 100 by traffic), estimated monthly traffic, position spread, top pages and competitors. Uses 1 credit - or none if this account asked in the last 14 days. Needs the research:run permission.
research_gap
ChatGPTKeywords the competitors rank for and your domain does not, most-shared first. One credit per competitor not asked in the last 14 days. Needs the research:run permission.
research_keywords
ChatGPTUp to 100 keywords, by search volume. Uses 1 credit - or none if this account asked the same question in the last 30 days. Needs the research:run permission.
research_list
ChatGPTThe keywords in one of your lists, with their saved metrics. Needs the research:read permission.
research_lists
ChatGPTYour saved keyword lists. Needs the research:read permission.
research_local
ChatGPTMonthly searches for each keyword in that area. Uses 4 credits (or none if asked before). Needs the research:run permission.
research_markets
ChatGPTThe countries (location_code) and languages (language_code) keyword research and domain overview answer for. Free. Needs the research:read permission.
research_status
ChatGPTFor keyword research and domain overview: whether it is on the account, the plan, credits a month and credits used this month. Needs the research:read permission.
runs_get
ChatGPTOne run of a campaign and every article in it. Needs the content:read permission.
security_bots
ChatGPTThe 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.
security_email_protection
ChatGPTThe 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.
security_get
ChatGPTThe 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.
security_rule_add
ChatGPTAdds 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.
security_rule_delete
ChatGPTRemoves 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.
security_rule_state
ChatGPTRules run in order: the first that matches decides. Needs the security:write permission.
security_rule_update
ChatGPTReplaces one rule (same shape as when adding it). Only rules made on this dashboard can be changed here. Needs the security:write permission.
security_under_attack
ChatGPTEvery 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. While our flood protection has switched it on during an active attack, switching it off is refused (409 conflict, with the reason) until the attack has stopped; the state then carries locked. Needs the security:write permission.
seo_metrics_site
ChatGPTThe 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.
seo_subscription
ChatGPTWhat your SEO tools order covers today (tools, plans, period, discounts) and the next period if it is already paid. Tools bought on their own (not through the SEO checkout) are not in this order. Needs the seo:read permission.
sites_create
ChatGPTCreates 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.
sites_create_options
ChatGPTThe 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.
sites_delete
ChatGPTDeletes 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.
sites_edit_options
ChatGPTThe 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.
sites_get
ChatGPTEverything 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.
sites_kb_suggestions
ChatGPTKnowledge-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.
sites_list
ChatGPTThe 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.
sites_malware
ChatGPTWhat 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.
sites_malware_rescan
ChatGPTStarts 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.
sites_nameservers
ChatGPTThe 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.
sites_php_version
ChatGPTChanges only the site's PHP version. The web server is reconfigured in the background (a job is returned). Needs the sites:write permission.
sites_purge_cache
ChatGPTClears the CDN cache of both hostnames (as Purge CDN cache in the panel). The site must be live. Needs the sites:write permission.
sites_reinstall
ChatGPTInstalls 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.
sites_set_home
ChatGPTMakes 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.
sites_temp_unfreeze
ChatGPTA 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.
sites_update
ChatGPTChange 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.
sites_usage
ChatGPTThe 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.
sites_usage_refresh
ChatGPTStarts 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.
sites_verify
ChatGPTFetches 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.
staging_cancel
ChatGPTEnds the staging add-on now and removes EVERY staging site of the account. Months already paid are not refunded. Your live sites are not affected. Needs "confirm": true. Needs the staging:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
staging_copy_from_live
ChatGPTCopies the live site over the staging copy (files and/or database), replacing any changes made on staging. The live site is not changed. Needs "confirm": true. Needs the staging:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
staging_copy_to_live
ChatGPTPublishes the staging copy: OVERWRITES the live site's files and/or database with the staging ones. An undo copy of what it replaced is kept for 7 days (support can put it back). Needs "confirm": true. The staging site reads "ready" again when it is done. Needs the staging:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
staging_create
ChatGPTMakes a private staging copy of one of your live sites (files and database). It takes a few minutes for a typical site; the staging site reads "ready" when it is done. Needs the staging add-on and a free slot; the live site is not changed. Needs the staging:write permission.
staging_delete
ChatGPTRemoves the staging copy (its files, database and address). The live site is not touched and the slot is free again straight away. Needs "confirm": true. Needs the staging:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true.
staging_eligible
ChatGPTYour live sites and, for each, whether a staging copy can be made of it now and, when not, the reason in plain words (only WordPress and Static HTML sites that are running). Needs the staging:read permission.
staging_get
ChatGPTOne staging site with its last ten jobs (create, copy to live, copy from live, remove). Needs the staging:read permission.
staging_list
ChatGPTEvery staging site in your account that exists now (being created, ready, copying, paused, needs attention or being removed), newest first, with its last copy job. The state goes back to "ready" when a copy is done. Needs the staging:read permission.
staging_status
ChatGPTWhether staging is on for your account, how many staging sites you have and may have at once, and the size limits. Needs the staging:read permission.
themes_activate
ChatGPTSwitches 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.
themes_list
ChatGPTEvery theme on a WordPress site and which one is in use. Needs the sites:read permission.
tickets_create
ChatGPTOpens 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.
tickets_get
ChatGPTA 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.
tickets_list
ChatGPTYour tickets, newest first. Needs the tickets:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
tickets_queues
ChatGPTThe categories (queues) a ticket can be opened in. Needs the tickets:read permission.
tickets_reply
ChatGPTAdds your message to the ticket (support is notified). One message until support answers. Needs the tickets:write permission.
turnstile_disable
ChatGPTTakes the plugin off the site first (read back), then deletes the widget. Your forms are no longer protected by the bot check. Needs "confirm": true. You can switch it on again at any time. Needs the turnstile:write permission. DESTRUCTIVE: this cannot be undone, and the call is refused without "confirm": true. This can take up to a minute.
turnstile_enable
ChatGPTSwitches the bot check on for this site, or saves new settings when it is already on. We create the Turnstile widget, install our small WordPress plugin with the keys and read it back from the site. If there is no room yet the status is "waiting" and it finishes by itself. Turnstile that our team switched off ("revoked") cannot be switched back on here - contact support. Needs the turnstile:write permission. This can take up to a minute.
turnstile_get
ChatGPTWhat the site's Turnstile tab shows: whether the bot check can be used here (WordPress sites), whether it is on, the mode, which forms it protects, the extra hostnames it accepts, when it was last read back from the site and when the keys were last replaced. The secret key is never returned. Needs the turnstile:read permission.
turnstile_rotate
ChatGPTIssues a new secret key for the site's widget and installs it on the site straight away. The new key is never shown - it only lives on your site. For a key that may have leaked. Needs the turnstile:write permission. This can take up to a minute.
updates_holds
ChatGPTEvery plugin update we held back across your sites because it stopped the site working (the same list as the "Held plugin updates" page). "holding" = tried again on the next update run; "blocked" = it broke the site twice, so it waits for a newer version or for you to ask us to try again. Needs the updates:read permission.
updates_site_holds
ChatGPTThe held plugin updates of one site (the site page's "Plugin updates" section). Needs the updates:read permission.
updates_try_again
ChatGPTThe "Try again" button. Nothing is installed now: the site's next update run tries this version again, loading the site before and after. If it stops the site working again we put it straight back, as before. Needs the updates:write permission.
vetting_get
ChatGPTThe whole report: the verdict, every reason, the key numbers, the anchor texts, the link and traffic history and what the site was in the web archive. Needs the vetting:read permission.
vetting_list
ChatGPTEvery vetting report this account has run, newest first, with its verdict and score. Needs the vetting:read permission. Paginated: the answer's next_cursor is the cursor of the next page.
vetting_run
ChatGPTRuns a full report and returns it. Spends one report credit, unless you already vetted this domain recently - then the report you already have comes back and nothing is charged. Needs the vetting:write permission.
vetting_status
ChatGPTHow many report credits this account holds, how many reports it has run, and the prices. Needs the vetting:read permission.
wayback_archive
ChatGPTThe 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.
wayback_get
ChatGPTOne 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.
wayback_order
ChatGPTUses one restore credit and starts the rebuild. Restoring into an existing site replaces what it serves. Needs the wayback:write permission.
wayback_start
ChatGPTReads that day's copy from the archive and works out what would be rebuilt. The restore waits at "planned" until it is ordered. Needs the wayback:write permission.
wayback_status
ChatGPTYour 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.
