hosting

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

Prove the round trip again and record the answer.

Tous les points de terminaison hosting

Toute la documentation pour développeurs

Authentification

Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation hosting.backup.manage ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

Writes, reads back and deletes a test file. Always 200; the verdict is in status and last_check_code. Requires hosting.backup.manage.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
destinationId (path)stringOui

Réponse

NomTypeObligatoireQu'est-ce que c'est
idstringOui
org_idstringOui
namestringOui
kindstring<s3, sftp>Oui
endpointstringNon
regionstringNon
bucketstringNon
hoststringNon
portintegerNon
usernamestringNon
host_key_fingerprintstringNonThe pinned SFTP host key as SHA256:…, the form ssh-keygen -lf prints.
prefixstringOui
statusstring<working, failing>Oui
last_checked_atstringNon
last_check_codestringNon
sites_usingintegerOui
created_atstringOui

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404