hosting

POST `/v1/media-offload/claim`

The WordPress plugin, redeeming a pairing code for a scoped token.

Authentication

This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.

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/media-offload/claim \
  -H "Content-Type: application/json" \
  -d '{ "code": <string> }'

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

Called by the Zinn® Media Offload plugin on a customer's WordPress server. **This endpoint is unauthenticated**: the caller has no session with us and can name no organisation — the pairing code is what names it. Every failure — an expired code, an already-claimed code and a code that never existed — returns the same `422`. Distinguishing them would confirm to a caller that a guessed code exists, which is the only thing between them and another organisation's storage.

Request body

Name	Type	Required	What it is
`code`	`string`	Yes	—
`plugin_version`	`string`	No	—
`site_url`	`string`	No	—

Response

Name	Type	Required	What it is
`token`	`string`	Yes	Shown once and never again. Stored by us only as a SHA-256 hash.
`site_id`	`string`	Yes	—
`prefix`	`string`	Yes	The key prefix this site's objects live under.
`public_base_url`	`string`	No	Where a rewritten media URL points. Empty when the bucket is private, in which case the plugin must not rewrite anything.
`rewrite_urls`	`boolean`	Yes	—
`delete_local`	`boolean`	Yes	—

Errors this endpoint can return

422 · 429

POST /v1/media-offload/claim