HELPER VPS

API VPS, automatisation des serveurs cloud en JSON REST

Une API de serveurs cloud pour tout gérer par code, de la création à la suppression

  • JSON REST API
  • Authentification par clé API (Bearer)
  • 300 requêtes par minute

Une API VPS est un moyen programmatique d'effectuer les tâches que vous feriez dans le panneau de contrôle, comme créer, démarrer, arrêter et supprimer des serveurs, avec des requêtes HTTP. L'API de serveur cloud HELPER VPS est gratuite pour tous les membres ; après votre premier paiement, créez une clé API et connectez-vous immédiatement.

  • REST API

    Tous les membres

    Gratuit

    Facturé mensuellement

    • JSON REST
    • Clé API (Bearer)
    • 300 par minute
    • Gratuit

Pour voir directement des exemples de requêtes et le format des réponses Documentation API

Que peut-on automatiser avec l'API VPS ?

L'API VPS montre toute sa force quand vous créez et supprimez souvent des serveurs, ou gérez plusieurs serveurs à la fois. Voici quatre automatisations courantes.

Panneau de contrôle ou API VPS : quand utiliser quoi ?

Le panneau de contrôle et l'API fonctionnent avec le même compte et les mêmes serveurs. Pour gérer un ou deux serveurs manuellement, le panneau de contrôle est pratique ; pour les tâches répétitives ou de nombreux serveurs, l'API est plus rapide.

Panneau de contrôle

Une gestion par clics à l'écran

Idéal pour

  • Pour créer un premier serveur
  • Pour gérer soi-même un ou deux serveurs
  • Réinstallation du système et ajout de clés SSH
  • Pour revoir le mot de passe root

VPS API

Une gestion par requêtes depuis le code

Idéal pour

  • Environnements de test où l'on crée et supprime souvent des serveurs
  • Pipelines de déploiement et automatisation par scripts
  • Pour lire d'un coup l'état de plusieurs serveurs
  • Pour connecter votre propre interface d'administration ou un bot

Comment se connecter à l'API de serveurs cloud ?

Cela se fait en trois étapes. Tout d'abord, effectuez votre premier paiement, et une fois confirmé, créez une clé sur la page des clés API. Ensuite, placez la clé dans l'en-tête Authorization de chaque requête en utilisant le schéma Bearer. Enfin, envoyez des requêtes au chemin souhaité après l'adresse de base https://helpervps.com/api/v1, et les résultats sont renvoyés au format JSON.

Pour commencer, appelez GET /catalog. Vous obtenez en une fois les types et tailles de serveurs disponibles, les codes de région, les codes de systèmes et d'applications en un clic, et les prix de la sauvegarde automatique, du disque supplémentaire et de la protection DDoS. Reprenez tels quels dans la requête de création les codes plan, location et image obtenus.

Pour créer un serveur, envoyez les valeurs plan, location, image et label en JSON à POST /servers. Vous pouvez également inclure l'ID d'une clé SSH que vous avez ajoutée et les options backups, extra_disk_gb et ddos_protection. Vous payez pour la période choisie à l'avance, et la réponse contient l'ID du serveur, son statut et le mot de passe root, alors enregistrez-les immédiatement dans un endroit sûr.

Quelles opérations l'API VPS permet-elle ?

L'API VPS couvre tout le cycle de vie d'un serveur. Lisez le catalogue avec GET /catalog, créez un serveur avec POST /servers, lisez la liste de vos serveurs avec GET /servers et les informations d'un serveur avec GET /servers/{id}. La réponse contient le nom du serveur, son état, ses adresses IPv4 et IPv6, son tarif mensuel, les options choisies et la prochaine échéance.

Allumez, éteignez et redémarrez avec les requêtes POST /servers/{id}/start, stop et reboot. POST /servers/{id}/renew paie le mois tout de suite sans attendre l'échéance et renouvelle aussitôt, et DELETE /servers/{id} supprime le serveur. Si une requête ne correspond pas à l'état actuel du serveur, le code wrong_state vous le signale, ce qui permet au script de décider facilement de la suite.

Les erreurs reviennent en JSON avec un code d'état et une valeur error. Clé incorrecte : unauthorized ; solde insuffisant : not_enough_balance ; nombre de serveurs du compte atteint : limit ; trop de requêtes : rate_limited. Les causes étant séparées par code, votre programme traite facilement chaque situation. La liste complète et des exemples de réponses figurent dans la documentation API.

Quel est le prix de l'API VPS ?

L'API VPS est gratuite pour tous les membres. Les serveurs et options créés avec l'API sont payés aux mêmes prix que les serveurs créés dans le panneau de contrôle.

HELPER VPS en chiffres

Choisissez parmi 40 régions, 12 systèmes d'exploitation et 10 applications en un clic dans un seul compte, et payez immédiatement. Les chiffres ci-dessous sont basés sur ce qui est en vente actuellement.

Outils d'automatisation utilisés avec l'API VPS

Tout outil capable d'envoyer des requêtes HTTP se connecte à l'API VPS. D'une ligne curl aux scripts Python et Node.js et aux pipelines de déploiement, l'utilisation est la même.

  • Terraform
  • Python
  • Node.js
  • GitLab CI
  • Docker

Pourquoi choisir l'API HELPER VPS

Questions fréquentes sur l'API VPS

Réponses sur la connexion, l'authentification et les limites de requêtes de l'API VPS

L'API VPS est-elle gratuite ?

Oui, l'API VPS est gratuite pour tous les membres. L'émission de clés API et les requêtes sont gratuites, et les serveurs et options créés avec l'API sont payés aux mêmes prix que ceux créés dans le panneau de contrôle. Tout membre ayant effectué son premier paiement peut créer une clé immédiatement sur la page des clés API.

Où créer une clé API ?

Une fois que vous avez effectué votre premier paiement, la page des clés API (/api-key) s'ouvre et vous y créez des clés. Placez la clé dans l'en-tête Authorization de chaque requête en utilisant le schéma Bearer. La clé déverrouille tout votre compte, alors ne la commettez pas dans des dépôts de code ; gardez-la dans des variables d'environnement ou un gestionnaire de secrets.

Quelles opérations puis-je faire par API ?

Lire le catalogue (GET /catalog), lire la liste des serveurs et les informations d'un serveur (GET /servers, GET /servers/{id}), créer un serveur (POST /servers), l'allumer, l'éteindre et le redémarrer (start, stop, reboot), le renouveler d'un mois (renew) et le supprimer (DELETE /servers/{id}). Exemples de requêtes et format des réponses figurent dans la documentation API.

Quelle est la limite de requêtes ?

Jusqu'à 300 requêtes par minute avec une seule clé. Au-delà, un code d'état 429 et l'erreur rate_limited sont renvoyés : faites attendre un instant votre script avant de renvoyer. L'automatisation quotidienne, comme la vérification de la liste des serveurs et la gestion de l'alimentation, tient largement dans cette limite. Aucun frais selon le nombre de requêtes.

Comment sont prélevés les frais d'un serveur créé par API ?

Lorsqu'une requête POST /servers réussit, le paiement pour la période de facturation choisie est traité et le serveur est créé. Le paiement pour un serveur qui échoue à être créé est renvoyé à votre crédit de compte.

Comment obtenir le mot de passe root par API ?

La valeur root_password figure une seule fois dans la réponse de la requête de création. Enregistrez-la en lieu sûr dès réception. Elle reste aussi visible 7 jours dans le panneau, et en envoyant aussi le numéro d'une clé SSH, vous vous connectez directement par clé, sans mot de passe. La valeur ipv4 de la réponse permet de lancer aussitôt la connexion SSH : idéal pour l'enchaîner à vos scripts de déploiement.

Puis-je ajouter une clé SSH par API ?

Oui, en indiquant le numéro d'une clé SSH enregistrée dans la valeur ssh_key_id de la requête de création, cette clé est installée sur le nouveau serveur. L'enregistrement de la clé se fait une fois dans l'écran Clés SSH du panneau, et l'empreinte est affichée comme avec ssh-keygen pour identifier aussitôt la clé. Définissez le numéro une fois et réutilisez-le.

Avec quels langages ou outils puis-je l'utiliser ?

Tout langage ou outil capable d'envoyer des requêtes HTTP convient. Testez aussitôt avec curl, puis appelez la même adresse avec les mêmes en-têtes depuis requests en Python, fetch en Node.js, les étapes de script de GitLab CI ou les requêtes HTTP de Terraform. Toutes les réponses sont en JSON, faciles à lire.

Comment savoir qu'une erreur s'est produite ?

Les erreurs reviennent avec un code d'état autre que 2xx et un JSON contenant une valeur error. Clé incorrecte : unauthorized ; valeur manquante : bad_request ; solde insuffisant : not_enough_balance ; requête incompatible avec l'état du serveur : wrong_state. Les causes étant séparées, votre programme traite chaque situation.

Les serveurs créés par API apparaissent-ils dans le panneau ?

Oui, l'API et le panneau manipulent le même compte et les mêmes serveurs. Les serveurs créés par API apparaissent tels quels dans la liste du panneau, où vous pouvez réinstaller le système ou consulter le mot de passe. La limite de 10 serveurs par compte s'applique aux deux méthodes. Même en mélangeant opérations manuelles et automatisées, l'état et les échéances s'affichent toujours de façon identique.

Guides de l'API VPS

Les guides à lire pour connecter l'API la première fois

L'API VPS est gratuite pour tous les membres, et vous pouvez créer une clé API après avoir effectué votre premier paiement. Les serveurs et options créés avec l'API sont payés aux mêmes prix que ceux de la liste des prix et se renouvellent automatiquement au même montant à chaque date de facturation.

Limite de requêtes : 300 par minute par clé API | 10 serveurs par compte | En cas d'échec de paiement : serveur suspendu, puis supprimé 3 jours plus tard | Le temps restant sur les serveurs supprimés n'est pas remboursé. Les remboursements sont crédités sur votre compte.