hosting

POST `/v1/media-offload/report`

What the WordPress plugin says it has offloaded so far.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

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/report \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "objects_offloaded": <integer>, "bytes_offloaded": <integer> }'

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 with a bearer plugin token, to report its progress and receive the settings it should currently apply. **These numbers are a diagnostic and never a bill.** They come from a plugin on the customer's own server, so a customer wanting a smaller invoice could simply send smaller ones. Storage is metered by measuring the bucket. What this endpoint feeds is the dashboard's "your plugin last checked in nine minutes ago and has moved 4,102 files".

Request body

Name	Type	Required	What it is
`objects_offloaded`	`integer`	Yes	—
`bytes_offloaded`	`integer`	Yes	—
`plugin_version`	`string`	No	—

Response

Name	Type	Required	What it is
`status`	`string`	Yes	—
`rewrite_urls`	`boolean`	Yes	—
`delete_local`	`boolean`	Yes	—
`prefix`	`string`	Yes	—
`public_base_url`	`string`	No	—

Errors this endpoint can return

401 · 429

POST /v1/media-offload/report