Consulter une instance cloud

GET /api/clouds/(string: name)

Renvoie l’instance cloud demandée.

En-têtes de requête:
Status Codes:
  • 200 OK – L’instance cloud a été renvoyée avec succès

  • 401 Unauthorized – Authentification REST invalide

  • 403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action

  • 404 Not Found – L’instance cloud demandée n’existe pas

Objet JSON de réponse:
  • name (string) – Le nom de l’instance cloud.

  • type (string) – Le type d’instance cloud. Voir la section cloud pour la liste des types d’instance cloud supportés.

  • key (string) – La clé d’authentification de l’instance cloud (si l’instance cloud requiert une authentification).

  • options (object) – Les options de connexion à l’instance cloud. Voir la section cloud pour avoir la liste des options disponibles pour le type concerné.


Exemple de requête

GET https://my_waarp_transfer.net/api/clouds/aws HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 165

{
  "name": "aws",
  "type": "s3",
  "key": "foo",
  "options": {
      "region": "eu-west-1"
  }
}