REST v2

ATTENTION: L’API REST v2 est actuellement en beta et est donc susceptible de contenir des bugs.

Cette documentation ayant pour but d’être courte et concise, en conséquence elle peut parfois manquer de précision. En cas de besoin, une documentation un peu plus exhaustive peut être consultée ici.

Une specification détaillée écrite en RAML peut également être téléchargée si nécessaire en utilisant ce lien ou au format OpenAPI 3.0 ce lien.

• Authentification des requêtes
  • Authentification Basique
  • Authentification HMAC
• Signature des requêtes
• Gestion des transferts
  • Lister les transferts
  • Ajouter un transfert
  • Consulter un transfert
  • Arrêter un transfert
  • Redémarrer un transfert
  • Annuler un transfert
• Gestion des hôtes
  • Lister les hôtes
  • Ajouter un hôte
  • Consulter un hôte
  • Modifier un hôte
  • Supprimer un hôte
• Gestion des règles
  • Lister les règles
  • Ajouter une règle
  • Consulter une règle
  • Modifier une règle
  • Supprimer une règle
• Gestion de la configuration
  • Initialiser la configuration
  • Consulter la configuration
  • Modifier la configuration
  • Supprimer la configuration
• Gestion de la bande passante
  • Modifier les limites
  • Consulter les limites
  • Modifier les limites
  • Supprimer les limites
• Commandes serveur
  • Consulter le statut du serveur
  • Désactiver le serveur
  • Éteindre le serveur
  • Redémarrer le serveur
  • Exporter les logs de transferts
  • Importer la configuration
  • Exporter la configuration
• Gestion des FileMonitors
  • Lister les FileMonitors

Documentation complète

GET /v2/transfers

Renvoie une liste des transferts monitorés par le serveur respectant les filtres donnés en paramètres de requête, ou simplement le décompte si countOrder=true est passé en paramètre.

Paramètres de requête:

• limit (integer) – Nombre maximal de transferts pouvant être inclus dans la réponse.

• offset (integer) – Indice de la première entrée à inclure dans la réponse.

• order (string) – Ordre dans lequel les réponses seront triées. Valeurs possibles : ascId, descId, ascFile, descFile, ascStart, descStart, ascStop, descStop

• ruleName (string) – Filter les transferts par règle de transfert.

• partner (string) – Filtrer les transferts par partenaire.

• status (string) – Filtrer les transferts par statut. Valeurs possibles : TOSUBMIT, NOTUPDATED, RUNNING, INTERRUPTED, DONE, INERROR, UNKNOWN

• filename (string) – Filtrer les transferts par fichier.

• startTrans (string) – Filtrer les transferts commençant après cette date (format ISO-8601).

• stopTrans (string) – Filtrer les transferts commençant avant cette date (format ISO-8601).

• followId (string) – Identifiant FollowId à rechercher dans les transferts.

• countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

POST /v2/transfers

Initialise un nouveau transfert sur le serveur avec les attributs définis dans le corps de la requête. Les informations sur le transfert créé sont renvoyées dans la réponse ainsi que l’URI pour le consuter.

Status Codes:

• 201 Created – Le nouveau transfert a été créé avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

En-têtes de réponse:

• transferURI – L’URI d’accès pour consulter le transfert.

GET /v2/transfers/{id}

Si le transfert demandé existe, renvoie toutes ses informations.

Paramètres:

• id (string) – L’identifiant unique du transfert. Afin de garantir l’unicité de cet id dans le cas d’une base de donnée partagée, ce paramètre est en fait composé de l’id du transfert sur le serveur, ainsi que du nom de l’hôte destinataire de ce transfert (i.e. le champ requested du transfert).

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

PUT /v2/transfers/{id}/restart

S’il existe, redémarre le transfert demandé.

Paramètres:

• id (string) – L’identifiant unique du transfert. Afin de garantir l’unicité de cet id dans le cas d’une base de donnée partagée, ce paramètre est en fait composé de l’id du transfert sur le serveur, ainsi que du nom de l’hôte destinataire de ce transfert (i.e. le champ requested du transfert).

Status Codes:

• 202 Accepted – Le transfert a été redémarré avec succès.

PUT /v2/transfers/{id}/stop

S’il existe, arrête le transfert demandé.

Paramètres:

• id (string) – L’identifiant unique du transfert. Afin de garantir l’unicité de cet id dans le cas d’une base de donnée partagée, ce paramètre est en fait composé de l’id du transfert sur le serveur, ainsi que du nom de l’hôte destinataire de ce transfert (i.e. le champ requested du transfert).

Status Codes:

• 202 Accepted – Le transfert a été arrêté avec succès.

PUT /v2/transfers/{id}/cancel

If it exists, cancels the requested transfer.

Paramètres:

• id (string) – L’identifiant unique du transfert. Afin de garantir l’unicité de cet id dans le cas d’une base de donnée partagée, ce paramètre est en fait composé de l’id du transfert sur le serveur, ainsi que du nom de l’hôte destinataire de ce transfert (i.e. le champ requested du transfert).

Status Codes:

• 202 Accepted – Le transfert a été annulé avec succès.

GET /v2/hosts

Renvoie l’ensemble des hôtes conformes aux filtres passés en paramètres de requête. Si le paramètre countOrder=true est donnée, seule le décompte est retournée. Les hôtes peuvent être filtrés par addresse, sur leur utilisation de SSL, ou sur le fait qu’ils soient actifs ou non. Les paramètres offset et limit permettent de fixer un numéro de départ et un nombre maximal d’hôtes désirés, afin de ne renvoyer qu’un sous-ensemble de la liste demandée. Le paramètre order spécifie dans quel ordre les hôtes doivent être ordonnées.

Paramètres de requête:

• limit (integer) – Fixe le nombre maximal de transferts pouvant être inclus dans la réponse. Utile lorsque le nombre d’entrées sélectionnées par les filtres est trop important pour tenir dans un seule message.

• offset (integer) –

  Indice de la première entrée à inclure dans la réponse. Généralement utilisé en combinaison avec le paramètre limit pour restreindre l’ensemble des hôtes à renvoyer.

  Attention : Si le offset est plus grand que le nombre total de réponses, aucune entrée ne sera renvoyée.

• order (string) – Spécifie l’attribut à utiliser pour trier les éléments de la réponse, ainsi que le sens du tri. Ce paramètre devrait donc être le nom d’un attribut d’hôte préfixé par « asc » ou « desc », correspondant respectivement à l’ordre croissant et décroissant.

• address (string) – Si ce paramètre est défini, la réponse ne contiendra que les hôtes ayant cette adresse.

• isSSL (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que les hôtes autorisant les transferts SSL. Et si le paramètre est faux, que ceux ne les autorisant pas. Si le paramètre n’est pas défini, aucun filtrage ne sera fait.

• isActive (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que les hôtes actifs. Et si le paramètre est faux, que ceux inactifs. Si le paramètre n’est pas défini, aucun filtrage ne sera fait.

• countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 415 Unsupported Media Type – Le type de contenu de la requête n’est pas valide pour cette requête.

POST /v2/hosts

Ajoute un nouvel hôte à la base de données avec les attribut de l’objet passé dans le corps de la requête. La nouvelle entrée créée est renvoyée dans la réponse, ainsi que l’URI pour la consulter.

Status Codes:

• 201 Created – Le nouvel hôte a été ajouté avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 415 Unsupported Media Type – Le type de contenu de la requête n’est pas valide pour cette requête.

En-têtes de réponse:

• hostURI – L’URI d’accès aux informations du nouvel hôte.

GET /v2/hosts/{id}

S’il existe, renvoie les informations de l’hôte demandé sous forme d’un objet JSON.

Paramètres:

• id (string) – Le nom unique de l’hôte désiré.

Status Codes:

• 200 OK – L’hôte demandé a été trouvé.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

PUT /v2/hosts/{id}

S’il existe, remplace les informations de l’hôte demandé par celles données dans la requête. Les nouvelles informations seront renvoyées dans la réponse, ainsi que leur URI d’accès.

Paramètres:

• id (string) – Le nom unique de l’hôte désiré.

Status Codes:

• 202 Accepted – L’hôte a été mis à jour avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

• 415 Unsupported Media Type – Le type de contenu de la requête n’est pas valide pour cette requête.

En-têtes de réponse:

• host-uri – Le chemin d’accès de l’hôte modifié. Si le nom d’hôte n’a pas été changé, cet URI sera identique à celui ayant été utilisé pour la requête.

DELETE /v2/hosts/{id}

S’il existe, supprime l’hôte de la base de données.

Paramètres:

• id (string) – Le nom unique de l’hôte désiré.

Status Codes:

• 204 No Content – L’hôte a été supprimé avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

GET /v2/hostconfig

Renvoie la configuration du serveur sous forme d’un objet JSON.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

POST /v2/hostconfig

Initialise la configuration du serveur dans la base de données avec les attribut passés dans la requête.

Status Codes:

• 201 Created – La configuration du serveur a été ajoutée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

PUT /v2/hostconfig

Si le serveur a une configuration en base de données, remplace cette configuration avec les nouveaux attributs passé dans la requête.

Status Codes:

• 202 Accepted – La configuration a été mise à jour avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

DELETE /v2/hostconfig

Si le serveur a une configuration en base de données, supprime cette configuration.

Status Codes:

• 204 No Content – La configuration a été supprimée avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

GET /v2/limits

Renvoie les limites de bande passante sous forme d’un objet JSON.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

POST /v2/limits

Initialise les limites de bande passante du serveur avec les attributs passés dans la requête.

Status Codes:

• 201 Created – Les limites ont été initialisées avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

PUT /v2/limits

Si le serveur a des limites en base de données, remplace ces limites par celle passées dans la requête.

Status Codes:

• 201 Created – Les limites ont été modifiées avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

DELETE /v2/limits

Si le serveur a des limites en base de données, supprime ces limites.

Status Codes:

• 204 No Content – Les limites ont élé enlevées avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

GET /v2/rules

Renvoie l’ensemble des règles de transfert conformes aux filtres passés en paramètres de requête. Si le paramètre countOrder=true est donnée, seule le décompte est retournée. Les règles peuvent être filtrées par mode de transmission. Les paramètres offset et limit permettent de fixer un numéro de départ et un nombre maximal de règles désirées, afin de ne renvoyer qu’un sous-ensemble de la liste demandée. Le paramètre order spécifie dans quel ordre les règles doivent être ordonées.

Paramètres de requête:

• limit (integer) – Fixe le nombre maximal de règles pouvant être inclues dans la réponse. Utile lorsque le nombre d’entrées sélectionnées par les filtres est trop important pour tenir dans un seule message.

• offset (integer) –

  Indice de la première entrée à inclure dans la réponse. Généralement utilisé en combinaison avec le paramètre limit pour restreindre l’ensemble des hôtes à renvoyer.

  Attention : Si le offset est plus grand que le nombre total de réponses, aucune entrée ne sera renvoyée.

• order (string) – Spécifie l’attribut à utiliser pour trier les éléments de la réponse, ainsi que le sens du tri. Ce paramètre devrait donc être le nom d’un attribut d’hôte préfixé par « asc » ou « desc », correspondant respectivement à l’ordre croissant et décroissant.

• modeTrans (string) – Si ce paramètre est défini, la réponse ne contiendra que les règles utilisant ce mode de transfert.

• countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

POST /v2/rules

Creates a new transfer rule with the ObjectRule passed in the request body. The created entry is returned in the response body, along with its URI.

Status Codes:

• 201 Created – La nouvelle règle de transfert a été ajoutée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

En-têtes de réponse:

• ruleURI – L’URI d’accès à la nouvelle règle créée.

GET /v2/rules/{id}

Si elle existe, renvoie les informations de la règle demandée sous forme d’un objet JSON.

Paramètres:

• id (string) – L’identifiant unique de la règle souhaitée.

Status Codes:

• 200 OK – La règle remandée a été trouvée.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

PUT /v2/rules/{id}

Si elle existe, remplace les informations de la règle demandée par celles données dans la requête. Les nouvelles informations seront renvoyées dans la réponse, ainsi que leur URI d’accès.

Paramètres:

• id (string) – L’identifiant unique de la règle souhaitée.

Status Codes:

• 201 Created – La règle de transfert a été mise à jour avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

En-têtes de réponse:

• ruleURI – Le chemin d’accès de la règle modifiée. Si le nom de la règle n’a pas été changé, cet URI sera identique à celui ayant été utilisé pour la requête.

DELETE /v2/rules/{id}

Si elle existe, supprime la règle de transfert de la base de données.

Paramètres:

• id (string) – L’identifiant unique de la règle souhaitée.

Status Codes:

• 204 No Content – La règle a été supprimée avec succès.

• 404 Not Found – Dans le cas d’une requête sur une collection, cela signifie que l’identifiant donné n’existe pas dans la base de données.

GET /v2/server/status

Renvoie le statut général du serveur sous forme d’un objet JSON regroupant toutes les informations sur celui-ci.

Paramètres de requête:

• period (string) – La période de temps (en format ISO-8601) sur laquelle le statut du serveur est étudié. (Required)

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

PUT /v2/server/deactivate

Désactive ou active le serveur pour que celui-ci accepte ou refuse les nouvelles requêtes de transfert.

Status Codes:

• 202 Accepted – Le serveur a été (dés)activé avec succès.

PUT /v2/server/shutdown

Stoppe tous les transferts en cours et arrête le serveur R66.

Status Codes:

• 202 Accepted – Le requête a été traitée avec succès, le serveur va s’éteindre.

PUT /v2/server/reboot

Stoppe tous les transferts en cours et redémarre le serveur R66.

Status Codes:

• 202 Accepted – Le requête a été traitée avec succès, le serveur va redémarrer.

GET /v2/server/logs

Exporte les logs de transferts du serveur vers un fichier XML dans le dossier de logs du serveur.

Paramètres de requête:

• purge (boolean) – Spécifie si les transferts exportés doivent être purgés de la base de données après l’export de log.

• clean (boolean) – Spécifie si, avant d’être exportés, les transferts doivent avoir leur statut marqué comme terminé lorsque leur étape globale et sous-étape le permettent.

• status (string) – Filtre pour n’exporter que les transferts ayant ce statuts.

• ruleName (string) – Filtre pour n’exporter que les transferts utilisant cette règle de tranfert.

• start (string) – Filtre pour n’exporter que les transferts ultérieurs à cette date.

• stop (string) – Filtre pour n’exporter que les transferts antérieurs à cette date.

• startID (integer) – Filtre pour n’exporter que les transferts ayant un ID plus grand que celui-ci.

• stopID (integer) – Filtre pour n’exporter que les transferts ayant un ID plus petit que celui-ci.

• requested (string) – Filtre pour n’exporter que les transferts demandés par cet hôte.

Status Codes:

• 200 OK – Les logs ont été exportés avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

GET /v2/server/config

Exporte divers éléments de la configuration du serveur R66 vers des fichiers dans le dossier de configuration du serveur.

Paramètres de requête:

• exportHosts (boolean) – Spécifie si la liste des hôtes connus du serveur doit être exportée non.

• exportRules (boolean) – Spécifie si les règles de transfert doivent être exportées ou non.

• exportBusiness (boolean) – Spécifie si la liste des hôtes autorisés à exécuter un business sur le serveur doit être exportée ou non.

• exportAliases (boolean) – Spécifie si la liste des alias connus de chaque hôte doit être exportée ou non.

• exportRoles (boolean) – Spécifie si la liste des rôles autorisés de chaque hôte doit être exportée ou non.

Status Codes:

• 200 OK – La configuration a été exportée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

PUT /v2/server/config

Importe divers éléments de la configuration du serveur R66 depuis des fichiers dans le dossier de configuration du serveur.

Paramètres de requête:

• purgeHosts (boolean) – Spécifie si l’ancienne base de données des hôtes doit être purgée avant d’importer la nouvelle.

• purgeRules (boolean) – Spécifie si l’ancienne base de données des règles de transfert doit être purgée avant d’importer la nouvelle.

• purgeBusiness (boolean) – Spécifie si l’ancienne base de données des partenaire de business doit être purgée avant d’importer la nouvelle.

• purgeAliases (boolean) – Spécifie si l’ancienne base de données des alias doit être purgée avant d’importer la nouvelle.

• purgeRoles (boolean) – Spécifie si l’ancienne base de données des rôles doit être purgée avant d’importer la nouvelle.

• hostsFile (string) – Le chemin du fichier contenant les hôtes à importer.

• rulesFile (string) – Le chemin du fichier contenant les règles à importer.

• businessFile (string) – Le chemin du fichier contenant les partenaire business à importer.

• aliasesFile (string) – Le chemin du fichier contenant les alias à importer.

• rolesFile (string) – Le chemin du fichier contenant les rôles à importer.

Status Codes:

• 202 Accepted – La configuration a été importée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

GET /v2/filemonitors

Renvoie une liste des FileMonitors reçus par le serveur respectant les filtres donnés en paramètres de requête. Si le paramètre countOrder=true est donnée, seule le décompte est retournée.

Paramètres de requête:

• name (string) – Nom optionnel du FileMonitor à retourner

• status (integer) – 0 pour tous les FileMonitors, 1 pour ceux actifs, -1 pour les inactifs.

• countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Status Codes:

• 200 OK – La requête s’est déroulée avec succès.

• 400 Bad Request –

  La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

  Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.