hosting

POST /v1/offsite-destinations/{destinationId}/test

Prove the round trip again and record the answer.

すべての hosting エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには hosting.backup.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X POST https://api.zinndigital.com/v1/offsite-destinations/{destinationId}/test \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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はい

返信

名前タイプ必須これがその内容です
idstringはい
org_idstringはい
namestringはい
kindstring<s3, sftp>はい
endpointstringいいえ
regionstringいいえ
bucketstringいいえ
hoststringいいえ
portintegerいいえ
usernamestringいいえ
host_key_fingerprintstringいいえThe pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints.
prefixstringはい
statusstring<working, failing>はい
last_checked_atstringいいえ
last_check_codestringいいえ
sites_usingintegerはい
created_atstringはい

このエンドポイントが返すエラー

401 · 403 · 404