POST /freebuild/create-backup

version 2.0.0

Créer une backup.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

Les champs suivants sont attendus dans le corps de la requête :

Nom	Type	Dans	Requis	Description	Valeur par default
`worldId`	number	Body	✅	L'id du monde	❌
`path`	string	Body	✅	Le chemin vers la sauvegarde	❌
`createdAt`	string	Body	❌	L'heure de création de la backup	currentTimeStamp
`ownerId`	number	Body	✅	L'id du propriétaire du terrain	❌

Les données que l'API retournera avec le succès de la requête :

Nom	Type	Nullable	Description
`id`	number	❌	L'id de la sauvegarde
`worldId`	number	❌	L'id du monde
`path`	string	❌	Le chemin vers la sauvegarde
`createdAt`	string	❌	L'heure de création de la backup
`ownerId`	number	❌	L'id du propriétaire du terrain

http://0.0.0.0/api/freebuild/create-backup

Et dans le body mettre par exemple :

{
    "worldId": 115,
    "path": "C:/docs/freebuild/backup.zip",
    "ownerId": 1
}

Si la backup est bien créé (code 201) :

{
    "id": 42,
    "worldId": 115,
    "path": "C:/docs/freebuild/backup.zip",
    "createdAt": "2023-10-01T12:00:00Z",
    "ownerId": 1
}

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
500	Internal Server Error	Erreur interne du serveur

Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

Nom	Type	Description
`code`	number	Le code d'erreur que retourne la requête
`message`	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas accès à cette requête.

{
    "message": "Access Denied",
    "code": 403
}