Préenregistrer un transfert serveur

PUT /api/transfers

Préenregistre un transfert serveur avec les informations fournies.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Objet JSON de requête:

• rule (string) – L’identifiant de la règle utilisée.

• isSend (bool) – Indique si transfert est un envoi (true) ou une réception (false).

• server (string) – Le nom du serveur local auquel le transfert est rattaché.

• account (string) – Le nom du compte local qui fera la demande de transfert.

• file (string) – Le nom du fichier à transférer.

• dueDate (date) – La date d’expiration du transfert (en format ISO 8601). Une fois cette date passée, le transfert tombera en erreur.

• transferInfo (object) – Des informations de transfert personnalisées sous la forme d’une liste de pairs clé:valeur, c’est-à-dire sous forme d’un objet JSON.

Status Codes:

• 201 Created – Le transfert a été enregistré avec succès

• 400 Bad Request – Un ou plusieurs des paramètres du transfert sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

En-têtes de réponse:

• Location – Le chemin d’accès au nouveau transfert créé

Exemple de requête

PUT https://my_waarp_gateway.net/api/transfers HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 224

{
  "rule": "règle_1",
  "isSend": true,
  "server": "serveur_sftp"
  "account": "toto",
  "file": "chemin/du/fichier",
  "dueDate": "2026-01-01T02:00:00+02:00",
  "transferInfo": { "key1": "val1", "key2": 2, "key3": true }
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_gateway.net/api/transfers/123