hosting

POST /v1/sites/{siteId}/media-offload/pairing

Mint a short-lived code that pairs the WordPress plugin to this site.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the storage.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/media-offload/pairing \
  -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

Returns a code the customer types into the Zinn® Media Offload plugin in their WordPress admin. The plugin exchanges it for a token scoped to this one site. The code is single-use and expires in thirty minutes: it is read off one screen and typed into another within a minute or two, and a code that lived for a day would be a credential sitting in a browser tab. Requires `storage.manage`.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
codestringYesThe code to type into the plugin.
expires_atstringYes

Errors this endpoint can return

401 · 403 · 404 · 429