hosting
POST /v1/offsite-destinations/{destinationId}/test
Prove the round trip again and record the answer.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение hosting.backup.manage; ключ без него отклоняется с кодом 403, а не 404.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/offsite-destinations/{destinationId}/test \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Writes, reads back and deletes a test file. Always 200; the verdict is in status and last_check_code. Requires hosting.backup.manage.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
destinationId (path) | string | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | string | Да | — |
org_id | string | Да | — |
name | string | Да | — |
kind | string<s3, sftp> | Да | — |
endpoint | string | Нет | — |
region | string | Нет | — |
bucket | string | Нет | — |
host | string | Нет | — |
port | integer | Нет | — |
username | string | Нет | — |
host_key_fingerprint | string | Нет | The pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints. |
prefix | string | Да | — |
status | string<working, failing> | Да | — |
last_checked_at | string | Нет | — |
last_check_code | string | Нет | — |
sites_using | integer | Да | — |
created_at | string | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404