thภาษา
เริ่มใช้งานฟรี
เข้าสู่ระบบเริ่มใช้งานฟรี

ข้อมูลอ้างอิง API

ทุกเอ็นด์พอยต์ที่สร้างขึ้นจากสเปก

หน้านี้สร้างขึ้นจาก openapi.yaml ซึ่งเป็นไฟล์เดียวกับที่เราใช้สร้าง SDKs, CLI และแดชบอร์ดของเราเอง ไม่มีอะไรในนี้ที่จะคลาดเคลื่อนจากสิ่งที่ API ทำจริงๆ เพราะมีแหล่งข้อมูลเพียงแหล่งเดียวเท่านั้น

1085 จุดสิ้นปลายทางใน 42 พื้นที่

กำลังส่งคีย์ของคุณ

ทุกเอ็นด์พอยต์จะต้องใช้คีย์ API เป็นโทเค็นแบบเบียร์เรอร์ สร้างคีย์ได้ในแดชบอร์ดของคุณภายใต้หัวข้อคีย์ API และกำหนดให้มีเฉพาะสิทธิ์ที่คุณต้องการเท่านั้น

curl https://api.zinndigital.com/v1/reseller/services \
  -H "Authorization: Bearer zdk_live_…"

คีย์จะถูกกำหนดตามองค์กร มีสิทธิ์การใช้งานของตัวเอง และสามารถเพิกถอนแยกต่างหากได้ คีย์ทดสอบจะถูกแยกออกจากคีย์จริง เพื่อให้สามารถทดสอบการบูรณาการระบบได้โดยไม่ต้องเสียเงินหรือสร้างเซิร์ฟเวอร์

กำลังรีเซลโฮสติ้งของเราอยู่ใช่ไหม?

มีคู่มือแบบทีละขั้นตอนสำหรับการบูรณาการตัวแทนจำหน่าย: รับคีย์ เรียกใช้งานครั้งแรก ติดตั้งโมดูล WHMCS หรือ HostBill หรือติดตั้งปลั๊กอิน WordPress ของเราบนเว็บไซต์ของคุณเอง

อ่านคู่มือการผสานรวมระบบสำหรับตัวแทนจำหน่าย

จุดสิ้นสุดการเชื่อมต่อ

จัดกลุ่มตามพื้นที่ สิทธิ์การใช้งานสำหรับพนักงานเท่านั้นจะไม่แสดงในรายการนี้ เนื่องจากถูกจำกัดด้วยสิทธิ์ที่บัญชีลูกค้าไม่มีทางได้รับ

reseller · 75 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
DELETE/v1/branding/logoStop showing your logo.reseller.manage
POST/v1/branding/logoUpload your logo.reseller.manage
GET/v1/reseller/brandThe identity your clients see.reseller.view
PUT/v1/reseller/brandSet the identity your clients see.reseller.manage
POST/v1/reseller/brand/fontInstall a Google font into our own origin.reseller.manage
GET/v1/reseller/brand/invoiceHow your invoices read.reseller.view
PUT/v1/reseller/brand/invoiceSet how your invoices read.reseller.manage
GET/v1/reseller/brand/menuYour custom navigation links.reseller.view
POST/v1/reseller/brand/menuAdd a link to your clients' panel.reseller.manage
DELETE/v1/reseller/brand/menu/{item_id}Remove one link.reseller.manage
PUT/v1/reseller/brand/menu/{item_id}Change one link.reseller.manage
DELETE/v1/reseller/brand/panel-hostnameStop serving your clients' panel on your own address.reseller.manage
POST/v1/reseller/brand/panel-hostnameServe your clients' panel on your own address.reseller.manage
POST/v1/reseller/brand/panel-hostname/verifyCheck whether your panel address is serving.reseller.manage
DELETE/v1/reseller/brand/sending-domainStop sending from your own domain.reseller.manage
POST/v1/reseller/brand/sending-domainSend your clients' e-mail from your own domain.reseller.manage
POST/v1/reseller/brand/sending-domain/verifyCheck your sending domain's DNS now.reseller.manage
GET/v1/reseller/client-walletsEvery client float you are holding.reseller.view
POST/v1/reseller/client-walletsOpen a client's float, or add credit to it.reseller.manage
POST/v1/reseller/client-wallets/top-ups/{topUpId}/refundsSend a deposit back to the card it came from.reseller.manage
POST/v1/reseller/client-wallets/{walletId}/adjustmentsCorrect a client's balance.reseller.manage
GET/v1/reseller/client-wallets/{walletId}/top-upsThe deposits on one client's balance.reseller.view
GET/v1/reseller/clients/{orgId}/planWhich plan this client is on, and what it costs you.reseller.view
POST/v1/reseller/clients/{orgId}/planPut a client on a plan — call this before provisioning their first service.reseller.provision
GET/v1/reseller/currenciesThe currencies your clients are quoted in.reseller.view
PATCH/v1/reseller/currenciesChoose the currencies, the default, and what you sell in.reseller.manage
GET/v1/reseller/dunningYour own dunning ladder, and its history.reseller.view
POST/v1/reseller/dunningPublish the next version of your ladder.reseller.manage
DELETE/v1/reseller/dunning/resetGo back to the platform's default ladder.reseller.manage
GET/v1/reseller/edge-policyWhich CDN and DNS networks your clients can be placed on.reseller.view
PUT/v1/reseller/edge-policyTurn CDN or DNS networks on and off for your clients.reseller.manage
GET/v1/reseller/edge-policy/clients/{orgId}Which networks one client of yours can be placed on.reseller.view
PUT/v1/reseller/edge-policy/clients/{orgId}Turn networks on and off for one client.reseller.manage
GET/v1/reseller/gatewaysThe payment gateways you can connect, and which you have.reseller.view
DELETE/v1/reseller/gateways/{code}Disconnect your payment gateway.reseller.manage
POST/v1/reseller/gateways/{code}Connect or re-key your own payment gateway.reseller.manage
GET/v1/reseller/languagesThe languages your clients' panel offers.reseller.view
PATCH/v1/reseller/languagesChoose the languages and the default your clients start in.reseller.manage
GET/v1/reseller/legal-entityThe company details your clients' invoices are issued under.reseller.view
PUT/v1/reseller/legal-entitySave the company details your clients' invoices are issued under.reseller.manage
GET/v1/reseller/linesWhich product lines you sell.reseller.view
PUT/v1/reseller/linesTurn product lines on or off for your clients.reseller.manage
DELETE/v1/reseller/nameserversGive back your nameserver brand.reseller.manage
GET/v1/reseller/nameserversYour own nameserver brand.reseller.view
PUT/v1/reseller/nameserversClaim a domain for your own nameservers.reseller.manage
POST/v1/reseller/nameservers/verifyCheck whether your nameservers answer.reseller.manage
GET/v1/reseller/overviewEverything you have — every URL, credential and setting, in one read.reseller.view
GET/v1/reseller/pricesYour price list — what YOUR clients pay.reseller.view
PUT/v1/reseller/pricesSet your own price for one plan.reseller.manage
GET/v1/reseller/programThe org's wholesale reseller agreement.reseller.view
PATCH/v1/reseller/programChange your own wholesale settings.reseller.manage
POST/v1/reseller/programApply to resell Zinn® hosting to your own clients.reseller.manage
GET/v1/reseller/servicesEverything you have provisioned for your clients.reseller.view
GET/v1/reseller/services/{siteId}One provisioned service.reseller.view
GET/v1/reseller/services/{siteId}/packageWhich packages this client's service could move onto, and what each costs you.reseller.view
POST/v1/reseller/services/{siteId}/packageMove this client's service onto another package.reseller.provision
POST/v1/reseller/services/{siteId}/ssoA one-time sign-in link into the panel for this client.reseller.provision
POST/v1/reseller/services/{siteId}/suspendPut a client's site on a non-payment hold.reseller.provision
POST/v1/reseller/services/{siteId}/unsuspendRelease a non-payment hold you placed.reseller.provision
GET/v1/reseller/statementsWhat you owe Zinn®, per period.reseller.view
GET/v1/reseller/statements/{statementId}One statement, with the line for every client.reseller.view
GET/v1/reseller/tax-registrationsYour own VAT registrations.reseller.view
POST/v1/reseller/tax-registrationsAdd one of your VAT registrations.reseller.manage
DELETE/v1/reseller/tax-registrations/{registration_id}End or remove one of your VAT registrations.reseller.manage
GET/v1/reseller/vendor-policyWhose SEO data accounts your clients' checks run on.reseller.view
PATCH/v1/reseller/vendor-policySwitch between your own vendor keys and Zinn®'s metered pool.reseller.manage
PUT/v1/reseller/vendor-policy/clients/{orgId}Cap or pause one client's paid data checks.reseller.manage
GET/v1/reseller/vendor-usageWhat your clients drew from Zinn®'s vendor accounts this month.reseller.view
POST/v1/reseller/webhooks/{code}/{orgId}Ingest a signed callback from a reseller's OWN payment gateway.—
GET/v1/walletYour credit balance with your provider.billing.view
GET/v1/wallet/settingsYour low-balance warning and automatic top-up.billing.view
PUT/v1/wallet/settingsSet your low-balance warning and automatic top-up.billing.payment.manage
GET/v1/wallet/top-upsYour credit top-ups.billing.view
POST/v1/wallet/top-upsAdd credit to your balance.billing.payment.manage
GET/v1/wallet/top-ups/estimateWhat a top-up will actually credit, before you pay.billing.view
hosting · 329 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/bulk-jobsYour bulk jobs, newest first.sites.view
POST/v1/bulk-jobsRun one operation across many sites.sites.view
POST/v1/bulk-jobs/installed-pluginsWhat is already installed across a bulk selection.sites.view
POST/v1/bulk-jobs/previewWhat a bulk job would do, per site, before you confirm it.sites.view
GET/v1/bulk-jobs/{bulkJobId}One bulk job and its per-site report.sites.view
POST/v1/bulk-jobs/{bulkJobId}/retry-failedRun a bulk job's failures again.sites.view
POST/v1/connector/backup/claimAsk whether a backup is due — called by the Zinn® WordPress connector plugin.—
POST/v1/connector/backup/completeReport a finished backup — called by the Zinn® WordPress connector plugin.—
GET/v1/hosting/applicationsList the applications a NEW site on a product line can be built with.—
GET/v1/hosting/fleet-applicationsList the applications we install ourselves on our own fleet.—
GET/v1/hosting/locationsList the data centres a new site may be created in.—
GET/v1/index-monitoringWhat this organisation monitors for search indexing, and what it may add.—
POST/v1/index-monitoringMonitor another page, or a whole site hosted elsewhere.—
DELETE/v1/index-monitoring/targets/{targetId}Stop monitoring one target.—
POST/v1/media-offload/claimThe WordPress plugin, redeeming a pairing code for a scoped token.—
POST/v1/media-offload/reportWhat the WordPress plugin says it has offloaded so far.—
POST/v1/media-offload/uploadsPresigned upload URLs for a batch of media files.—
GET/v1/private-networkThe organisation's private access network.—
POST/v1/private-network/devicesEnrol a device and return its configuration once.—
DELETE/v1/private-network/devices/{seatId}Revoke a device.—
POST/v1/private-network/devices/{seatId}/rotateIssue a fresh configuration for a device, invalidating the old one.—
GET/v1/site-blueprintsList your site blueprints.sites.view
POST/v1/site-blueprintsCapture a built site as a reusable blueprint.sites.blueprint.manage
DELETE/v1/site-blueprints/{siteBlueprintId}Delete a site blueprint.sites.blueprint.manage
GET/v1/site-blueprints/{siteBlueprintId}Read one site blueprint.sites.view
PATCH/v1/site-blueprints/{siteBlueprintId}Rename a blueprint, or edit its notes.sites.blueprint.manage
POST/v1/site-blueprints/{siteBlueprintId}/screenshotMint a time-limited URL for a blueprint's screenshot.sites.view
POST/v1/site-events/ingestReceive a site's report about its own changes (signed webhook).—
GET/v1/site-groupsThe organisation's site groups.—
POST/v1/site-groupsCreate a site group.—
DELETE/v1/site-groups/{groupId}Delete a site group.—
GET/v1/site-groups/{groupId}One site group.—
PATCH/v1/site-groups/{groupId}Rename or recolour a site group.—
DELETE/v1/site-groups/{groupId}/sitesRemove sites from a group.—
GET/v1/site-groups/{groupId}/sitesThe sites in a group.—
POST/v1/site-groups/{groupId}/sitesAdd sites to a group.—
PUT/v1/site-groups/{groupId}/sitesReplace a group's membership.—
GET/v1/site-importsList the org's Wayback restores and migrations.sites.view
POST/v1/site-importsRestore a site from a web archive, or migrate one in.hosting.import.manage
GET/v1/site-imports/snapshotsWhat a web archive holds for a domain, by day.sites.view
GET/v1/site-imports/{importId}One import job's state and progress.sites.view
POST/v1/site-imports/{importId}/cancelCancel a running import.hosting.import.manage
GET/v1/sitesList sites in scope.—
POST/v1/sitesCreate a site.—
POST/v1/sites/bulk-vendor-operationRun one hosting-platform operation across many of your sites at once.sites.view
GET/v1/sites/capacityWhether this organization may create another site, and how much room is left.—
GET/v1/sites/deletedList my deleted sites, and when each stops being recoverable.sites.view
POST/v1/sites/deleted/{deletedSiteId}/restoreRestore a deleted site.sites.create
GET/v1/sites/exportDownload the sites in scope as a CSV.—
GET/v1/sites/provider-optionsList the options available for a new site.—
DELETE/v1/sites/{siteId}Schedule a site's permanent deletion.sites.view
GET/v1/sites/{siteId}Get a site.—
GET/v1/sites/{siteId}/apmRanked transactions, ranked hotspots and the hourly timeline for a site.sites.view
GET/v1/sites/{siteId}/apm/tracesList the individual profiled requests kept for a site.sites.view
GET/v1/sites/{siteId}/apm/traces/{traceId}Show where one kept request's milliseconds went.sites.view
GET/v1/sites/{siteId}/application-accessThe sign-in details for the application installed on a site.—
GET/v1/sites/{siteId}/backupsList a site's backups and what its plan grants.sites.view
POST/v1/sites/{siteId}/backupsTake an on-demand backup of a site.hosting.backup.manage
POST/v1/sites/{siteId}/backups/restoreRestore a site from one of its backups.hosting.backup.manage
POST/v1/sites/{siteId}/backups/transfer-inMove an externally hosted site onto Zinn® hosting from a backup we hold.hosting.backup.manage
POST/v1/sites/{siteId}/backups/{backupId}/downloadMint a time-limited download URL for one of a site's backups.hosting.backup.export
GET/v1/sites/{siteId}/build-envThe build variable NAMES a site holds — never their values.sites.view
PUT/v1/sites/{siteId}/build-envReplace a site's whole build environment.hosting.deploy.manage
GET/v1/sites/{siteId}/cacheGet a site's server-side cache policy.sites.view
PUT/v1/sites/{siteId}/cacheSet a site's server-side cache times.sites.view
POST/v1/sites/{siteId}/cache/purgeClear a site's server-side cache.—
GET/v1/sites/{siteId}/cdnGet a site's CDN configuration.sites.view
PUT/v1/sites/{siteId}/cdnChoose a site's CDN tier.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/analyticsRead edge traffic for a site's CDN zone.sites.view
GET/v1/sites/{siteId}/cdn/budgetThis site's slice of the account's metered CDN spend.sites.view
PATCH/v1/sites/{siteId}/cdn/budgetSet this site's metered CDN spend ceiling.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/canonical-hostWhich hostname serves, which redirects, and whether HTTPS is forced.sites.view
PATCH/v1/sites/{siteId}/cdn/canonical-hostChoose www or non-www, and whether to force HTTPS.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/firewall-rulesList a site's custom edge firewall rules.sites.view
PUT/v1/sites/{siteId}/cdn/firewall-rulesReplace a site's custom edge firewall rules.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/offersThe CDNs this site's product line can actually buy.sites.view
GET/v1/sites/{siteId}/cdn/optimisationsEvery edge optimisation available on the site, and whether it is on.sites.view
POST/v1/sites/{siteId}/cdn/optimisationsTurn one edge optimisation on or off.sites.panel_access
GET/v1/sites/{siteId}/cdn/page-rulesList the legacy page rules on a site's zone.sites.view
DELETE/v1/sites/{siteId}/cdn/page-rules/{ruleId}Remove one page rule.hosting.cdn.manage
PATCH/v1/sites/{siteId}/cdn/page-rules/{ruleId}Turn one page rule on or off.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/profileRead a site's recommended CDN profile and where the zone has drifted from it.sites.view
PATCH/v1/sites/{siteId}/cdn/profileChoose whether we keep the recommended CDN profile applied automatically.hosting.cdn.manage
POST/v1/sites/{siteId}/cdn/profileRe-apply the recommended CDN profile to a site's zone.hosting.cdn.manage
POST/v1/sites/{siteId}/cdn/purgePurge a site's CDN cache.sites.cache.purge
GET/v1/sites/{siteId}/cdn/securityRead a site's CDN security and bot settings.sites.view
PUT/v1/sites/{siteId}/cdn/securityChange a site's CDN security and bot settings.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/security-headersThe security headers the edge adds to this site's responses.sites.view
GET/v1/sites/{siteId}/cdn/settingsRead a site's CDN zone settings.sites.view
PUT/v1/sites/{siteId}/cdn/settingsChange a site's CDN zone settings.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/statisticsEdge hits, bytes and country breakdown for a site.sites.view
POST/v1/sites/{siteId}/cdn/switchMove a live site's CDN onto your own account, or back to ours.hosting.cdn.manage
GET/v1/sites/{siteId}/cdn/tiered-cacheRead tiered caching and smart routing for a site's zone.sites.view
PUT/v1/sites/{siteId}/cdn/tiered-cacheTurn tiered caching on or off.hosting.cdn.manage
DELETE/v1/sites/{siteId}/cms-targetStop publishing to this site's CMS.—
GET/v1/sites/{siteId}/cms-targetWhere this site's posts go.—
PUT/v1/sites/{siteId}/cms-targetTell us where this site's posts should go.—
POST/v1/sites/{siteId}/cms-target/testCheck the credential actually works, against the real CMS.—
GET/v1/sites/{siteId}/crawler-blockGet a site's blocked-crawler selection.sites.view
PUT/v1/sites/{siteId}/crawler-blockReplace a site's blocked-crawler selection.sites.crawler.manage
GET/v1/sites/{siteId}/crawler-policyGet a site's SEO-crawler-blocking (PBN footprint) policy.sites.view
PUT/v1/sites/{siteId}/crawler-policySet a site's SEO-crawler-blocking policy.sites.crawler.manage
GET/v1/sites/{siteId}/databaseGet a site's database size and panel links.—
GET/v1/sites/{siteId}/databasesList a site's databases.sites.view
POST/v1/sites/{siteId}/databasesCreate a database on a site.sites.manage
DELETE/v1/sites/{siteId}/databases/{databaseId}Delete a database from a site.sites.manage
POST/v1/sites/{siteId}/databases/{databaseId}/passwordSet a new password on a site database's user.sites.view
DELETE/v1/sites/{siteId}/deletionStop a site's scheduled deletion.sites.view
GET/v1/sites/{siteId}/deletionGet a site's scheduled deletion.sites.view
GET/v1/sites/{siteId}/deployGet a site's deploy target and status.sites.view
POST/v1/sites/{siteId}/deployDeploy or redeploy a site.hosting.deploy.manage
GET/v1/sites/{siteId}/deploymentsA site's deploy history, most recent first.sites.view
GET/v1/sites/{siteId}/deployments/{deploymentId}One deploy, with its build log.sites.view
GET/v1/sites/{siteId}/deployments/{deploymentId}/build-logThe hosting provider's own build log for one deploy.sites.view
POST/v1/sites/{siteId}/deployments/{deploymentId}/redeployRoll back by re-publishing an earlier deploy's commit.hosting.deploy.manage
GET/v1/sites/{siteId}/diagnosticsRun the site's health checks and report each one.sites.view
GET/v1/sites/{siteId}/directory-indexGet what a site serves when a visitor opens a folder.sites.view
PUT/v1/sites/{siteId}/directory-indexSet a site's index files, its folder listing, or both.sites.view
GET/v1/sites/{siteId}/edge-domainsThe custom domains bound to this site's deploy target.sites.view
POST/v1/sites/{siteId}/edge-domainsPoint a domain at this site's deploy target.hosting.deploy.manage
DELETE/v1/sites/{siteId}/edge-domains/{hostname}Stop serving this hostname from the deploy target.hosting.deploy.manage
GET/v1/sites/{siteId}/edge-domains/{hostname}/dnsWhat this domain actually resolves to right now.sites.view
POST/v1/sites/{siteId}/edge-domains/{hostname}/dnsPublish this domain's DNS records for the customer.hosting.deploy.manage
GET/v1/sites/{siteId}/error-pagesThe custom pages a site serves for HTTP error codes.sites.view
POST/v1/sites/{siteId}/error-pagesAdd or replace the custom page for one status code.sites.panel_access
DELETE/v1/sites/{siteId}/error-pages/{status}Remove the custom page for one status code.sites.panel_access
DELETE/v1/sites/{siteId}/external-backupRemove our access to an externally hosted site.hosting.backup.manage
GET/v1/sites/{siteId}/external-backupHow we reach an externally hosted site to back it up.—
PUT/v1/sites/{siteId}/external-backupConnect an externally hosted site so we can back it up.hosting.backup.manage
GET/v1/sites/{siteId}/ftp-usersList a site's FTP accounts.sites.view
POST/v1/sites/{siteId}/ftp-usersCreate an FTP account on a site.sites.manage
DELETE/v1/sites/{siteId}/ftp-users/{ftpUserId}Delete an FTP account from a site.sites.manage
GET/v1/sites/{siteId}/geo-restrictionWhich countries may reach this site.sites.view
PUT/v1/sites/{siteId}/geo-restrictionRestrict this site to chosen countries, or refuse named ones.—
GET/v1/sites/{siteId}/hostingGet the hosting package a site runs on.sites.view
GET/v1/sites/{siteId}/hosting/applicationsList the one-click applications installable on a site's package.sites.view
POST/v1/sites/{siteId}/hosting/applicationsInstall a one-click application onto a live site.—
GET/v1/sites/{siteId}/hosting/usageGet a site's current-period hosting usage.sites.view
POST/v1/sites/{siteId}/ide-assistAsk the AI assistant about one file in the site's web editor.—
GET/v1/sites/{siteId}/ide-assist/modelsThe AI models the site's web editor may use.—
POST/v1/sites/{siteId}/ide-eventsRecord something the customer did in the site's web editor.—
GET/v1/sites/{siteId}/index-checkA hosted site's search-index status.—
GET/v1/sites/{siteId}/index-check/historyA hosted site's recent search-index checks.—
GET/v1/sites/{siteId}/mail-logMessages the site's mail sent or received.—
GET/v1/sites/{siteId}/maintenance-modeGet whether a site is serving its maintenance page.sites.view
PUT/v1/sites/{siteId}/maintenance-modeTake a site into or out of maintenance.sites.view
DELETE/v1/sites/{siteId}/media-offloadRevoke the plugin's token and stop new uploads.storage.manage
GET/v1/sites/{siteId}/media-offloadWhether this site's media is offloaded to object storage, and how.storage.view
PUT/v1/sites/{siteId}/media-offloadTurn media offload on for a site, or change how it behaves.storage.manage
POST/v1/sites/{siteId}/media-offload/pairingMint a short-lived code that pairs the WordPress plugin to this site.storage.manage
GET/v1/sites/{siteId}/metricsGet a site's current usage metrics.—
GET/v1/sites/{siteId}/migrationsThe site's migrations, newest first.sites.view
POST/v1/sites/{siteId}/migrationsMigrate a site in from another host.hosting.import.manage
POST/v1/sites/{siteId}/migrations/discoverWork out which control panel a host runs, from the hostname alone.hosting.import.manage
GET/v1/sites/{siteId}/migrations/discoveries/{discoveryId}Poll a discovery until it has an answer.hosting.import.manage
POST/v1/sites/{siteId}/migrations/managed-requestBuy the managed migration and let staff do it.billing.payment.manage
POST/v1/sites/{siteId}/migrations/probeSign in to the old host and show what is there.hosting.import.manage
GET/v1/sites/{siteId}/migrations/{migrationId}One migration's state and progress.sites.view
POST/v1/sites/{siteId}/migrations/{migrationId}/cancelStop a running migration.hosting.import.manage
POST/v1/sites/{siteId}/migrations/{migrationId}/cutoverRe-sync the mail that arrived during the move.hosting.import.manage
GET/v1/sites/{siteId}/mysql-accessWhich addresses may reach MySQL, per database user.sites.view
POST/v1/sites/{siteId}/mysql-accessAllow one IP address to reach MySQL as one database user.sites.panel_access
DELETE/v1/sites/{siteId}/mysql-access/{userId}/{aclId}Withdraw one MySQL access rule.sites.panel_access
GET/v1/sites/{siteId}/package-namesEvery domain and subdomain this hosting answers for.sites.view
POST/v1/sites/{siteId}/package-namesAttach another domain to this hosting.sites.panel_access
DELETE/v1/sites/{siteId}/package-names/{name}Detach a domain from this hosting.sites.panel_access
POST/v1/sites/{siteId}/panel-sessionsMint one single-use panel link, at the moment the customer clicks.—
GET/v1/sites/{siteId}/performanceGet a site's caching and acceleration settings.sites.view
PUT/v1/sites/{siteId}/performanceUpdate a site's caching and acceleration settings.hosting.performance.manage
GET/v1/sites/{siteId}/performance/slow-requestsList the slowest traced requests for a site.sites.view
GET/v1/sites/{siteId}/performance/slow-requests/{taskId}/{requestId}Show where one request's milliseconds went.sites.view
GET/v1/sites/{siteId}/php-configGet a site's changeable PHP settings.sites.view
PUT/v1/sites/{siteId}/php-configSet a site's PHP settings.sites.view
GET/v1/sites/{siteId}/php-settingsGet a site's PHP extensions, php.ini settings and resource tier.sites.view
PUT/v1/sites/{siteId}/php-settingsSet a site's PHP extensions and php.ini settings.sites.view
GET/v1/sites/{siteId}/php-versionGet a site's PHP version.sites.view
PUT/v1/sites/{siteId}/php-versionSwitch a site's PHP version.hosting.php.manage
GET/v1/sites/{siteId}/planList the plans a site could move to, priced.sites.view
POST/v1/sites/{siteId}/planMove a site onto another plan.sites.view
GET/v1/sites/{siteId}/preview-urlsGet the URLs at which a site can be viewed before its DNS resolves.sites.view
POST/v1/sites/{siteId}/previewsBuild a branch as a preview, without touching the live site.hosting.deploy.manage
GET/v1/sites/{siteId}/protectionGet every protection control for a site.sites.view
PUT/v1/sites/{siteId}/protection/countriesReplace a site's country rule.sites.view
POST/v1/sites/{siteId}/protection/directoriesPassword-protect a folder on a site.sites.view
POST/v1/sites/{siteId}/protection/directories/removeTake the password off a folder on a site.sites.view
GET/v1/sites/{siteId}/protection/file-permissionsRun the vendor's file-permission check on a site.sites.view
POST/v1/sites/{siteId}/protection/file-permissionsApply the vendor's recommended permissions on a site.sites.view
PUT/v1/sites/{siteId}/protection/hotlinkReplace a site's hotlink-protection rules.sites.view
PUT/v1/sites/{siteId}/protection/ip-addressesReplace a site's blocked IP addresses.sites.view
GET/v1/sites/{siteId}/quotaGet a site's enforced disk and inode ceilings, and its usage against them.sites.view
GET/v1/sites/{siteId}/quota/resourcesWhat this site is allowed per resource, what it is using, and what more costs.sites.view
POST/v1/sites/{siteId}/quota/resources/{resource}/downgradeReduce a site's allowance — refused while the site is over the target.sites.view
POST/v1/sites/{siteId}/quota/resources/{resource}/upgradeBuy more disk or file allowance for one site.sites.view
GET/v1/sites/{siteId}/redirectsList a site's redirects.sites.view
POST/v1/sites/{siteId}/redirectsAdd a redirect to a site.sites.view
DELETE/v1/sites/{siteId}/redirects/{redirectId}Delete a redirect from a site.sites.view
GET/v1/sites/{siteId}/registryWhat the public registry says about a hosted site's domain.—
POST/v1/sites/{siteId}/rename-domainChange a site's primary domain (asynchronous).sites.create
DELETE/v1/sites/{siteId}/repoDisconnect the repository and remove its webhook.hosting.deploy.manage
GET/v1/sites/{siteId}/repoGet the repository a site deploys from.sites.view
PUT/v1/sites/{siteId}/repoConnect (or re-connect) a repository to a site.hosting.deploy.manage
GET/v1/sites/{siteId}/repo/branchesList the connected repository's branches.hosting.deploy.manage
GET/v1/sites/{siteId}/repo/syncTwo-way sync settings, state and recent runs for a site.sites.view
PUT/v1/sites/{siteId}/repo/syncTurn two-way sync on or off for a site.hosting.deploy.manage
POST/v1/sites/{siteId}/repo/sync/resolveClear a held sync by choosing which side wins.hosting.deploy.manage
POST/v1/sites/{siteId}/repo/sync/runSync this site with its repository now.hosting.deploy.manage
GET/v1/sites/{siteId}/resource-usageGet the vendor's own counts of what a package is using.sites.view
POST/v1/sites/{siteId}/retry-provisioningBuild a failed site again.sites.view
GET/v1/sites/{siteId}/scheduled-tasksList a site's scheduled tasks.sites.view
POST/v1/sites/{siteId}/scheduled-tasksSchedule a command on a site.sites.view
DELETE/v1/sites/{siteId}/scheduled-tasks/{taskId}Delete a site's scheduled task.sites.view
PUT/v1/sites/{siteId}/scheduled-tasks/{taskId}Replace a site's scheduled task.sites.view
GET/v1/sites/{siteId}/securityA site's malware state and live findings.—
POST/v1/sites/{siteId}/security/scanScan a site for malware now.—
GET/v1/sites/{siteId}/seo-metricsA hosted site's SEO authority metrics.—
POST/v1/sites/{siteId}/seo-metrics/checkRun an on-demand authority check for a hosted site.—
GET/v1/sites/{siteId}/seo-metrics/historyA hosted site's authority readings over time.—
GET/v1/sites/{siteId}/seo-settingsHow often this site's SEO metrics are checked, and what is shown.—
PUT/v1/sites/{siteId}/seo-settingsChoose the schedule, providers and visible metrics for this site.—
GET/v1/sites/{siteId}/site-blueprint-deployWhat has been deployed onto this site from a blueprint.sites.view
POST/v1/sites/{siteId}/site-blueprint-deployReplace a site's content with a blueprint's.—
GET/v1/sites/{siteId}/sitemapThe site's most recent sitemap crawl.sites.view
POST/v1/sites/{siteId}/sitemapStart a sitemap crawl.sites.panel_access
GET/v1/sites/{siteId}/ssh-keysList a site's authorised SSH keys.sites.view
POST/v1/sites/{siteId}/ssh-keysAuthorise a public key for SSH on a site.sites.view
DELETE/v1/sites/{siteId}/ssh-keys/{handle}Withdraw an authorised SSH key from a site.sites.view
GET/v1/sites/{siteId}/sslGet a site's certificates and HTTPS enforcement.sites.view
POST/v1/sites/{siteId}/sslRequest the free certificate for a site.sites.manage
POST/v1/sites/{siteId}/ssl/externalInstall an SSL certificate the customer obtained elsewhere.sites.manage
PUT/v1/sites/{siteId}/ssl/forceTurn HTTPS enforcement on or off for a site.sites.manage
GET/v1/sites/{siteId}/subdomainsList a site's subdomains.sites.view
POST/v1/sites/{siteId}/subdomainsAdd a subdomain to a site.sites.view
DELETE/v1/sites/{siteId}/subdomains/{subdomainName}Delete a subdomain from a site.sites.view
DELETE/v1/sites/{siteId}/transferWithdraw this site's pending transfer offer.sites.view
GET/v1/sites/{siteId}/transferGet this site's most recent transfer offer.sites.view
POST/v1/sites/{siteId}/transferOffer this site to another organization.sites.view
POST/v1/sites/{siteId}/transfer/previewCheck whether a site could be transferred to another organization.sites.view
GET/v1/sites/{siteId}/usageGet one site's metered visits for the current billing period.—
GET/v1/sites/{siteId}/vendor-snapshotsList a site's vendor restore points.sites.view
POST/v1/sites/{siteId}/vendor-snapshotsTake a vendor restore point for a site.hosting.backup.manage
POST/v1/sites/{siteId}/vendor-snapshots/restoreRestore a site from a vendor restore point.hosting.backup.manage
GET/v1/sites/{siteId}/vitalsGet a site's homepage Core Web Vitals.—
POST/v1/sites/{siteId}/vitals/checksMeasure one page of this site on demand.—
GET/v1/sites/{siteId}/vitals/checks/{checkId}Poll one on-demand page check.—
GET/v1/sites/{siteId}/vitals/historyGet a site's speed history and change timeline.—
GET/v1/sites/{siteId}/web-logsGet the tail of a site's access and error logs.sites.view
GET/v1/sites/{siteId}/website-backupsThe standard backup a site's hosting package currently holds.sites.view
POST/v1/sites/{siteId}/website-backupsTake a standard backup of a site's files and databases.hosting.backup.manage
GET/v1/sites/{siteId}/wordpressGet the WordPress install on a site.sites.view
GET/v1/sites/{siteId}/wordpress/activityWhat changed on this WordPress, and who changed it.sites.view
GET/v1/sites/{siteId}/wordpress/checksumCheck a site's WordPress core files against the published checksums.sites.view
POST/v1/sites/{siteId}/wordpress/checksumRestore a site's modified WordPress core files.sites.view
POST/v1/sites/{siteId}/wordpress/cliRun one allow-listed WP-CLI command on the site.sites.view
GET/v1/sites/{siteId}/wordpress/cronList a site's scheduled WordPress tasks.sites.view
POST/v1/sites/{siteId}/wordpress/cronRun one scheduled task now.sites.view
GET/v1/sites/{siteId}/wordpress/database-checkCheck a site's WordPress database connection.sites.view
GET/v1/sites/{siteId}/wordpress/maintenanceIs the site showing WordPress's maintenance page?sites.view
PUT/v1/sites/{siteId}/wordpress/maintenanceTurn maintenance mode on or off.sites.view
GET/v1/sites/{siteId}/wordpress/pluginsList the plugins installed on a site's WordPress.sites.view
POST/v1/sites/{siteId}/wordpress/pluginsInstall a plugin on a site's WordPress.sites.view
DELETE/v1/sites/{siteId}/wordpress/plugins/{pluginName}Remove a plugin from a site's WordPress.sites.view
PUT/v1/sites/{siteId}/wordpress/plugins/{pluginName}Activate or deactivate a plugin on a site.sites.view
POST/v1/sites/{siteId}/wordpress/plugins/{pluginName}/updateUpdate one plugin to its latest release.sites.view
POST/v1/sites/{siteId}/wordpress/reinstallReinstall the live WordPress on a site.sites.view
GET/v1/sites/{siteId}/wordpress/rolesList the roles a site's WordPress defines.sites.view
POST/v1/sites/{siteId}/wordpress/search-replaceRewrite a string throughout a site's WordPress database.sites.view
GET/v1/sites/{siteId}/wordpress/settingsGet a site's WordPress options.sites.view
PUT/v1/sites/{siteId}/wordpress/settingsSet one WordPress option on a site.sites.view
POST/v1/sites/{siteId}/wordpress/stack-cacheInstall the server-side cache plugin on a site.sites.view
GET/v1/sites/{siteId}/wordpress/stagingGet a site's WordPress staging clones.sites.view
POST/v1/sites/{siteId}/wordpress/stagingCopy a site's live WordPress onto staging.sites.view
POST/v1/sites/{siteId}/wordpress/staging/publishPublish a site's staging WordPress over the live site.sites.view
POST/v1/sites/{siteId}/wordpress/staging/reinstallReinstall the WordPress on a site's staging copy.sites.view
DELETE/v1/sites/{siteId}/wordpress/staging/{cloneId}Delete a site's WordPress staging clone.sites.view
GET/v1/sites/{siteId}/wordpress/themesList the themes installed on a site's WordPress.sites.view
POST/v1/sites/{siteId}/wordpress/themesInstall a theme on a site's WordPress.sites.view
DELETE/v1/sites/{siteId}/wordpress/themes/{themeName}Remove a theme from a site's WordPress.sites.view
PUT/v1/sites/{siteId}/wordpress/themes/{themeName}Activate or deactivate a theme on a site.sites.view
POST/v1/sites/{siteId}/wordpress/themes/{themeName}/updateUpdate one theme to its latest release.sites.view
POST/v1/sites/{siteId}/wordpress/updateUpdate WordPress core on a site.sites.view
GET/v1/sites/{siteId}/wordpress/update-policyWhat this site is set to update by itself, and where it has drifted.sites.view
PUT/v1/sites/{siteId}/wordpress/update-policySet the site's auto-update policy and apply it to WordPress.sites.view
GET/v1/sites/{siteId}/wordpress/usersList the accounts on a site's WordPress.sites.panel_access
POST/v1/sites/{siteId}/wordpress/usersCreate an account on a site's WordPress.sites.view
DELETE/v1/sites/{siteId}/wordpress/users/{wpUserId}Delete an account from a site's WordPress.sites.view
PUT/v1/sites/{siteId}/wordpress/users/{wpUserId}/passwordSet a WordPress account's password.sites.view
PUT/v1/sites/{siteId}/wordpress/users/{wpUserId}/roleChange a WordPress account's role.sites.view
GET/v1/sites/{siteId}/wordpress/vulnerabilitiesPublished advisories against the plugin and theme versions installed here.sites.view
GET/v1/sites/{siteId}/wp-credentialsThe WordPress admin login for a site.sites.view
POST/v1/sites/{siteId}/wp-credentialsGenerate a new WordPress admin password for a site.sites.view
POST/v1/sites/{siteId}/wp-loginMint a one-click WordPress admin login token.sites.wp_login
GET/v1/sites/{site_id}/translationWhether this site is translated, and how far along it is.sites.view
PATCH/v1/sites/{site_id}/translationChoose which languages this site serves to visitors.sites.manage
GET/v1/sites/{site_id}/translation/bundle/{locale}One locale of a site's translated content, for the site itself to render.—
POST/v1/sites/{site_id}/translation/refreshRead the site again now, rather than waiting for the next pass.sites.manage
GET/v1/storage/bucketsThe organisation's object storage buckets.storage.view
POST/v1/storage/bucketsProvision Zinn® storage, or attach a bucket of your own.storage.manage
DELETE/v1/storage/buckets/{bucketId}Forget a bucket.storage.manage
GET/v1/storage/buckets/{bucketId}One bucket.storage.view
GET/v1/transfersList every site transfer this account is a party to.sites.view
POST/v1/transfers/{transferId}/acceptAccept an incoming site transfer.sites.view
POST/v1/transfers/{transferId}/declineDecline an incoming site transfer.sites.view
GET/v1/uptime/monitorsThe web addresses this organisation has asked us to watch.—
POST/v1/uptime/monitorsStart watching a web address.—
DELETE/v1/uptime/monitors/{monitor_id}Stop watching a web address.—
GET/v1/uptime/monitors/{monitor_id}One monitored address, with its history.—
PATCH/v1/uptime/monitors/{monitor_id}Pause, resume or rename a monitored address.—
GET/v1/vector/indexesThe organisation's vector indexes.vector.view
POST/v1/vector/indexesCreate a vector index.vector.manage
DELETE/v1/vector/indexes/{indexId}Delete a vector index and every vector in it.vector.manage
GET/v1/vector/indexes/{indexId}One vector index.vector.view
POST/v1/vector/indexes/{indexId}/queryFind the nearest vectors.vector.manage
POST/v1/vector/indexes/{indexId}/vectorsInsert or replace vectors.vector.manage
POST/v1/vector/indexes/{indexId}/vectors/deleteDelete vectors by id.vector.manage
POST/v1/vector/indexes/{indexId}/vectors/fetchRead vectors back by id.vector.manage
GET/v1/vector/usageVector storage and query usage against the plan.vector.view
GET/v1/wordpress/cli-commandsThe WP-CLI commands the console will run.—
GET/v1/wordpress/overviewCount the caller's whole WordPress estate by posture.sites.view
GET/v1/wordpress/plugin-directorySearch the WordPress plugin directory.sites.view
GET/v1/wordpress/plugin-directory/{slug}One plugin from the WordPress directory.sites.view
POST/v1/wordpress/refreshCollect a named handful of sites in one call.sites.view
GET/v1/wordpress/sitesList every WordPress site the caller owns, across all product lines.sites.view
GET/v1/wordpress/sites/{siteId}One WordPress site's stored posture, with its component listings.sites.view
GET/v1/wordpress/sites/{siteId}/credentialsWho can sign in to this site's WordPress, and where.sites.view
POST/v1/wordpress/sites/{siteId}/credentials/rotateSet a new password on one WordPress administrator, shown once.sites.view
POST/v1/wordpress/sites/{siteId}/refreshAsk this site's platform for its WordPress posture now.—
GET/v1/wordpress/templatesList the WordPress templates a customer may apply.sites.view
GET/v1/wordpress/theme-directorySearch the WordPress theme directory.sites.view
GET/v1/wordpress/theme-directory/{slug}One theme from the WordPress directory.sites.view
domains · 49 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/domain-watchesThe domains this customer is watching — ours, theirs and third parties'.—
POST/v1/domain-watchesWatch a domain — any domain, including one registered elsewhere.—
DELETE/v1/domain-watches/{watchId}Stop watching a domain.—
POST/v1/domain-watches/{watchId}/muteSilence a watched domain's alerts without removing it.—
GET/v1/domainsList the caller's domains.sites.view
POST/v1/domains/checkAuthority metrics for any domain, owned or not.—
GET/v1/domains/checkedThe domains this organisation has checked.—
POST/v1/domains/connectHost DNS for a domain the customer already owns.domains.dns.manage
GET/v1/domains/routesThe registrar routes this organisation can buy a domain through.—
POST/v1/domains/searchSearch domain availability.sites.view
GET/v1/domains/tld-pricingThe TLD price table, flat, in the caller's currency.—
POST/v1/domains/transfer/preflightCheck and price a bulk transfer-in.sites.view
GET/v1/domains/{domainId}Get a domain.—
POST/v1/domains/{domainId}/auth-codeReveal a domain's EPP transfer code.domains.dns.manage
POST/v1/domains/{domainId}/cache/purgePurge a domain's CDN cache.sites.cache.purge
GET/v1/domains/{domainId}/contactsThe registrant contact on public WHOIS for this domain.—
PUT/v1/domains/{domainId}/contactsChange the registrant contact (drives the registrar first).—
GET/v1/domains/{domainId}/delegationWhether a domain's delegation actually points at us.sites.view
POST/v1/domains/{domainId}/delegationCheck the delegation again now, and restart the fast poll.sites.view
DELETE/v1/domains/{domainId}/disconnectStop hosting a connected domain's DNS, and delete its zone.domains.dns.manage
GET/v1/domains/{domainId}/dns/recordsList a page of a domain's DNS records.sites.view
POST/v1/domains/{domainId}/dns/recordsCreate a DNS record.domains.dns.manage
DELETE/v1/domains/{domainId}/dns/records/{recordId}Delete a DNS record.domains.dns.manage
PUT/v1/domains/{domainId}/dns/records/{recordId}Update a DNS record.domains.dns.manage
POST/v1/domains/{domainId}/dns/syncTrigger immediate DNS propagation.domains.dns.manage
GET/v1/domains/{domainId}/email-routingRead a domain's inbound email routing, and what enabling it would cost.sites.view
POST/v1/domains/{domainId}/email-routing/addressesRegister a destination address.domains.dns.manage
DELETE/v1/domains/{domainId}/email-routing/addresses/{addressId}Remove a destination address from the account.domains.dns.manage
PUT/v1/domains/{domainId}/email-routing/catch-allSet what happens to mail matching no other rule.domains.dns.manage
DELETE/v1/domains/{domainId}/email-routing/enabledTurn inbound email routing off for a domain.domains.dns.manage
POST/v1/domains/{domainId}/email-routing/enabledTurn inbound email routing on for a domain.domains.dns.manage
POST/v1/domains/{domainId}/email-routing/rulesAdd a forwarding rule.domains.dns.manage
DELETE/v1/domains/{domainId}/email-routing/rules/{ruleId}Remove a forwarding rule.domains.dns.manage
PUT/v1/domains/{domainId}/email-routing/rules/{ruleId}Change a forwarding rule.domains.dns.manage
GET/v1/domains/{domainId}/index-checkGet a domain's search-index status.—
GET/v1/domains/{domainId}/index-check/historyList a domain's recent search-index checks.—
POST/v1/domains/{domainId}/index-check/runRun a fresh search-index check for a domain.—
GET/v1/domains/{domainId}/nameserversGet a domain's nameservers.sites.view
PUT/v1/domains/{domainId}/nameserversSet a domain's nameservers.domains.dns.manage
GET/v1/domains/{domainId}/premium-dnsWhether Premium DNS can be sold for this domain, and which row to sell.sites.view
GET/v1/domains/{domainId}/registrar-guideWhere and how to change this domain's nameservers.sites.view
POST/v1/domains/{domainId}/registrar-guide/verifyCheck now whether this domain's nameserver change has taken effect.sites.view
GET/v1/domains/{domainId}/registryWhat the public registry says about a domain (the WHOIS card).sites.view
GET/v1/domains/{domainId}/restore-quoteWhat it costs to restore a lapsed domain.sites.view
GET/v1/domains/{domainId}/seo-metricsGet a domain's SEO authority metrics.—
GET/v1/domains/{domainId}/seo-metrics/historyA domain's authority readings over time.—
POST/v1/domains/{domainId}/seo-metrics/refreshFetch a fresh SEO authority reading for a domain.—
GET/v1/domains/{domainId}/settingsGet a domain's registrar settings.sites.view
PUT/v1/domains/{domainId}/settingsChange a domain's registrar settings.domains.dns.manage
tenancy · 7 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/orgsList organizations in scope.—
POST/v1/orgsCreate an organization.—
DELETE/v1/orgs/{orgId}Close an organization.org.delete
GET/v1/orgs/{orgId}Get an organization.—
PATCH/v1/orgs/{orgId}Rename an organization.org.update
POST/v1/orgs/{orgId}/billing-currencyChange what this organization is invoiced in.billing.payment.manage
GET/v1/orgs/{orgId}/closure-planWhat closing this organization would do.—
billing · 36 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
DELETE/v1/accounting/xeroDisconnect this organization's Xero.billing.invoice.manage
GET/v1/accounting/xeroThis organization's connection to its own Xero.billing.view
PATCH/v1/accounting/xeroChange what a connection syncs.billing.invoice.manage
POST/v1/accounting/xero/connectBegin connecting this organization's Xero.billing.invoice.manage
GET/v1/accounting/xero/invoicesWhich of this organization's invoices are in its Xero.billing.view
GET/v1/accounting/xero/oauth/callbackWhere Xero returns the customer after they authorize us.—
POST/v1/accounting/xero/syncPush outstanding invoices to Xero now.billing.invoice.manage
GET/v1/billing/adhoc-chargesThe manual charges on your account, and what you have been billed.billing.view
GET/v1/billing/payment-preferencesHow this account intends to pay.—
PUT/v1/billing/payment-preferencesElect (or stop) paying by crypto.billing.payment.manage
GET/v1/billing/profileGet the organization's billing profile.billing.view
PUT/v1/billing/profileReplace the organization's billing profile.billing.invoice.manage
GET/v1/cdn/creditThe account's prepaid metered-CDN balance, spend cap and top-up settings.billing.view
PATCH/v1/cdn/creditSet the spend cap, or turn auto-top-up on or off.billing.payment.manage
GET/v1/entitlementsWhat this organization's plan grants, and how much of it is used.billing.view
GET/v1/invoicesList the organization's billing documents.billing.view
GET/v1/invoices/{invoiceId}Get one billing document.—
GET/v1/invoices/{invoiceId}/pdfDownload the invoice or credit note as a PDF, in a chosen language.—
GET/v1/payment-methodsList the stored payment methods in scope.—
POST/v1/payment-methodsBegin adding a payment method (on-session).billing.payment.manage
DELETE/v1/payment-methods/{paymentMethodId}Revoke a stored payment method.—
PATCH/v1/payment-methods/{paymentMethodId}Nominate a stored payment method as primary or backup.—
POST/v1/pricing/tax-quoteWhat these net prices look like to this customer, after VAT.—
GET/v1/sla/claimsThe service credits already issued to this organisation.—
POST/v1/sla/claimsClaim the service credit for one monitored site's month.—
GET/v1/sla/periodsRecent months for every monitored site, and what may be claimed.—
GET/v1/sla/policyThe published uptime commitment and its service-credit ladder.—
GET/v1/subscriptionsList the organization's subscriptions.billing.view
POST/v1/subscriptions/{subscriptionId}/auto-renewTurn a subscription's renewal on or off.billing.payment.manage
GET/v1/trialsThis organization's free trial, if it has one.—
POST/v1/trialsStart a free trial on a plan.—
GET/v1/trials/eligibilityCan this organization start a trial on this plan, and on what terms?—
GET/v1/usage/visitsGet the organisation's metered visits and any overage charge.billing.view
POST/v1/webhooks/nowpaymentsIngest a signed NOWPayments IPN.—
POST/v1/webhooks/paypalIngest a signed PayPal webhook event.—
POST/v1/webhooks/stripeIngest a signed Stripe webhook event.—
api-keys · 4 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/api-keysList the organization's API keys.apikeys.manage
POST/v1/api-keysCreate an API key.apikeys.manage
DELETE/v1/api-keys/{apiKeyId}Revoke an API key.apikeys.manage
GET/v1/api-keys/{apiKeyId}Get an API key.—
agency-board · 85 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/agency/board-automation-catalogueWhat a rule can be built out of.—
GET/v1/agency/board-clientsThe organisations a board may be for.org.read
GET/v1/agency/boardsThe agency's project boards.—
POST/v1/agency/boardsCreate a project board.—
DELETE/v1/agency/boards/{boardId}Archive a board.—
GET/v1/agency/boards/{boardId}One board, with its columns, cards and labels.—
PATCH/v1/agency/boards/{boardId}Rename a board or attach a client organisation to it.—
GET/v1/agency/boards/{boardId}/activityThe board's timeline.—
GET/v1/agency/boards/{boardId}/ai/modelsThe models this org may choose from, cheapest first.—
POST/v1/agency/boards/{boardId}/ai/runRun one AI function on this board.—
GET/v1/agency/boards/{boardId}/ai/runsWhat the AI did on this board, refusals included.—
GET/v1/agency/boards/{boardId}/ai/settingsWhat AI this board has turned on.—
PATCH/v1/agency/boards/{boardId}/ai/settingsTurn auto-triage or the standup digest on or off.—
GET/v1/agency/boards/{boardId}/automation-runsEvery rule's history on this board, together.—
GET/v1/agency/boards/{boardId}/automationsThe board's automation rules.—
POST/v1/agency/boards/{boardId}/automationsCreate a rule — when this happens, only if that, then do these.—
DELETE/v1/agency/boards/{boardId}/automations/{ruleId}Delete a rule and its history.—
GET/v1/agency/boards/{boardId}/automations/{ruleId}One rule.—
PATCH/v1/agency/boards/{boardId}/automations/{ruleId}Change a rule, or pause and resume it.—
GET/v1/agency/boards/{boardId}/automations/{ruleId}/runsEvery time this rule was considered — and why it did or did not fire.—
GET/v1/agency/boards/{boardId}/cardsThe board's cards.—
POST/v1/agency/boards/{boardId}/cardsAdd a card.—
DELETE/v1/agency/boards/{boardId}/cards/{cardId}Archive a card.—
GET/v1/agency/boards/{boardId}/cards/{cardId}One card, with its comments and questions.—
PATCH/v1/agency/boards/{boardId}/cards/{cardId}Edit a card.—
GET/v1/agency/boards/{boardId}/cards/{cardId}/attachmentsThe files on a card, with the organisation's storage quota.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/attachmentsAttach a file to a card.—
DELETE/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}Delete a file and its bytes.—
GET/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}The file's bytes, if it has passed a scan.—
PATCH/v1/agency/boards/{boardId}/cards/{cardId}/attachments/{attachmentId}Choose whether the client can see this file.—
GET/v1/agency/boards/{boardId}/cards/{cardId}/checklistThe card's checklist.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/checklistAppend one line to the card's checklist.—
DELETE/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}Remove one checklist item.—
PATCH/v1/agency/boards/{boardId}/cards/{cardId}/checklist/{itemId}Tick or un-tick one checklist item.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/commentsComment on a card.—
PUT/v1/agency/boards/{boardId}/cards/{cardId}/labelsSet the labels on a card.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/moveMove a card to a column and position.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/questionsAsk the client a question about this card.—
POST/v1/agency/boards/{boardId}/cards/{cardId}/restoreTake a card back out of the archive.—
GET/v1/agency/boards/{boardId}/columnsThe board's columns.—
POST/v1/agency/boards/{boardId}/columnsAdd a column.—
DELETE/v1/agency/boards/{boardId}/columns/{columnId}Delete an empty column.—
PATCH/v1/agency/boards/{boardId}/columns/{columnId}Rename a column, change what the client sees, or make it the intake column.—
POST/v1/agency/boards/{boardId}/columns/{columnId}/moveReorder a column in the board's strip.—
GET/v1/agency/boards/{boardId}/event-subscriptionsWhich Zinn® platform events create cards on this board.—
POST/v1/agency/boards/{boardId}/event-subscriptionsTurn a platform event on for this board.—
DELETE/v1/agency/boards/{boardId}/event-subscriptions/{subscriptionId}Stop this event creating cards on this board.—
GET/v1/agency/boards/{boardId}/inbound-endpointsThe URLs n8n, Zapier and Make POST to.—
POST/v1/agency/boards/{boardId}/inbound-endpointsCreate an inbound endpoint.—
DELETE/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}Delete an endpoint and forget its secret.—
GET/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}One inbound endpoint.—
PATCH/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}Rename an endpoint, or pause and resume it.—
POST/v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}/rotateMint a new secret for an inbound endpoint.—
GET/v1/agency/boards/{boardId}/inbound-requestsWhat arrived on this board's endpoints — accepted and refused.—
GET/v1/agency/boards/{boardId}/invitesThe share links for this board.—
POST/v1/agency/boards/{boardId}/invitesMint a copy-paste link to this board.—
DELETE/v1/agency/boards/{boardId}/invites/{inviteId}Revoke a share link, and everybody who joined through it.—
GET/v1/agency/boards/{boardId}/labelsThe board's label vocabulary.—
POST/v1/agency/boards/{boardId}/labelsDefine a label.—
DELETE/v1/agency/boards/{boardId}/labels/{labelId}Delete a label, taking it off every card wearing it.—
PATCH/v1/agency/boards/{boardId}/labels/{labelId}Rename or recolour a label.—
GET/v1/agency/boards/{boardId}/membersWho is on this board, and who has been invited.—
POST/v1/agency/boards/{boardId}/membersPut somebody on a board, or invite them by email.—
DELETE/v1/agency/boards/{boardId}/members/{memberId}Take somebody off a board.—
DELETE/v1/agency/boards/{boardId}/questions/{questionId}Withdraw a question.—
POST/v1/agency/boards/{boardId}/questions/{questionId}Record an answer the agency was given another way.—
GET/v1/agency/boards/{boardId}/viewsThe board's saved views.—
POST/v1/agency/boards/{boardId}/viewsCreate or replace a named cut of the board.—
DELETE/v1/agency/boards/{boardId}/views/{viewId}Delete a saved view.—
GET/v1/agency/boards/{boardId}/webhook-deliveriesWhat we sent, when, and what came back.—
POST/v1/agency/boards/{boardId}/webhook-deliveries/{deliveryId}/replaySend the same payload again.—
GET/v1/agency/boards/{boardId}/webhooksWhere this board POSTs when something happens.—
POST/v1/agency/boards/{boardId}/webhooksAdd an outbound webhook.—
DELETE/v1/agency/boards/{boardId}/webhooks/{webhookId}Delete a webhook and forget its secret.—
GET/v1/agency/boards/{boardId}/webhooks/{webhookId}One webhook subscription.—
PATCH/v1/agency/boards/{boardId}/webhooks/{webhookId}Change a webhook, or pause and resume it.—
POST/v1/agency/boards/{boardId}/webhooks/{webhookId}/rotateMint a new signing secret.—
POST/v1/agency/boards/{boardId}/webhooks/{webhookId}/testSend a signed test delivery now.—
GET/v1/agency/client/boardsBoards my agency has shared with us.—
GET/v1/agency/client/boards/{boardId}The client's view of one board.—
GET/v1/agency/client/boards/{boardId}/activityWhat has happened on the shared board.—
POST/v1/agency/client/boards/{boardId}/cards/{cardId}/commentsComment on a shared card.—
POST/v1/agency/client/boards/{boardId}/questions/{questionId}/answerAnswer a question the agency asked.—
POST/v1/agency/client/boards/{boardId}/requestsRaise a request with the agency.—
POST/v1/board-hooks/{endpointKey}The public inbound door — n8n, Zapier, Make, GitHub.—
compute · 74 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/certificates/ordersThis organisation's certificate orders.sites.view
POST/v1/certificates/ordersStart a certificate order. Spends nothing.billing.payment.manage
DELETE/v1/certificates/orders/{orderId}Cancel an order inside the authority's refund window.billing.payment.manage
GET/v1/certificates/orders/{orderId}One certificate order.sites.view
POST/v1/certificates/orders/{orderId}/refreshAsk the authority where this order actually got to.sites.view
POST/v1/certificates/orders/{orderId}/renewStart the successor order for an expiring certificate.billing.payment.manage
POST/v1/certificates/orders/{orderId}/submitBuy the certificate. This spends money.billing.payment.manage
GET/v1/certificates/productsTLS certificates a customer can buy.sites.view
GET/v1/compute/add-onsWhat can be bought to run ON a Zinn® Private Cloud machine.sites.view
GET/v1/compute/catalogueGet everything the server order screen is built from.sites.view
GET/v1/compute/eligibilityWhether this organisation may buy a machine on our own cloud.sites.view
POST/v1/compute/eligibilitySubmit an organisation for verification.billing.payment.manage
GET/v1/compute/serversList the servers in scope.sites.view
POST/v1/compute/serversOrder a server.sites.view
GET/v1/compute/servers/{serverId}Get one server, with the provider's live state merged in.sites.view
DELETE/v1/compute/servers/{serverId}/add-onCancel this machine's add-on and release its licence.sites.view
GET/v1/compute/servers/{serverId}/add-onThe add-on this machine carries.sites.view
POST/v1/compute/servers/{serverId}/add-onBuy an add-on for this machine.sites.view
GET/v1/compute/servers/{serverId}/backupsA server's automatic backup arrangement.sites.view
POST/v1/compute/servers/{serverId}/backupsTurn a server's automatic backups on or off.billing.payment.manage
GET/v1/compute/servers/{serverId}/backups/tierThe machine's backup tier, and what upgrading would cost.sites.view
POST/v1/compute/servers/{serverId}/backups/tierMove the machine between the standard and extended backup tiers.billing.payment.manage
POST/v1/compute/servers/{serverId}/cancelRetire a server at the provider.sites.view
POST/v1/compute/servers/{serverId}/consoleOpen an out-of-band console onto a server.sites.restart
DELETE/v1/compute/servers/{serverId}/console/allowRevoke every address's console access.sites.restart
POST/v1/compute/servers/{serverId}/console/allowLet one address reach an IP-gated console.sites.restart
GET/v1/compute/servers/{serverId}/firewallA server's network filter.sites.view
PUT/v1/compute/servers/{serverId}/firewallReplace a server's firewall rules.sites.restart
GET/v1/compute/servers/{serverId}/healthRead a server's hardware and live resource usage.sites.view
GET/v1/compute/servers/{serverId}/imagesWhat this machine may be rebuilt to.sites.view
GET/v1/compute/servers/{serverId}/limitsWhat a server may hold.sites.view
POST/v1/compute/servers/{serverId}/nameRename a server.sites.restart
GET/v1/compute/servers/{serverId}/overageWhat this machine owes for bandwidth over its allowance this month.sites.view
GET/v1/compute/servers/{serverId}/packagesList the websites hosted on a server.sites.view
POST/v1/compute/servers/{serverId}/packagesPut a website on a server.—
DELETE/v1/compute/servers/{serverId}/packages/{packageId}Remove a website from a server.sites.delete
GET/v1/compute/servers/{serverId}/planWhat this machine costs, and what else it could have.sites.view
POST/v1/compute/servers/{serverId}/planBuy one paid option for this machine.—
DELETE/v1/compute/servers/{serverId}/plan/{purchaseId}Stop paying for one option — where the provider permits it.billing.payment.manage
POST/v1/compute/servers/{serverId}/powerStart, stop or reboot a server.sites.view
POST/v1/compute/servers/{serverId}/rebuildReinstall a server's operating system.sites.view
POST/v1/compute/servers/{serverId}/renewExtend a server's term.sites.view
GET/v1/compute/servers/{serverId}/renewalRead a server's billing contract.sites.view
POST/v1/compute/servers/{serverId}/resizeMove a server onto another machine size.sites.view
POST/v1/compute/servers/{serverId}/resize/quoteGet what resizing a server would cost, before the charge.sites.view
GET/v1/compute/servers/{serverId}/reverse-dnsThe PTR of every public address on a machine.sites.view
PUT/v1/compute/servers/{serverId}/reverse-dnsPoint one address's PTR at a hostname, or reset it.sites.restart
POST/v1/compute/servers/{serverId}/root-passwordReset a server's root password. ⛔ Reboots the machine.sites.delete
GET/v1/compute/servers/{serverId}/servicesList the services running inside a server.sites.view
POST/v1/compute/servers/{serverId}/services/actionStart, stop or restart one service inside a server.sites.view
GET/v1/compute/servers/{serverId}/snapshotsList a server's on-demand disk images.sites.view
POST/v1/compute/servers/{serverId}/snapshotsTake a snapshot of a server now.billing.payment.manage
DELETE/v1/compute/servers/{serverId}/snapshots/{snapshotId}Delete a snapshot.sites.view
POST/v1/compute/servers/{serverId}/snapshots/{snapshotId}Roll a server back to a snapshot.sites.view
GET/v1/compute/servers/{serverId}/softwareList the software available on a server.sites.view
GET/v1/compute/ssh-keysThe SSH keys this organisation has registered.sites.view
POST/v1/compute/ssh-keysRegister a public key so a future order can install it.billing.payment.manage
DELETE/v1/compute/ssh-keys/{keyId}Forget a registered key.billing.payment.manage
GET/v1/compute/vps/optionsThe paid options a VPS of a given size can carry.sites.view
GET/v1/compute/vps/quoteWhat one configured VPS costs, itemised.sites.view
GET/v1/panels/connectionsThe control panels this organisation has connected.sites.view
POST/v1/panels/connectionsConnect a running Plesk panel so it can be managed from here.connections.manage
DELETE/v1/panels/connections/{connectionId}Disconnect a panel and delete its stored credential.connections.manage
GET/v1/panels/connections/{connectionId}One connected control panel.sites.view
POST/v1/panels/connections/{connectionId}/checkRe-probe what this panel can actually do.connections.manage
GET/v1/panels/connections/{connectionId}/clientsThe customer accounts held on this panel.sites.view
GET/v1/panels/connections/{connectionId}/domainsThe websites this panel is serving.sites.view
POST/v1/panels/connections/{connectionId}/install-licenceInstall a licence we bought onto this panel.connections.manage
POST/v1/panels/connections/{connectionId}/login-linkOne-click login — a one-time administrative session on the panel.—
GET/v1/panels/licencesThe control-panel licences this organisation holds.sites.view
POST/v1/panels/licencesBuy a control-panel licence.billing.payment.manage
DELETE/v1/panels/licences/{licenceId}Release a licence — the only thing that stops the charge.billing.payment.manage
GET/v1/panels/licences/{licenceId}One control-panel licence.sites.view
GET/v1/panels/productsControl-panel editions and extensions a customer can buy.sites.view
ai · 53 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/ai/credentialsThe organization's own AI provider keys.sites.view
POST/v1/ai/credentialsStore an AI provider key for this organization.billing.manage
DELETE/v1/ai/credentials/{credentialId}Stop using an AI provider key.billing.manage
POST/v1/ai/credentials/{credentialId}/testTest a stored AI provider key now.billing.payment.manage
GET/v1/ai/creditsZinn® credit balance, whether to offer more, and the packs for sale.sites.view
PUT/v1/ai/credits/settingsTurn automatic top-up on or off.billing.payment.manage
GET/v1/ai/images/credentialsThe organization's own image-provider keys.sites.view
POST/v1/ai/images/credentialsStore an image-provider key for this organization.billing.manage
DELETE/v1/ai/images/credentials/{credentialId}Stop using an image-provider key.billing.manage
POST/v1/ai/images/credentials/{credentialId}/testCheck an image key now, by generating a real image with it.billing.manage
GET/v1/ai/images/libraryThe images this organisation generated for its own use.sites.view
POST/v1/ai/images/libraryGenerate images from a prompt, with no post involved.links.edit
DELETE/v1/ai/images/library/{imageId}Throw one of your own generated images away.links.edit
GET/v1/ai/images/library/{imageId}/fileDownload the image bytes.sites.view
GET/v1/ai/images/modelsThe image models a recipe may be pointed at.sites.view
GET/v1/ai/images/posts/{postId}The images generated for one content post.sites.view
POST/v1/ai/images/posts/{postId}Generate a featured image and in-post images for a content post.links.edit
GET/v1/ai/images/posts/{postId}/preview/{imageId}The staged bytes of one generated image.sites.view
GET/v1/ai/images/providersWhich image providers this organisation can actually generate with.sites.view
GET/v1/ai/modelsThe live model catalogue.links.view
GET/v1/ai/proposalsWhat the AI agent wants done to this organization's resources.sites.view
POST/v1/ai/proposals/{proposalId}/decisionApprove or reject one proposal.—
POST/v1/ai/proposals/{proposalId}/revertPut an applied change back.—
GET/v1/ai/providersWhich AI vendors are available, and whether this organization can use each.links.view
GET/v1/ai/recipesThis organization's AI posting recipes.links.view
POST/v1/ai/recipesCreate an AI posting recipe.links.edit
DELETE/v1/ai/recipes/{recipeId}Delete an AI posting recipe.links.edit
GET/v1/ai/recipes/{recipeId}One AI posting recipe.links.view
PATCH/v1/ai/recipes/{recipeId}Edit an AI posting recipe.links.edit
POST/v1/ai/recipes/{recipeId}/runQueue an AI posting recipe to run now.links.edit
GET/v1/ai/recipes/{recipeId}/runsWhat an AI posting recipe has produced.links.view
GET/v1/ai/reportsThe AI reports this organization has bought.sites.view
GET/v1/ai/site-agent/allowanceHow many self-serve site checks are left this month.sites.view
GET/v1/ai/site-agent/preferencesWhat this customer lets the AI do to their sites without asking.sites.view
PUT/v1/ai/site-agent/preferencesChoose what the AI may do for one kind of fix.sites.view
POST/v1/ai/site-agent/sites/{site_id}/checkRead this site's server, diagnose it, and fix what the customer allows.sites.view
GET/v1/ai/site-buildsThe organization's AI-built sites, its trial state and its builder spend.sites.view
POST/v1/ai/site-buildsDescribe a site and the AI builds it.sites.create
GET/v1/ai/site-builds/targetsWhere a draft can be published, and what is already on each destination.hosting.deploy.manage
GET/v1/ai/site-builds/{siteBuildId}One AI-built site, with every generated file.sites.view
PUT/v1/ai/site-builds/{siteBuildId}/filesReplace one generated file's contents.sites.create
GET/v1/ai/site-builds/{siteBuildId}/imagesWhat generating this draft's images would cost. Spends nothing.sites.create
POST/v1/ai/site-builds/{siteBuildId}/imagesDraw the draft's images. Charges the content-images meter.sites.create
POST/v1/ai/site-builds/{siteBuildId}/plugin-planWhich plugins this generated site needs, and a custom one if it needs that.sites.create
POST/v1/ai/site-builds/{siteBuildId}/previewWhat publishing this draft would do to that site. Changes nothing.hosting.deploy.manage
GET/v1/ai/site-builds/{siteBuildId}/publicationsEvery attempt to publish this draft, newest first.sites.view
POST/v1/ai/site-builds/{siteBuildId}/publicationsPublish a draft to a destination, taking a backup first when it destroys.hosting.deploy.manage
POST/v1/ai/site-builds/{siteBuildId}/publishPut an AI-built site live on one of the organization's sites.hosting.deploy.manage
POST/v1/ai/site-builds/{siteBuildId}/rebuildBuild the site again from its brief, optionally tweaked.sites.create
DELETE/v1/ai/site-publications/{publicationId}Stop a publication that has not finished.hosting.deploy.manage
GET/v1/ai/site-publications/{publicationId}How far a publication has got.sites.view
GET/v1/ai/subscriptionsWhich sites hold a recurring AI product, and when it next runs.sites.view
GET/v1/ai/summaryThe organization's AI position — balance, funding route, usage.sites.view
marketplace · 48 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/marketplace/conversationsEvery thread this org is in, on either side.—
GET/v1/marketplace/listing-typesThe kinds of Zinn® this account may sell.—
GET/v1/marketplace/listing-types/{key}/schemaThe public field schema for a kind of Zinn®.—
GET/v1/marketplace/listingsThe Zinn®s this account sells.—
POST/v1/marketplace/listingsStart a Zinn®.—
GET/v1/marketplace/listings/{listing_id}One of this account's Zinn®s, with the schema it is authored against.—
PATCH/v1/marketplace/listings/{listing_id}Edit a Zinn®, or publish it.—
GET/v1/marketplace/listings/{listing_id}/enquiriesThe pre-sales conversation about one listing.—
POST/v1/marketplace/listings/{listing_id}/enquiriesAsk a seller a question before buying.—
GET/v1/marketplace/listings/{listing_id}/imagesA listing's images, and the limits an upload must satisfy.—
POST/v1/marketplace/listings/{listing_id}/imagesUpload one image to a listing.—
DELETE/v1/marketplace/listings/{listing_id}/images/{image_id}Remove an image, and its stored object.—
PATCH/v1/marketplace/listings/{listing_id}/images/{image_id}Set the alt text, the gallery position, or make this the cover.—
GET/v1/marketplace/listings/{listing_id}/packagesWhat a buyer can actually buy on this Zinn®.—
PUT/v1/marketplace/listings/{listing_id}/packagesReplace the whole package list.—
GET/v1/marketplace/listings/{listing_id}/revealThe identifying value behind the mask (authenticated).—
GET/v1/marketplace/orders/{sale_id}The order workspace — one order, from your side of it.—
POST/v1/marketplace/orders/{sale_id}/handover/{item_id}Tick one handover item — from your side of the order.—
GET/v1/marketplace/orders/{sale_id}/messagesThe order chat.—
POST/v1/marketplace/orders/{sale_id}/messagesSend a message on an order.—
POST/v1/marketplace/orders/{sale_id}/messages/previewAssess a draft before it is sent — the inline nudge.—
POST/v1/marketplace/orders/{sale_id}/requirementsThe buyer's brief — and the thing that starts the delivery clock.—
GET/v1/marketplace/overviewThe marketplace hub — every vertical, the latest Zinn®s, what recently sold.—
GET/v1/marketplace/purchasesEverything this org has bought on the marketplace.—
GET/v1/marketplace/purchases/{sale_id}One purchase, as the buyer sees it.—
POST/v1/marketplace/purchases/{sale_id}/acceptAccept delivery — the act that releases the seller's money.—
POST/v1/marketplace/purchases/{sale_id}/revisionSend the delivery back, and say what is wrong.—
GET/v1/marketplace/vendor/ledgerWhat the seller is owed, and what is still being held.—
GET/v1/marketplace/vendor/payout-methodsWhere this seller can be paid, and the rails they may choose.—
POST/v1/marketplace/vendor/payout-methodsPropose a destination to be paid at.—
DELETE/v1/marketplace/vendor/payout-methods/{method_id}Stop using a destination.—
POST/v1/marketplace/vendor/payout-methods/{method_id}Show that the destination belongs to you.—
GET/v1/marketplace/vendor/payout-readinessWhether money may leave the platform to this seller, and why not.—
GET/v1/marketplace/vendor/payoutsWhat has been paid out, and what is being held.—
GET/v1/marketplace/vendor/profileWhether this account sells on the marketplace, and where its file is.—
POST/v1/marketplace/vendor/profileBecome a Zinner®.—
GET/v1/marketplace/vendor/salesEverything this org has sold on the marketplace.—
POST/v1/marketplace/vendor/sales/{sale_id}/deliverMark the work delivered — starts the buyer's acceptance window.—
GET/v1/marketplace/vendor/verificationThe seller's identity file and what it still needs.—
PUT/v1/marketplace/vendor/verificationOpen the identity file on a track, or edit it.—
POST/v1/marketplace/vendor/verification/documentsReserve a document slot and get a short-lived upload URL.—
GET/v1/marketplace/vendor/verification/documents/{document_id}/urlA short-lived URL that downloads one identity document.—
POST/v1/marketplace/vendor/verification/subjectsAdd a natural person to the identity file.—
DELETE/v1/marketplace/vendor/verification/subjects/{subject_id}Remove a person from a file that is still editable.—
POST/v1/marketplace/vendor/verification/submitHand the identity file to review.—
GET/v1/marketplace/verticalsThe marketplace verticals a buyer can browse.—
GET/v1/marketplace/{vertical}/searchFilter, sort and page one vertical's live Zinn®s.—
GET/v1/marketplace/{vertical}/{slug}One live Zinn®, as anyone sees it.—
links · 39 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/connector/claimRedeem a pairing code — called by the Zinn® WordPress connector plugin.—
GET/v1/content/external-sitesWordPress sites you connected that we do not host.—
POST/v1/content/external-sitesConnect a WordPress site we do not host, with an application password.—
POST/v1/content/external-sites/pairingA one-time code for the Zinn® connector plugin.—
POST/v1/content/external-sites/{siteId}/verifyRe-check the credential on one connected external site, now.—
GET/v1/content/link-setsYour reusable link sets — the URLs you build links to, and the words for each.—
POST/v1/content/link-setsCreate a link set.—
DELETE/v1/content/link-sets/{linkSetId}Delete a link set no recipe is using.—
GET/v1/content/link-sets/{linkSetId}One link set, with its resolved distribution.—
PATCH/v1/content/link-sets/{linkSetId}Rename a link set, archive it, or replace its links.—
DELETE/v1/content/placements/{placementId}Cancel a scheduled publication.—
GET/v1/content/postsThe organisation's content library.—
POST/v1/content/postsWrite a new post.—
POST/v1/content/posts/generateWrite article drafts with the model.—
DELETE/v1/content/posts/{postId}Delete a post that is not live anywhere.—
GET/v1/content/posts/{postId}One post.—
GET/v1/content/posts/{postId}/placementsWhere this post is scheduled or live.—
POST/v1/content/posts/{postId}/placementsSchedule this post onto one of your sites.—
GET/v1/content/run-schedulesRepeating posting runs.—
POST/v1/content/run-schedulesPost to these sites every N hours.—
DELETE/v1/content/run-schedules/{scheduleId}Delete a cadence.—
PATCH/v1/content/run-schedules/{scheduleId}Change or pause a cadence.—
GET/v1/content/runsMulti-site AI posting runs.—
POST/v1/content/runsStart a multi-site posting run.—
GET/v1/content/runs/{runId}One run, with every site's outcome.—
POST/v1/content/runs/{runId}/resumeRetry the sites that failed — never the ones that worked.—
GET/v1/content/target-presetsThe headless CMS products we can publish to, and what each can carry.—
GET/v1/content/targetsWhich of your sites can receive a post, and why the rest cannot.—
GET/v1/content/targets/facetsFilter counts over the whole matching set, not the current page.—
POST/v1/content/targets/probeRe-check, for real, whether these sites can receive a post.—
GET/v1/link-editsBulk edits this organisation has run.—
POST/v1/link-editsChange or remove a target's links across the network.—
GET/v1/link-edits/{editId}One bulk edit, and what happened on every site.—
POST/v1/link-edits/{editId}/undoPut back exactly what a bulk edit replaced.—
GET/v1/link-targetsThe Link Tracker report — domains this org's sites link out to.—
GET/v1/link-targets/{targetId}One target, and which of the customer's sites link to it.—
GET/v1/link-targets/{targetId}/edit-previewHow many links, posts and sites a bulk edit would change.—
GET/v1/link-targets/{targetId}/placementsEvery link to this target, in every post, with its occurrence count.—
POST/v1/site-links/ingestReceive one batch of a site's outbound-link scan (signed webhook).—
public · 27 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/pluginsEverything Zinn® publishes for you to install, at its current version.—
GET/v1/plugins/{slug}One plugin's current release.—
GET/v1/plugins/{slug}/downloadThe installable plugin zip.—
GET/v1/public/boards/shared/{shareToken}Open a board someone shared with you. No account needed.—
POST/v1/public/boards/shared/{shareToken}/joinTake the seat a share link grants you.—
POST/v1/public/cartOpen an anonymous cart.—
GET/v1/public/cart/{token}Get an anonymous cart.—
POST/v1/public/cart/{token}/itemsAdd a domain to an anonymous cart.—
DELETE/v1/public/cart/{token}/items/{itemId}Remove an item from an anonymous cart.—
POST/v1/public/cart/{token}/planAdd a hosting plan, or a free trial of one, to an anonymous cart.—
POST/v1/public/cart/{token}/serverAdd one cloud machine to an anonymous cart.—
POST/v1/public/checkoutCheck out as a guest — create the account and place the order.—
GET/v1/public/domains/nameserver-checkWhich registrar holds a domain, what to enter, and whether it has taken effect.—
POST/v1/public/domains/searchSearch domain availability without an account.—
POST/v1/public/domains/suggestAlternative domains worth offering alongside a search.—
GET/v1/public/domains/tld-pricingThe public, searchable TLD price table.—
GET/v1/public/domains/whoisFree public WHOIS lookup for any domain.—
GET/v1/public/kbBrowse or search the knowledge base.—
GET/v1/public/kb/categoriesList the knowledge-base sections.—
GET/v1/public/kb/slugsEvery published article's URL segment, in every locale.—
GET/v1/public/kb/{slug}Read one knowledge-base article.—
GET/v1/public/payment-configThe publishable key and enabled gateways, for a browser.—
POST/v1/public/pricing/tax-quoteWhat these net prices look like to a signed-out visitor, after VAT.—
GET/v1/public/status/confirmConfirm an email subscription to the status page.—
POST/v1/public/status/subscribeAsk for email updates from the public status page.—
GET/v1/public/status/unsubscribeStop receiving status emails.—
POST/v1/wp/plugin-update/{siteId}What an installed Zinn® plugin polls for updates.—
mail · 25 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/mail/allowanceWhat the caller's plan grants for mailboxes.mail.view
DELETE/v1/mail/mailboxes/{mailboxId}Delete a mailbox.mail.manage
PUT/v1/mail/mailboxes/{mailboxId}Change a mailbox's size, or its send/receive switches.mail.manage
POST/v1/mail/mailboxes/{mailboxId}/passwordReset a mailbox password.mail.manage
POST/v1/mail/mailboxes/{mailboxId}/renameChange a mailbox's address, keeping the mail in it.mail.manage
POST/v1/mail/mailboxes/{mailboxId}/webmailOpen webmail for a mailbox.mail.manage
GET/v1/mail/preflightWhat setting email up on a domain would do to its DNS.mail.view
GET/v1/mail/servicesList the organization's email services.mail.view
POST/v1/mail/servicesSet email up on a domain.mail.manage
DELETE/v1/mail/services/{mailServiceId}Remove a domain's email service.mail.manage
GET/v1/mail/services/{mailServiceId}Get one email service.mail.view
GET/v1/mail/services/{mailServiceId}/connection-settingsIMAP and SMTP settings for a mail client.mail.view
GET/v1/mail/services/{mailServiceId}/deliverabilitySPF, DKIM and DMARC state for a domain that already has email.mail.view
POST/v1/mail/services/{mailServiceId}/deliverabilityPublish this domain's mail records.mail.manage
GET/v1/mail/services/{mailServiceId}/forwardersThe forwarders on this domain.mail.view
POST/v1/mail/services/{mailServiceId}/forwardersForward an address, a catch-all, or a whole domain.mail.manage
DELETE/v1/mail/services/{mailServiceId}/forwarders/{forwarderId}Remove a forwarder.mail.manage
GET/v1/mail/services/{mailServiceId}/mailboxesList a domain's mailboxes.mail.view
POST/v1/mail/services/{mailServiceId}/mailboxesCreate a mailbox.mail.manage
POST/v1/mail/services/{mailServiceId}/providerMove a domain's email to a different provider.mail.manage
GET/v1/mail/services/{mailServiceId}/respondersThe auto-responders on this domain.mail.view
POST/v1/mail/services/{mailServiceId}/respondersSet an auto-reply on a mailbox.mail.manage
DELETE/v1/mail/services/{mailServiceId}/responders/{responderId}Remove an auto-reply.mail.manage
PATCH/v1/mail/services/{mailServiceId}/responders/{responderId}Edit an auto-reply.mail.manage
POST/v1/mail/services/{mailServiceId}/retryRetry a mail service whose setup failed.mail.manage
board-github · 20 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/board-github/discoverList the GitHub Projects a credential can see.—
GET/v1/board-github/linksThe GitHub Projects this organisation has connected.—
POST/v1/board-github/linksConnect a GitHub Project to this organisation.—
DELETE/v1/board-github/links/{linkId}Disconnect a GitHub Project.—
GET/v1/board-github/links/{linkId}One connection, with its WIP report and its open notices.—
PATCH/v1/board-github/links/{linkId}Change a connection's sync direction or the board it sits alongside.—
GET/v1/board-github/links/{linkId}/conflictsEvery field whose value was overwritten by the sync.—
PUT/v1/board-github/links/{linkId}/fields/{fieldId}/wipSet an advisory WIP limit on one status option.—
GET/v1/board-github/links/{linkId}/itemsThe items on a connected project.—
POST/v1/board-github/links/{linkId}/itemsPost a new item to the GitHub Project from our UI.—
DELETE/v1/board-github/links/{linkId}/items/{itemId}Remove an item from the GitHub Project, permanently.—
PUT/v1/board-github/links/{linkId}/items/{itemId}/archiveArchive a GitHub Project item, or restore it.—
PUT/v1/board-github/links/{linkId}/items/{itemId}/cardAttach a GitHub item to a board card, or detach it.—
PUT/v1/board-github/links/{linkId}/items/{itemId}/fieldSet or clear one field value on a GitHub Project item.—
POST/v1/board-github/links/{linkId}/syncRefresh one connection from GitHub now.—
GET/v1/board-github/links/{linkId}/webhookThe payload URL and signing secret for a connection the customer configures.—
POST/v1/board-github/links/{linkId}/webhookTry again to create the webhook on GitHub, and mint a fresh secret.—
GET/v1/board-github/roadmapA dated timeline across every linked GitHub Project.—
GET/v1/board-github/rollupEvery linked GitHub Project, summed into one view.—
POST/v1/board-github/webhook/{endpointKey}One GitHub webhook delivery for a linked project.—
commerce · 19 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/cartsOpen a shopping cart.billing.payment.manage
POST/v1/carts/adoptCarry a guest basket into the signed-in account.billing.payment.manage
GET/v1/carts/{cartId}Get a cart.—
POST/v1/carts/{cartId}/checkoutCheck out a cart — place and charge an order.billing.payment.manage
POST/v1/carts/{cartId}/linesAdd a line to a cart.—
DELETE/v1/carts/{cartId}/lines/{lineId}Remove a line from a cart.—
GET/v1/ordersList orders in scope.billing.view
GET/v1/orders/{orderId}Get an order.—
POST/v1/orders/{orderId}/customer-actionReopen the checkout for a payment that is waiting on the customer.—
POST/v1/orders/{orderId}/payPay an order that was placed but not charged.—
GET/v1/orders/{orderId}/payment-optionsThe payment gateways this order may be settled on.—
POST/v1/orders/{orderId}/paypalOpen a PayPal order for the browser to complete.—
POST/v1/orders/{orderId}/paypal/captureCapture a PayPal order the buyer completed.—
GET/v1/orders/{orderId}/refund-eligibilityPreview an order's refund eligibility.billing.view
POST/v1/orders/{orderId}/refund-requestRequest a refund for an order.billing.payment.manage
GET/v1/refund-requestsList the organization's refund requests.billing.view
GET/v1/refund-requests/{refundRequestId}Get a refund request.billing.view
POST/v1/refund-requests/{refundRequestId}/approveApprove a pending refund request (staff).—
POST/v1/refund-requests/{refundRequestId}/rejectReject a pending refund request (staff).billing.refund
Campaigns · 18 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/campaignsThe organisation's campaigns.—
POST/v1/campaignsCreate a campaign from a template and an audience.—
DELETE/v1/campaigns/espDisconnect the provider account and remove its stored key.—
GET/v1/campaigns/espThe organisation's own e-mail provider account.—
POST/v1/campaigns/espConnect an e-mail provider account.—
POST/v1/campaigns/esp/verifyProve the provider account works and read its verified domains.—
POST/v1/campaigns/previewRender a template with example values.—
GET/v1/campaigns/tagsThe magic-tag palette a campaign composer offers.—
GET/v1/campaigns/templatesThe organisation's campaign templates.—
POST/v1/campaigns/templatesAuthor a campaign template.—
DELETE/v1/campaigns/templates/{templateId}Archive a template and retire its translation sources.—
GET/v1/campaigns/templates/{templateId}One campaign template.—
PUT/v1/campaigns/templates/{templateId}Edit a campaign template.—
DELETE/v1/campaigns/{campaignId}Delete a campaign and retire its delivery rows.—
GET/v1/campaigns/{campaignId}One campaign and its delivery report.—
POST/v1/campaigns/{campaignId}/controlPause, resume or cancel a running send.—
POST/v1/campaigns/{campaignId}/sendStart the durable send.—
POST/v1/campaigns/{campaignId}/testSend one real message on the channel the campaign will actually use.—
notifications · 14 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/notification-connectionsConnected destinations and the routing matrix.—
POST/v1/notification-connectionsConnect a destination.—
GET/v1/notification-connections/confirmWhat a confirmation link is asking.—
POST/v1/notification-connections/confirmConfirm you want an organisation's notifications at this address.—
DELETE/v1/notification-connections/{connection_id}Disconnect a destination.—
POST/v1/notification-connections/{connection_id}/verifySend a real test message to a destination.—
GET/v1/notification-preferencesWhat you want to hear about, by topic.—
PUT/v1/notification-preferencesTurn a topic's mail on or off.—
PUT/v1/notification-routesTurn a notification topic on or off for one destination.—
DELETE/v1/outbound-mailRemove this organisation's own mail service.—
GET/v1/outbound-mailThe mail service this organisation sends through.—
PUT/v1/outbound-mailAttach or replace this organisation's own mail service.—
POST/v1/outbound-mail/testSend a real message through your provider, carrying a one-time code.—
POST/v1/outbound-mail/verifyEnter the code from the test message.—
syndication · 14 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/syndication/channelsEvery social channel the platform can post to.—
GET/v1/syndication/connectionsThe organisation's connected social accounts.—
POST/v1/syndication/connectionsConnect a social account.—
DELETE/v1/syndication/connections/{connectionId}Disconnect an account.—
PUT/v1/syndication/connections/{connectionId}Rename a connection or replace its credential.—
POST/v1/syndication/connections/{connectionId}/verifyCheck a connection against the live channel.—
GET/v1/syndication/plansWhich channels articles go to, and how.—
POST/v1/syndication/plansSave a syndication plan.—
DELETE/v1/syndication/plans/{planId}Remove a plan.—
PUT/v1/syndication/plans/{planId}Change a plan's channels or behaviour.—
PUT/v1/syndication/posts/{postId}Change a held post's copy before it goes out.—
POST/v1/syndication/posts/{postId}/{action}Approve, reject or retry one channel's post.—
GET/v1/syndication/runsWhat has been announced, and what is waiting for approval.—
GET/v1/syndication/runs/{runId}One article's fan-out.—
access · 13 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/access/impersonation/currentThe current impersonation status (drives the banner).—
POST/v1/access/impersonation/endExit the current impersonation session (revoke).—
POST/v1/access/impersonation/redeemExchange a single-use impersonation ticket for a session token.—
GET/v1/orgs/{orgId}/auth-policyRead an org's authentication policy.org.read
PUT/v1/orgs/{orgId}/auth-policySet an org's authentication policy (require MFA).org.update
GET/v1/orgs/{orgId}/membersList the people in an organization.members.read
DELETE/v1/orgs/{orgId}/members/{userId}Remove a member and offboard them (docs/35members.remove
PATCH/v1/orgs/{orgId}/members/{userId}Change a member's role.members.role.assign
GET/v1/orgs/{orgId}/rolesList the roles the caller may grant in an organization.members.read
GET/v1/sites/{siteId}/collaborator-rolesThe per-site roles that may be granted here.—
GET/v1/sites/{siteId}/collaboratorsWho this site is shared with.—
POST/v1/sites/{siteId}/collaboratorsShare this site with one person.—
DELETE/v1/sites/{siteId}/collaborators/{grantId}Revoke one person's access to this site.—
support · 12 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/sites/{siteId}/diagnoseRun the support AI against one site — check it, fix what is fixable, record the rest.hosting.php.manage
GET/v1/sites/{siteId}/support-recommendationsWhat the support AI has advised about this site, and whether it was acted on.sites.view
GET/v1/status/affectingOpen status incidents that affect the caller's own services.—
GET/v1/ticketsList the organization's support tickets.tickets.view
POST/v1/ticketsOpen a support ticket.tickets.reply
POST/v1/tickets/deflectKnowledge-base articles and a live diagnosis, before a ticket is opened.tickets.reply
GET/v1/tickets/{ticketId}Get a support ticket and its thread.tickets.view
GET/v1/tickets/{ticketId}/attachments/{attachmentId}Download a ticket attachment.tickets.view
POST/v1/tickets/{ticketId}/closeClose a support ticket.tickets.reply
POST/v1/tickets/{ticketId}/messagesReply to a support ticket.tickets.reply
POST/v1/tickets/{ticketId}/messages/{messageId}/attachmentsAttach a file to a ticket message.tickets.reply
POST/v1/webhooks/inbound-emailIngest a customer's support reply from the mail edge.—
visibility · 12 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/visibility/audits/{auditId}One audit, with every finding.—
GET/v1/visibility/planWhat visibility add-ons this organisation holds.—
GET/v1/visibility/targetsList the domains this organisation is watching.—
POST/v1/visibility/targetsWatch a new domain.—
DELETE/v1/visibility/targets/{targetId}Stop watching a domain.—
PATCH/v1/visibility/targets/{targetId}Change a watched domain's settings.—
GET/v1/visibility/targets/{targetId}/auditsA watched domain's audit history.—
GET/v1/visibility/targets/{targetId}/backlink-linksThe individual inbound links for a watched domain.—
PUT/v1/visibility/targets/{targetId}/keywordsSet the search phrases to track positions for.—
PUT/v1/visibility/targets/{targetId}/productsSet the products to price-track, and the seller names to look for.—
PUT/v1/visibility/targets/{targetId}/review-profilesConfirm which review profiles belong to this business.—
POST/v1/visibility/targets/{targetId}/runRun an audit now.—
connections · 11 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/connections/providersEvery provider a customer can connect, with its form and its checklist.—
GET/v1/connections/{provider}List the org's connected accounts for one provider.connections.manage
POST/v1/connections/{provider}Validate or store a provider access token.connections.manage
DELETE/v1/connections/{provider}/{connectionId}Disconnect a provider account.connections.manage
POST/v1/connections/{provider}/{connectionId}/probeRe-test a stored credential, one row per permission.connections.manage
GET/v1/inference/deploymentsThe organisation's model deployments and what is actually serving.—
GET/v1/inference/flavoursThe GPU shapes the organisation's inference account may deploy on.—
GET/v1/streaming/streamsThe organisation's live streaming channels.—
GET/v1/streaming/videosThe organisation's stored, transcoded video.—
GET/v1/waap/domainsDomains protected by the organisation's WAAP account, and what the policy did.—
POST/v1/waap/domains/{domainId}/modeSwitch a protected domain between monitor, block and off.—
campaigns · 10 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/campaigns/segmentsYour saved audience segments.—
POST/v1/campaigns/segmentsSave a new audience segment.—
GET/v1/campaigns/segments/fieldsThe filter vocabulary, its value lists and the magic tags.—
POST/v1/campaigns/segments/previewHow many people this reaches, who they are, and who it leaves out.—
DELETE/v1/campaigns/segments/{segmentId}Archive a segment.—
GET/v1/campaigns/segments/{segmentId}One saved segment.—
PATCH/v1/campaigns/segments/{segmentId}Rename a segment or change its filters.—
GET/v1/campaigns/suppressionsAddresses that must not receive marketing.—
POST/v1/campaigns/suppressionsAdd an address to the suppression list.—
POST/v1/campaigns/unsubscribeLeave a marketing list. No account needed.—
databases · 10 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/databasesThe organisation's managed databases.—
POST/v1/databasesValidate a managed database, and say where to buy it.—
GET/v1/databases/catalogueThe managed-database sizes and engine versions on sale.—
DELETE/v1/databases/{databaseId}Delete a managed database and its backups.—
GET/v1/databases/{databaseId}One managed database.—
GET/v1/databases/{databaseId}/allowed-ipsWhich sources may connect to this database.—
POST/v1/databases/{databaseId}/allowed-ipsPermit a source address or range to connect.—
DELETE/v1/databases/{databaseId}/allowed-ips/{ruleId}Revoke a source's access.—
POST/v1/databases/{databaseId}/credentialsReveal the database password.—
POST/v1/databases/{databaseId}/upgradeMove the database to a newer PostgreSQL major.—
catalog · 8 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/catalog/app/plansList the plans a signed-in customer may buy, including unadvertised ones.—
GET/v1/catalog/app/product-linesList the product lines a signed-in customer may buy, including unadvertised ones.—
GET/v1/catalog/computeList the sellable cloud machine sizes.—
GET/v1/catalog/compute/own-cloudList the Zinn® Private Cloud sizes, with a "from" price and the cities they run in.—
GET/v1/catalog/fx-ratesList the current FX rates vs the USD base.—
GET/v1/catalog/php-versionsList the PHP versions offered to new sites.—
GET/v1/catalog/plansList the sellable plans with their prices.—
GET/v1/catalog/product-linesList the active product lines.—
identity · 7 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/brandingThe brand this customer's panel renders under.—
GET/v1/branding/by-panel-hostnameThe brand served on one panel hostname.—
GET/v1/branding/font-file/{sha256}One stored webfont file.—
GET/v1/branding/font/{family}.cssThe `@font-face` rules for a self-hosted family.—
GET/v1/branding/logo/{sha256}One brand logo, as an image.—
GET/v1/meGet the authenticated principal.—
PATCH/v1/meSet this person's language and display currency.—
localization · 7 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/i18n/bundles/{locale}Get every translated string for one locale.—
GET/v1/i18n/catalogues/{locale}Get the public site's UI message catalogue for one locale.—
GET/v1/i18n/document-sets/{locale}Get several marketing documents' finished translations in one call.—
GET/v1/i18n/documents/{locale}Get one marketing document's finished translations.—
GET/v1/i18n/slugsGet translated URL slugs for every locale.—
POST/v1/i18n/sourcesRegister translatable source fields (batch).—
GET/v1/session/offeringThe currencies and languages this viewer may be shown.—
mcp · 7 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/.well-known/oauth-protected-resourceOAuth 2.1 protected-resource metadata for the MCP server (RFC 9728).—
POST/v1/mcpThe MCP JSON-RPC 2.0 protocol endpoint.—
GET/v1/mcp/connectionsList the organization's MCP connections.mcp.manage
POST/v1/mcp/connectionsCreate an MCP connection (Connect AI tool).mcp.manage
DELETE/v1/mcp/connections/{connectionId}Revoke an MCP connection.mcp.manage
GET/v1/mcp/connections/{connectionId}Get an MCP connection.—
GET/v1/mcp/scopesThe permissions worth granting an AI tool.mcp.manage
assistant · 6 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/assistant/conversationsList your own assistant conversations.tickets.reply
POST/v1/assistant/conversationsStart a new assistant conversation.tickets.reply
DELETE/v1/assistant/conversations/{conversationId}Delete a conversation and everything in it.—
GET/v1/assistant/conversations/{conversationId}Read one conversation with its full thread.—
POST/v1/assistant/conversations/{conversationId}/escalateTurn a conversation into a support ticket.tickets.reply
POST/v1/assistant/conversations/{conversationId}/messagesAsk the assistant a question and get its answer.tickets.reply
platform-transfers · 6 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/platform-transfersYour organisation's platform transfers.billing.view
POST/v1/platform-transfersBook a platform transfer (nothing is charged yet).billing.view
GET/v1/platform-transfers/platformsPlatforms we can move a store from, and the ones we can move it to.billing.view
POST/v1/platform-transfers/quotePrice a transfer without buying it.billing.view
GET/v1/platform-transfers/{transferId}One transfer and its progress.—
POST/v1/platform-transfers/{transferId}/payPay for a transfer and queue it for a specialist.billing.payment.manage
Inbox · 5 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/inbox/read-allMark every message in the inbox read.—
GET/v1/inbox/threadsThe inbox — one row per conversation, newest first.—
GET/v1/inbox/threads/{threadKey}One conversation, oldest message first.—
POST/v1/inbox/threads/{threadKey}Mark a conversation read, or archive it.—
GET/v1/inbox/unreadThe number the header badge renders.—
affiliate · 5 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/affiliateYour affiliate account, your earnings, and the lines you can choose from.—
PATCH/v1/affiliateChange your commission line or how you are paid.—
POST/v1/affiliateJoin the affiliate programme.—
GET/v1/affiliate/commissionsYour earnings ledger.—
GET/v1/affiliate/referralsThe customers who signed up through your links.—
members · 5 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/members/invitationsList pending member invitations in scope.members.read
POST/v1/members/invitationsInvite an email to join an organization with a role.members.invite
GET/v1/members/invitations/mineList the caller's own pending invitations.—
DELETE/v1/members/invitations/{invitationId}Revoke a pending invitation.members.invite
POST/v1/members/invitations/{invitationId}/acceptAccept an invitation addressed to your email.—
extras · 4 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/extra-purchasesList the organization's extra purchases.billing.view
GET/v1/extra-purchases/{purchaseId}Get an extra purchase.billing.view
GET/v1/extrasList purchasable services.billing.view
POST/v1/extras/{code}/purchasePurchase an extra service.billing.payment.manage
fleet · 4 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
POST/v1/fleet/commands/{commandId}/resultReport how a claimed host command ended.—
POST/v1/fleet/drainTake this host out of placement on graceful shutdown.—
POST/v1/fleet/heartbeatStamp fleet liveness, ship the host report, collect queued commands.—
POST/v1/fleet/registerAttach a booting agent to its declared fleet host.—
notices · 4 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/alertsEvery open alert for this customer, most urgent first.—
POST/v1/alerts/readThe customer has seen these alerts.—
GET/v1/noticesThe notices to show at the top of this screen.—
POST/v1/notices/{noticeId}/dismissThe customer closed a notice.—
security · 4 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/ip-allowWhich addresses may open a shell on your sites.—
POST/v1/ip-allowAllow an address or range.—
DELETE/v1/ip-allow/{entry_id}Remove an entry.—
PATCH/v1/ip-allow/{entry_id}Change an entry.—
seo · 3 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/seo/providersWhich SEO data providers this account can use, and on whose key.—
GET/v1/seo/quotaThe research allowance for this account.—
POST/v1/seo/quota/top-upBuy extra domain lookups.—
surveys · 3 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/feature-flagsEvery feature flag that is ON for this person in this organisation.org.read
GET/v1/surveys/activeThe surveys this organisation may currently be shown.org.read
POST/v1/surveys/{survey_id}/responsesRecord one person's answers to one survey.org.read
audit · 1 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/auditRead the organization's audit log.audit.read
offers · 1 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/v1/offersThe upsells this customer has earned, best first.sites.view
system · 1 เอนด์พอยต์
วิธีการเส้นทางวิธีการใช้งานสิทธิ์การใช้งาน
GET/healthzLiveness/health probe.—

เราใช้คุกกี้วิเคราะห์เพื่อทำความเข้าใจว่าเว็บไซต์ถูกใช้งานอย่างไร คุกกี้เหล่านี้จะถูกตั้งค่าก็ต่อเมื่อคุณยอมรับเท่านั้น นโยบายการใช้คุกกี้