Aller au contenu principal

GET /server-status/get-server

version 2.0.0

Récupérer les informations sur le statut d'un serveur.

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

Le paramètre suivant est requis dans l’URL pour identifier le serveur :

NomTypeDansRequisDescriptionValeur par default
idnumberURLL'id du serveur

🧾 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/get-server?id=1

📥 Exemple de réponse

Si le serveur est trouvé (code 200) :

{
"id": 1,
"server": "Infecté",
"status": "En 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
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
}