Ajouter une instance cloud¶
- POST /api/clouds¶
Ajoute une nouvelle instance cloud.
- En-têtes de requête:
Authorization – Les identifiants de l’utilisateur REST.
- Objet JSON de requête:
name (string) – Le nom de la nouvelle instance cloud.
type (string) – Le type de la nouvelle instance cloud. Voir la section cloud pour la liste des types d’instance cloud supportés.
key (string) – La clé d’authentification de la nouvelle instance cloud (si l’instance cloud requiert une authentification).
secret (string) – Le secret d’authentification (mot de passe, token…) de la nouvelle instance cloud (si l’instance cloud requiert une authentification).
options (object) – Les options de connexion à la nouvelle instance cloud. Voir la section cloud pour avoir la liste des options disponibles pour le type concerné.
- Status Codes:
201 Created – L’instance cloud a été créé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
- En-têtes de réponse:
Location – Le chemin d’accès à la nouvelle instance cloud créée
Exemple de requête
POST https://my_waarp_transfer.net/api/clouds HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 195 { "name": "aws", "type": "s3", "key": "foobar", "secret": "sesame", "options": { "region": "eu-west-1", } }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_transfer.net/api/clouds/aws