extras
GET /v1/pbn-boost
The account's PBN Performance Boost — level, price, and which sites have it.
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/pbn-boost \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
One boost level for a whole Footprint-Free (PBN) account (docs/897): 1.5x, 2x or 3x every PBN site's CPU and memory, including sites added later. Priced per site per month on the account's total PBN site count with a monthly minimum, in the caller's currency, and re-priced only at renewal. sites says how many active PBN sites have it now and how many wait for room on their server (waiting sites are counted in the price). The organization is org_id or X-Zinn-Org. Requires billing.view.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
level | integer | Yes | The level the sites run at now; 0 when none |
held_level | integer | Yes | — |
suspended | boolean | Yes | A boost is held but not applied because the account is not in good standing. |
held | PbnBoostHeld | null | Yes | — |
eligible | boolean | Yes | The account has Footprint-Free sites or a plan. |
site_count | integer | Yes | PBN sites the price is counted on. |
sites | PbnBoostSites | Yes | — |
offers | PbnBoostOffer[] | Yes | — |
Errors this endpoint can return
401 · 403 · 422