Aller au contenu principal

PATCH /server-status/update-server

version 2.0.0

Modifie une ou plusieurs informations d'un serveur existant.

Authentification

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

👥 Autorisation

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

  • Corail
  • Zelta
  • Axel
  • Site

🧾 Paramètres

Tous les paramètres sont à envoyer dans le corps de la requête :

NomTypeDansRequisDescription
idnumberBodyL'id du serveur
serverstringBodyLe type de jeux du serveur
statusstringBodyDéfini l'état du serveur
Restriction

La valeur de server ne peut être qu'une de celles-ci : BungeeCord, Auth, Lobby, Infecté, Freebuild, Practice, Skyblock*, Faction, MGLobby, GolemRush, Osmose, Pénitencier, Collection-Express, Parkour, Murder, RulesRamble
La valeur de status ne peut être qu'une de celles-ci : En ligne, Hors ligne, Maintenance, VIP\

Changement

*⚠️Depuis la 2.0.1 le Skyblock est devenus le Gensky

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'id du serveur
serverstringLe type de jeux du serveur
statusstringDéfini l'état du serveur

📤 Exemple de requête

http://0.0.0.0/api/server-status/update-server

Et dans le body mettre par exemple :

{
"id": 1,
"status": "Hors ligne"
}

📥 Exemple de réponse

Voici un exemple de réponse si la modification a été effectuée avec succès (code 200) :

{
"id": 1,
"server": "Infecté",
"status": "Hors ligne"
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
404Not foundEntité introuvable
409ConflictConflit avec des données existantes
500Internal Server ErrorErreur 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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

Ici par exemple, l'erreur 404 signifie que le serveur n'a pas été trouvé dans la base de données.

{
"message": "No value present",
"code": 404
}