hosting
POST /v1/offsite-destinations/{destinationId}/test
Prove the round trip again and record the answer.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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