Remplacer une instance cloud

PUT /api/clouds/(string: name)

Remplace l’instance cloud demandée par une nouvelle. Revient à supprimer l’ancienne instance, puis d’en insérer une nouvelle. Les champs omis reprendront leur valeur par défaut (mise à jour complète).

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur REST

Objet JSON de requête:

• name (string) – Le nouveau nom de l’instance cloud.

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

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

• secret (string) – Le nouveau secret d’authentification (mot de passe, token…) de l’instance cloud (si l’instance cloud requiert une authentification).

• options (object) – Les nouvelles options de connexion à l’instance cloud. Voir la section cloud pour avoir la liste des options disponibles pour le type concerné. Attention: la totalité des options doit être renseignée. Les options omises seront supprimées.

Status Codes:

• 201 Created – L’instance cloud a été modifiée avec succès

• 400 Bad Request – Requête invalide

• 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

En-têtes de réponse:

• Location – Le chemin d’accès à l’instance cloud mise à jour

Exemple de requête

PATCH https://my_waarp_transfer.net/api/cloud/aws HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 114

{
  "name": "aws-us",
  "type": "s3",
  "key": "bar",
  "options": {
    "region": "us-east-1",
  }
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_transfer.net/api/clouds/aws-us