hosting
POST /v1/offsite-destinations/{destinationId}/test
Prove the round trip again and record the answer.
Authentication
Send an API key as a bearer token. The key must carry the hosting.backup.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/offsite-destinations/{destinationId}/test \
-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
Writes, reads back and deletes a test file. Always 200; the verdict is in status and last_check_code. Requires hosting.backup.manage.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
destinationId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
name | string | Yes | — |
kind | string<s3, sftp> | Yes | — |
endpoint | string | No | — |
region | string | No | — |
bucket | string | No | — |
host | string | No | — |
port | integer | No | — |
username | string | No | — |
host_key_fingerprint | string | No | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | Yes | — |
status | string<working, failing> | Yes | — |
last_checked_at | string | No | — |
last_check_code | string | No | — |
sites_using | integer | Yes | — |
created_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404