hostinger-api-mcp

Serveur Model Context Protocol (MCP) pour Hostinger API.

Prérequis

• Node.js version 20 ou supérieure

Si vous n'avez pas installé Node.js, vous pouvez le télécharger à partir du site officiel. Vous pouvez également utiliser un gestionnaire de paquets comme Homebrew (pour macOS) ou Chocolatey (pour Windows) pour installer Node.js.

Nous vous recommandons d'utiliser NVM (Node Version Manager) pour installer et gérer les versions installées de Node.js. Après avoir installé NVM, vous pouvez installer Node.js à l'aide de la commande suivante :

nvm install v20 nvm use v20

Installation du serveur MCP

Pour installer le serveur MCP, exécutez l'une des commandes suivantes, en fonction de votre gestionnaire de paquets :

# Installer globalement à partir de npm npm install -g hostinger-api-mcp # Ou avec yarn yarn global add hostinger-api-mcp # Ou avec pnpm pnpm add -g hostinger-api-mcp

Mise à jour

Pour mettre à jour le serveur MCP vers la dernière version, utilisez l'une des commandes suivantes, en fonction de votre gestionnaire de paquets :

# Mise à jour globale à partir de npm npm update -g hostinger-api-mcp # Ou avec yarn yarn global upgrade hostinger-api-mcp # Ou avec pnpm pnpm update -g hostinger-api-mcp

Configuration de l'environnement

Les variables d'environnement suivantes peuvent être configurées lors de l'exécution du serveur :

• DEBUG: Activer la journalisation de débogage (true/false) (default : false)

• APITOKEN: Votre jeton API, qui sera envoyé dans l'en-tête Authorization.

Utilisation

Configuration JSON pour Claude, Cursor, etc.

{ "mcpServers" : { "hostinger-api" : { "command" : "hostinger-api-mcp", "env" : { "DEBUG" : "false", "APITOKEN" : "YOUR API TOKEN" } } }

Utilisation du transport SSE

Pour utiliser le serveur MCP avec le transport SSE, vous devez exécuter le serveur avec l'option --sse. Cela permettra au serveur de communiquer avec les clients en utilisant les événements envoyés par le serveur sur le port 8100 de localhost. En outre, vous pouvez spécifier les options --host et --port pour définir l'hôte et le port sur lesquels le serveur doit écouter.

Exemple d'exécution du serveur avec le transport SSE :

hostinger-api-mcp --sse --host 127.0.0.1 --port 8100

Utilisation en tant que fournisseur d'outils MCP

Ce serveur implémente le Model Context Protocol (MCP) et peut être utilisé avec n'importe quel consommateur compatible MCP, comme le client Claude.js ou d'autres consommateurs MCP.

Exemple de connexion à ce serveur à partir d'un client Claude.js :

import { MCP } from "claude-js" ; import { createStdio } from "claude-js/mcp" ; // Créer un transport stdin/stdout const transport = createStdio({ command : "hostinger-api-mcp" }) ; // Se connecter au serveur MCP const mcp = new MCP({ transport }) ; await mcp.connect() ; // Lister les outils disponibles const { tools } = await mcp.listTools() ; console.log("Available tools :", tools) ; // Appeler un outil const result = await mcp.callTool({ id : "TOOL-ID", arguments : { param1 : "value1" } }) ; console.log("Tool result :", result)

Outils disponibles

Ce serveur MCP fournit les outils suivants :

billing_getCatalogItemListV1

Ce point d'accès permet de récupérer une liste d'articles du catalogue disponibles pour la commande.

Les prix des articles du catalogue sont affichés en cents (sans virgule flottante), par exemple : le nombre flottant 17,99 est affiché sous la forme d'un nombre entier 1799.

• Méthode: GET
• Chemin d'accès: /api/billing/v1/catalog

Paramètres:

• catégorie: Filtre les éléments du catalogue par catégorie
• name: Filtre les éléments du catalogue par nom. Utilisez * pour la recherche de caractères génériques, par exemple .COM* pour trouver le domaine .com

billing_createNewServiceOrderV1

Ce point d'accès crée un nouvel ordre de service.

SUPPRIMÉ

Pour acheter un domaine, utilisez POST /api/domains/v1/portfolio à la place.

Pour acheter un VPS, utilisez POST /api/vps/v1/virtual-machines à la place.

Pour passer une commande, vous devez fournir l'identifiant de la méthode de paiement et la liste des prix du catalogue ainsi que la quantité. Des coupons peuvent également être fournis lors de la création de la commande.

Les commandes créées à l'aide de ce point d'accès seront automatiquement renouvelées.

Certains paiements par carte de crédit peuvent nécessiter une vérification supplémentaire, rendant l'achat non traité. Nous vous recommandons d'utiliser d'autres méthodes de paiement que la carte de crédit si vous rencontrez ce problème.

• Méthode: POST
• Chemin d'accès: /api/billing/v1/orders

Paramètres:

• payment_method_id: ID du mode de paiement (obligatoire)
• items: paramètre "items" (obligatoire)
• coupons: Codes des coupons de réduction

billing_setDefaultPaymentMethodV1

Ce point de terminaison définit le mode de paiement par défaut pour votre compte.

• Méthode: POST
• Chemin d'accès: /api/billing/v1/payment-methods/{paymentMethodId}

Paramètres:

• paymentMethodId: ID du mode de paiement (obligatoire)

billing_deletePaymentMethodV1

Ce point de terminaison permet de supprimer un mode de paiement de votre compte.

• Méthode: DELETE
• Chemin d'accès: /api/billing/v1/payment-methods/{paymentMethodId}

Paramètres:

• paymentMethodId: ID du mode de paiement (obligatoire)

billing_getPaymentMethodListV1

Ce point de terminaison permet de récupérer la liste des méthodes de paiement disponibles qui peuvent être utilisées pour passer de nouvelles commandes.

Si vous souhaitez ajouter une nouvelle méthode de paiement, veuillez utiliser hPanel.

• Méthode: GET
• Chemin d'accès: /api/billing/v1/payment-methods

billing_cancelSubscriptionV1

Ce point d'accès permet d'annuler un abonnement et de mettre fin à toute facturation ultérieure.

• Méthode: DELETE
• Chemin d'accès: /api/billing/v1/subscriptions/{subscriptionId}

Paramètres:

• subscriptionId: ID de l'abonnement (obligatoire)

billing_getSubscriptionListV1

Ce point d'accès permet de récupérer la liste de tous les abonnements associés à votre compte.

• Méthode : GETGET
• Chemin d'accès: /api/billing/v1/subscriptions

DNS_getSnapshotV1

Ce point d'accès permet de récupérer un instantané DNS particulier contenant le contenu des enregistrements de la zone DNS.

• Méthode : GETGET
• Chemin d'accès: /api/dns/v1/snapshots/{domaine}/{snapshotId}

Paramètres:

• domain: Nom de domaine (obligatoire)
• snapshotId: ID de l'instantané (obligatoire)

DNS_getSnapshotListV1

Ce point d'accès permet de récupérer la liste des instantanés DNS.

• Méthode: GET
• Chemin d'accès: /api/dns/v1/snapshots/{domaine}

Paramètres:

• domaine: Nom de domaine (obligatoire)

DNS_restoreSnapshotV1

Ce point d'accès restaure la zone DNS sur le snapshot sélectionné.

• Méthode : POSTPOST
• Chemin d'accès: /api/dns/v1/snapshots/{domaine}/{snapshotId}/restore

Paramètres:

• domain: Nom de domaine (obligatoire)
• snapshotId: SnapshotId : ID de l'instantané (obligatoire)

DNS_getRecordsV1

Ce point d'accès permet de récupérer les enregistrements de zone DNS pour un domaine spécifique.

• Méthode: GET
• Chemin d'accès: /api/dns/v1/zones/{domaine}

Paramètres: /api/dns/v1/zones/{domaine}

• domain: Nom de domaine (obligatoire)

DNS_updateZoneRecordsV1

Ce point d'accès met à jour les enregistrements DNS pour le domaine sélectionné.

En utilisant overwrite = true, les enregistrements existants seront remplacés par les enregistrements fournis. Sinon, les enregistrements existants seront mis à jour et de nouveaux enregistrements seront ajoutés.

• Méthode: PUT
• Chemin d'accès: /api/dns/v1/zones/{domaine}

Paramètres: /api/dns/v1/zones/{domaine}

• domain: Nom de domaine (obligatoire)
• overwrite: Si vrai, les enregistrements de ressources (RR) correspondant au nom et au type seront supprimés et de nouveaux RR seront créés, sinon les ttl des enregistrements de ressources sont mis à jour et les nouveaux enregistrements sont ajoutés. Si aucun enregistrement de ressource correspondant n'est trouvé, il est créé.
• zone: paramètre de zone (obligatoire)

DNS_deleteZoneRecordsV1

Ce point d'accès supprime les enregistrements DNS pour le domaine sélectionné. Pour filtrer les enregistrements à supprimer, ajoutez le nom de l'enregistrement et le type au filtre. Plusieurs filtres peuvent être fournis avec une seule demande.

Si vous avez plusieurs enregistrements avec le même nom et le même type, et que vous souhaitez n'en supprimer qu'une partie, reportez-vous au point de terminaison Mettre à jour les enregistrements de zone.

• Méthode: DELETE
• Chemin d'accès: /api/dns/v1/zones/{domaine}

Paramètres: /api/dns/v1/zones/{domaine}

• domain: Nom de domaine (obligatoire)

DNS_resetZoneRecordsV1

Ce point d'accès réinitialise la zone DNS avec les enregistrements par défaut.

• Méthode: POST
• Chemin d'accès: /api/dns/v1/zones/{domaine}/reset

Paramètres: /api/dns/v1/zones/{domaine}/reset

• domain: Nom de domaine (obligatoire)
• sync: Détermine si l'opération doit être exécutée de manière synchrone
• reset_email_records: Détermine si les enregistrements d'email doivent être réinitialisés
• whitelisted_record_types: Spécifie quels types d'enregistrements ne doivent pas être réinitialisés

DNS_validateZoneRecordsV1

Ce point d'accès est utilisé pour valider les enregistrements DNS avant leur mise à jour pour le domaine sélectionné.

Si la validation est réussie, la réponse contiendra le code 200 Success. S'il y a une erreur de validation, la réponse échouera avec le code 422 Validation error.

• Méthode: POST
• Chemin d'accès: /api/dns/v1/zones/{domaine}/validate

Paramètres: /api/dns/v1/zones/{domaine}/validate

• domain: Nom de domaine (obligatoire)
• overwrite: Si vrai, les enregistrements de ressources (RR) correspondant au nom et au type seront supprimés et de nouveaux RR seront créés, sinon les ttl des enregistrements de ressources sont mis à jour et les nouveaux enregistrements sont ajoutés. Si aucun enregistrement de ressource correspondant n'est trouvé, il est créé.
• zone: paramètre de zone (obligatoire)

domains_checkDomainAvailabilityV1

Ce point d'accès vérifie la disponibilité d'un nom de domaine. Plusieurs TLD peuvent être vérifiés en même temps. Si vous souhaitez obtenir des domaines alternatifs avec la réponse, ne fournissez qu'un seul TLD dans la requête et définissez with_alternatives à true. Les TLD doivent être fournis sans le point initial (par exemple, com, net, org).

Le point d'accès est limité à 10 requêtes par minute.

• Méthode: POST
• Chemin d'accès: /api/domaines/v1/disponibilité

Paramètres:

• domain: Nom de domaine (sans TLD) (obligatoire)
• tlds: Liste des TLDs (obligatoire)
• with_alternatives: La réponse doit-elle inclure des alternatives ?

domains_getForwardingDataV1

Ce point d'accès permet de récupérer les données de transfert de domaine.

• Méthode: GET
• Chemin d'accès: /api/domaines/v1/forwarding/{domaine}

Paramètres:

• domaine: Nom de domaine (obligatoire)

domains_deleteForwardingDataV1

Ce point d'accès supprime les données de transfert d'un domaine.

• Méthode: DELETE
• Chemin d'accès: /api/domaines/v1/forwarding/{domaine}

Paramètres:

• domaine: Nom de domaine (obligatoire)

domains_createForwardingDataV1

Ce point d'accès permet de créer des données de transfert de domaine.

• Méthode: POST
• Chemin d'accès: /api/domaines/v1/forwarding

Paramètres:

• domain: Nom de domaine (obligatoire)
• redirect_type: Redirect_type : Type de redirection (obligatoire)
• redirect_url: URL vers laquelle rediriger le domaine (obligatoire)

domains_enableDomainLockV1

Ce point d'accès active le verrouillage du domaine. Lorsque le verrouillage du domaine est activé, le domaine ne peut pas être transféré à un autre bureau d'enregistrement sans que le verrouillage ne soit d'abord désactivé.

• Méthode: PUT
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}/domain-lock

Paramètres: /api/domains/v1/portfolio/{domaine}/domain-lock

• domain: Nom de domaine (obligatoire)

domains_disableDomainLockV1

Ce point d'accès désactive le verrouillage de domaine pour le domaine. Le verrouillage du domaine doit être désactivé avant de transférer le domaine vers un autre bureau d'enregistrement.

• Méthode: DELETE
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}/domain-lock

Paramètres: /api/domaines/v1/portfolio/{domaine}/domain-lock

• domain: Nom de domaine (obligatoire)

domains_getDomainV1

Ce point d'accès permet de récupérer les détails du domaine spécifié.

• Méthode: GET
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}

Paramètres:

• domaine: Nom de domaine (obligatoire)

domains_getDomainListV1

Ce point d'accès permet de récupérer la liste de tous les domaines associés à votre compte.

• Méthode : GETGET
• Chemin d'accès: /api/domaines/v1/portfolio

domaines_achatNouveauDomaineV1

Ce point d'accès vous permet d'acheter et d'enregistrer un nouveau nom de domaine.

Si l'enregistrement échoue, connectez-vous à hPanel et vérifiez le statut de l'enregistrement du domaine.

Si aucune méthode de paiement n'est fournie, votre méthode de paiement par défaut sera utilisée automatiquement.

Si aucune information WHOIS n'est fournie, les informations de contact par défaut pour ce TLD (Top-Level Domain) seront utilisées. Avant de faire une demande, assurez-vous que les informations WHOIS pour le TLD désiré existent dans votre compte.

Certains TLD nécessitent la fourniture de détails supplémentaires qui seront validés avant la finalisation de l'achat. Les détails supplémentaires requis varient selon le TLD.

• Méthode: POST
• Chemin d'accès: /api/domaines/v1/portfolio

Paramètres:

• domaine: Nom de domaine (obligatoire)
• item_id: ID de l'élément de prix du catalogue (obligatoire)
• payment_method_id: ID de la méthode de paiement, la valeur par défaut sera utilisée si elle n'est pas fournie
• domain_contacts: Informations sur les contacts du domaine
• additional_details: Données d'enregistrement supplémentaires, les valeurs possibles dépendent du TLD
• coupons: Codes de coupons de réduction

domains_enablePrivacyProtectionV1

Lorsque la protection de la vie privée est activée, les informations personnelles du propriétaire du domaine sont cachées de la base de données WHOIS publique.

• Méthode: PUT
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}/privacy-protection

Paramètres: /api/domains/v1/portfolio/{domaine}/priacy-protection

• domaine: Nom de domaine (obligatoire)

domains_disablePrivacyProtectionV1

Ce point de terminaison désactive la protection de la vie privée pour le domaine. Lorsque la protection de la vie privée est désactivée, les informations personnelles du propriétaire du domaine sont visibles dans la base de données publique WHOIS.

• Méthode: DELETE
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}/privacy-protection

Paramètres: /api/domaines/v1/portfolio/{domaine}/privacy-protection

• domaine: Nom de domaine (obligatoire)

domains_updateNameserversV1

Ce point de terminaison définit les serveurs de noms pour un domaine spécifié.

Attention, une mauvaise configuration des serveurs de noms peut entraîner l'impossibilité de résoudre le domaine ou son indisponibilité.

• Méthode: PUT
• Chemin d'accès: /api/domaines/v1/portfolio/{domaine}/nameservers

Paramètres: /api/domaines/v1/portfolio/{domaine}/nameservers

• domain: Nom de domaine (obligatoire)
• ns1: Premier serveur de noms (obligatoire)
• ns2: Deuxième serveur de noms (obligatoire)
• ns3: Troisième serveur de noms
• ns4: Quatrième serveur de noms

domains_getWHOISProfileV1

Ce point d'accès permet de récupérer un profil de contact WHOIS.

• Méthode: GET
• Chemin d'accès: /api/domaines/v1/whois/{whoisId}

Paramètres:

• whoisId: ID WHOIS (obligatoire)

domaines_deleteWHOISProfileV1

Ce point d'accès supprime le profil de contact WHOIS.

• Méthode: DELETE
• Chemin d'accès: /api/domaines/v1/whois/{whoisId}

Paramètres:

• whoisId: ID WHOIS (obligatoire)

domains_getWHOISProfileListV1

Ce point d'accès permet de récupérer une liste de profils de contact WHOIS.

• Méthode : GETGET
• Chemin d'accès: /api/domaines/v1/whois

Paramètres:

• tld: Filtre par TLD (sans point)

domains_createWHOISProfileV1

Ce point d'accès crée un profil de contact WHOIS.

• Méthode: POST
• Chemin d'accès: /api/domaines/v1/whois

Paramètres:

• tld: TLD du domaine (sans point) (obligatoire)
• country: Code pays à 2 lettres ISO 3166 (obligatoire)
• entity_type: Type d'entité juridique (obligatoire)
• tld_details: Détails du TLD
• whois_details: Détails du WHOIS (obligatoire)

domains_getWHOISProfileUsageV1

Ce point d'accès permet de récupérer une liste de domaines pour lesquels le profil de contact WHOIS fourni est utilisé.

• Méthode: GET
• Chemin d'accès: /api/domaines/v1/whois/{whoisId}/usage

Paramètres: /api/domaines/v1/whois/{whoisId}/usage

• whoisId: ID WHOIS (obligatoire)

VPS_getDataCentersListV1

Ce point d'accès permet de récupérer une liste de tous les centres de données disponibles.

• Méthode : GETGET
• Chemin d'accès: /api/vps/v1/data-centers

VPS_activateFirewallV1

Ce point de terminaison active un pare-feu pour une machine virtuelle spécifiée.

Un seul pare-feu peut être actif pour une machine virtuelle à la fois.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)
• virtualMachineId: VirtualMachineId : ID de la machine virtuelle (obligatoire)

VPS_deactivateFirewallV1

Ce point d'accès désactive un pare-feu pour une machine virtuelle spécifiée.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)
• virtualMachineId: VirtualMachineId : ID de la machine virtuelle (obligatoire)

VPS_getFirewallV1

Ce point d'accès permet de récupérer le pare-feu par son ID et les règles qui lui sont associées.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)

VPS_deleteFirewallV1

Ce point de terminaison supprime un pare-feu spécifié.

Toute machine virtuelle dont le pare-feu est activé sera automatiquement désactivée.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)

VPS_getFirewallListV1

Ce point d'accès récupère une liste de tous les pare-feux disponibles.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/firewall

Paramètres:

• page: Numéro de page

VPS_createNewFirewallV1 (Créer un nouveau pare-feu)

Ce point d'accès crée un nouveau pare-feu.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/firewall

Paramètres:

• name: paramètre de nom (obligatoire)

VPS_updateFirewallRuleV1

Ce point de terminaison met à jour une règle de pare-feu spécifique à partir d'un pare-feu spécifié.

Toute machine virtuelle dont le pare-feu est activé perdra la synchronisation avec le pare-feu et devra être synchronisée à nouveau manuellement.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)
• ruleId: RuleId : ID de la règle de pare-feu (obligatoire)
• protocol: paramètre de protocole (obligatoire)
• port: Port ou plage de ports, ex : 1024:2048 (obligatoire)
• source: paramètre source (obligatoire)
• source_detail: Plage d'IP, CIDR, IP unique ou n'importe quelle IP (obligatoire)

VPS_deleteFirewallRuleV1

Ce point de terminaison supprime une règle de pare-feu spécifique d'un pare-feu spécifié.

Toute machine virtuelle dont le pare-feu est activé perdra la synchronisation avec le pare-feu et devra être synchronisée à nouveau manuellement.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/rules/{ruleId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)
• ruleId: RuleId : ID de la règle de pare-feu (obligatoire)

VPS_createFirewallRuleV1

Ce point de terminaison crée une nouvelle règle de pare-feu à partir d'un pare-feu spécifié. Par défaut, le pare-feu bloque tout le trafic entrant, ce qui signifie que vous devez ajouter des règles d'acceptation pour tous les ports que vous souhaitez utiliser.

Toute machine virtuelle dont le pare-feu est activé perdra la synchronisation avec le pare-feu et devra être synchronisée à nouveau manuellement.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/rules

Paramètres: /api/vps/v1/firewall/{firewallId}/rules

• firewallId: ID du pare-feu (obligatoire)
• protocol: paramètre de protocole (obligatoire)
• port: Port ou plage de ports, ex : 1024:2048 (obligatoire)
• source: paramètre de source (obligatoire)
• source_detail: Plage d'IP, CIDR, IP unique ou autre (obligatoire)

VPS_syncFirewallV1

Ce point de terminaison synchronise un pare-feu pour une machine virtuelle spécifiée.

Le pare-feu peut perdre la synchronisation avec la machine virtuelle si de nouvelles règles ont été ajoutées, supprimées ou mises à jour.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}

Paramètres:

• firewallId: ID du pare-feu (obligatoire)
• virtualMachineId: VirtualMachineId : ID de la machine virtuelle (obligatoire)

VPS_getPostInstallScriptV1

Ce point d'accès permet de récupérer le script de post-installation par son identifiant.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Paramètres:

• postInstallScriptId: ID du script de post-installation (obligatoire)

VPS_updatePostInstallScriptV1

Ce point d'accès met à jour un script de post-installation spécifique.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Paramètres:

• postInstallScriptId: ID du script de post-installation (obligatoire)
• name: Nom du script (obligatoire)
• content: Contenu du script (obligatoire)

VPS_deleteAPostInstallScriptV1

Ce point de terminaison supprime un script de post-installation de votre compte.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/post-install-scripts/{postInstallScriptId}

Paramètres:

• postInstallScriptId: ID du script de post-installation (obligatoire)

VPS_getPostInstallScriptListV1

Ce point d'accès permet de récupérer la liste des scripts de post-installation associés à votre compte.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/post-install-scripts

Paramètres : page : /api/vps/v1/post-install-scripts

• page: Numéro de page

VPS_createPostInstallScriptV1

Ce point d'accès vous permet d'ajouter un nouveau script de post-installation à votre compte, qui peut ensuite être utilisé après l'installation d'une instance de machine virtuelle.

Le contenu du script sera sauvegardé dans le fichier /post_install avec l'attribut exécutable défini et sera exécuté une fois la machine virtuelle installée. La sortie du script sera redirigée vers /post_install.log. La taille maximale du script est de 48 Ko.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/post-install-scripts

Paramètres:

• name: Nom du script (obligatoire)
• content: Contenu du script (obligatoire)

VPS_attachPublicKeyV1

Ce point de terminaison attache une clé publique existante de votre compte à une machine virtuelle spécifiée.

Plusieurs clés peuvent être attachées à une seule machine virtuelle.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/public-keys/attach/{virtualMachineId}

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• ids: IDs de la clé publique à attacher (obligatoire)

VPS_deleteAPublicKeyV1

Ce point de terminaison supprime une clé publique de votre compte.

La suppression de la clé publique du compte ne la supprime pas de la machine virtuelle

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/public-keys/{publicKeyId}

Paramètres:

• publicKeyId: ID de la clé publique (obligatoire)

VPS_getPublicKeyListV1

Ce point d'accès permet de récupérer la liste des clés publiques associées à votre compte.

• Méthode : GETGET
• Chemin d'accès: /api/vps/v1/clés publiques

Paramètres:

• page: Numéro de page

VPS_createNewPublicKeyV1

Ce point d'accès vous permet d'ajouter une nouvelle clé publique à votre compte, qui peut ensuite être attachée à des instances de machines virtuelles pour un accès sécurisé.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/public-keys

Paramètres:

• name: paramètre de nom (obligatoire)
• key: paramètre clé (obligatoire)

VPS_getTemplateV1

Ce point de terminaison permet de récupérer les détails d'un modèle de système d'exploitation spécifique pour les machines virtuelles.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/templates/{templateId}

Paramètres:

• templateId: ID du modèle (obligatoire)

VPS_getTemplateListV1

Ce point de terminaison récupère une liste de modèles d'OS disponibles pour les machines virtuelles.

• Méthode : GETGET
• Chemin d'accès: /api/vps/v1/templates

VPS_getActionV1

Ce point de terminaison permet de récupérer les détails d'une action spécifique effectuée sur une machine virtuelle donnée.

Ce point de terminaison vous permet d'afficher des informations détaillées sur une action particulière, y compris le nom de l'action, l'horodatage et le statut.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• actionId: ID de l'action (obligatoire)

VPS_getActionListV1

Ce point de terminaison récupère une liste d'actions effectuées sur une machine virtuelle spécifiée.

Les actions sont des opérations ou des événements qui ont été exécutés sur la machine virtuelle, comme le démarrage, l'arrêt ou la modification de la machine. Ce point de terminaison vous permet d'afficher l'historique de ces actions, en fournissant des détails sur chaque action, tels que le nom de l'action, l'horodatage et le statut.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/actions

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• page: Numéro de page

VPS_getAttachedPublicKeysV1

Ce point d'accès permet de récupérer une liste de clés publiques attachées à une machine virtuelle donnée.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• page: Numéro de page

VPS_deleteBackupV1

Ce point de terminaison supprime une sauvegarde spécifiée pour une machine virtuelle.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• backupId: ID de la sauvegarde (obligatoire)

VPS_getBackupListV1

Ce point de terminaison récupère une liste de sauvegardes pour une machine virtuelle spécifiée.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/backups

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• page: Numéro de page

VPS_restoreBackupV1

Ce point de terminaison restaure une sauvegarde pour une machine virtuelle spécifiée.

Le système lancera alors le processus de restauration, qui peut prendre un certain temps en fonction de la taille de la sauvegarde.

Toutes les données de la machine virtuelle seront remplacées par les données de la sauvegarde.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• backupId: BackupId : ID de la sauvegarde (obligatoire)

VPS_setHostnameV1

Ce point de terminaison définit le nom d'hôte pour une machine virtuelle spécifiée. Changer le nom d'hôte ne met pas à jour l'enregistrement PTR automatiquement. Si vous voulez que votre machine virtuelle soit accessible par un nom d'hôte, vous devez également faire pointer les enregistrements A/AAAA de votre domaine vers l'IP de la machine virtuelle.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• hostname: paramètre de nom d'hôte (obligatoire)

VPS_resetHostnameV1

Ce point de terminaison réinitialise le nom d'hôte et l'enregistrement PTR d'une machine virtuelle spécifiée à la valeur par défaut.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/hostname

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_getVirtualMachineV1

Ce point d'accès permet de récupérer des informations détaillées sur une machine virtuelle donnée.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_getVirtualMachineListV1

Ce point de terminaison récupère une liste de toutes les machines virtuelles disponibles.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/machines virtuelles

VPS_achatNouvelleMachineVirtuelleV1

Ce point d'accès vous permet d'acheter et de configurer une nouvelle machine virtuelle.

Si la configuration de la machine virtuelle échoue pour une raison quelconque, connectez-vous à hPanel et terminez la configuration manuellement.

Si aucune méthode de paiement n'est fournie, votre méthode de paiement par défaut sera utilisée automatiquement.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/machines virtuelles

Paramètres:

• item_id: ID de l'élément de prix du catalogue (obligatoire)
• payment_method_id: ID de la méthode de paiement, la valeur par défaut sera utilisée si elle n'est pas fournie
• setup: paramètre de configuration (obligatoire)
• coupons: Codes des coupons de réduction

VPS_getScanMetricsV1

Ce point de terminaison récupère les métriques d'analyse pour l'analyseur de logiciels malveillants Monarx installé sur une machine virtuelle spécifiée. Les métriques d'analyse fournissent des informations détaillées sur les analyses de logiciels malveillants effectuées par Monarx, y compris le nombre d'analyses, les menaces détectées et d'autres statistiques pertinentes. Ces informations sont utiles pour surveiller l'état de sécurité de la machine virtuelle et évaluer l'efficacité de l'analyseur de logiciels malveillants.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/machines virtuelles/{virtualMachineId}/monarx

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_installMonarxV1

Ce point de terminaison installe le scanner de logiciels malveillants Monarx sur une machine virtuelle spécifiée.

Monarx est un outil de sécurité conçu pour détecter et prévenir les infections de logiciels malveillants sur les machines virtuelles. En installant Monarx, les utilisateurs peuvent renforcer la sécurité de leurs machines virtuelles, en s'assurant qu'elles sont protégées contre les logiciels malveillants.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_installMonarxV1

Ce point de terminaison désinstalle l'analyseur de logiciels malveillants Monarx sur une machine virtuelle spécifiée. Si Monarx n'est pas installé, la demande sera traitée sans effet.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/monarx

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_getMetricsV1

Ce point de terminaison récupère les métriques historiques pour une machine virtuelle spécifiée. Il inclut les métriques suivantes :

• Utilisation du CPU

• Utilisation de la mémoire

• Utilisation du disque

• Utilisation du réseau

• Temps de fonctionnement

• Méthode: GET

• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/metrics

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• date_from: paramètre date_from (obligatoire)
• date_to: paramètre date_to (obligatoire)

VPS_setNameserversV1

Ce point de terminaison définit les serveurs de noms pour une machine virtuelle spécifiée. Soyez conscient qu'une mauvaise configuration des serveurs de noms peut entraîner l'incapacité de la machine virtuelle à résoudre les noms de domaine.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• ns1: paramètre ns1 (obligatoire)
• ns2: paramètre ns2

VPS_createPTRRecordV1

Ce point de terminaison crée ou met à jour un enregistrement PTR (Pointer) pour une machine virtuelle spécifiée.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_deletePTRRecordV1

Ce point de terminaison supprime un enregistrement PTR (Pointer) pour une machine virtuelle spécifiée.

Une fois supprimé, les recherches DNS inversées sur l'adresse IP de la machine virtuelle ne renverront plus le nom d'hôte précédemment configuré.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/ptr

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_setPanelPasswordV1

Ce point de terminaison définit le mot de passe du panneau pour une machine virtuelle spécifiée. Si la machine virtuelle n'utilise pas le système d'exploitation du panneau, la demande sera toujours traitée sans effet. Les exigences pour le mot de passe sont les mêmes que pour le point de terminaison recréer une machine virtuelle.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• password: Mot de passe du panneau pour la machine virtuelle (obligatoire)

VPS_startRecoveryModeV1

Le mode de récupération est un état spécial qui permet aux utilisateurs d'effectuer des opérations de sauvetage du système, telles que la réparation des systèmes de fichiers, la récupération des données ou le dépannage des problèmes qui empêchent la machine virtuelle de démarrer normalement.

La machine virtuelle démarrera l'image disque de récupération et l'image disque originale sera montée dans le répertoire /mnt.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• root_password: Mot de passe temporaire de la racine pour le mode récupération (obligatoire)

VPS_stopRecoveryModeV1

Ce point de terminaison arrête le mode de récupération pour une machine virtuelle spécifiée. Si la machine virtuelle n'est pas en mode de récupération, cette opération échouera.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/recovery

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_recreateVirtualMachineV1

Ce point de terminaison recréera une machine virtuelle à partir de zéro. Le processus de recréation implique la réinstallation du système d'exploitation et la réinitialisation de la machine virtuelle à son état initial. Les instantanés, s'il y en a, seront supprimés.

Exigences en matière de mot de passe

Le mot de passe sera vérifié par rapport aux bases de données de mots de passe qui ont fait l'objet d'une fuite. Les exigences relatives au mot de passe sont les suivantes

• Au moins 8 caractères
• Au moins une lettre majuscule
• Au moins une lettre minuscule
• Au moins un chiffre
• Ne pas avoir fait l'objet d'une fuite publique

Cette opération est irréversible et entraîne la perte de toutes les données stockées sur la machine virtuelle !

• Méthode: POST
• Chemin d'accès: /api/vps/v1/machines virtuelles/{virtualMachineId}/recreate

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• template_id: ID du modèle (obligatoire)
• password: Mot de passe pour la machine virtuelle. S'il n'est pas fourni, un mot de passe aléatoire sera généré. Le mot de passe ne sera pas affiché dans la réponse.
• post_install_script_id: ID du script de post-installation

VPS_restartVirtualMachineV1

Ce point de terminaison redémarre une machine virtuelle spécifiée. Cela équivaut à arrêter et à démarrer complètement la machine virtuelle. Si la machine virtuelle était arrêtée, elle sera démarrée.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/restart

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_setRootPasswordV1

Ce point de terminaison définit le mot de passe root pour une machine virtuelle spécifiée. Les exigences pour le mot de passe sont les mêmes que pour le point de terminaison recréer une machine virtuelle.

• Méthode: PUT
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/root-password

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• password: Mot de passe racine pour la machine virtuelle (obligatoire)

VPS_setupNewVirtualMachineV1

Ce point de terminaison configurera la machine virtuelle nouvellement achetée avec l'état initial.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/setup

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)
• template_id: ID du modèle (obligatoire)
• data_center_id: ID du centre de données (obligatoire)
• post_install_script_id: ID du script de post-installation
• password: Mot de passe pour la machine virtuelle. S'il n'est pas fourni, un mot de passe aléatoire sera généré. Le mot de passe ne sera pas affiché dans la réponse.
• hostname: Remplacer le nom d'hôte par défaut de la machine virtuelle
• install_monarx: Installer le scanner de logiciels malveillants Monarx (s'il est pris en charge)
• enable_backups: Active la planification des sauvegardes hebdomadaires
• ns1: Serveur de nom 1
• ns2: Serveur de nom 2
• public_key: Utiliser la clé SSH

VPS_getSnapshotV1

Ce point de terminaison récupère un instantané pour une machine virtuelle spécifiée.

• Méthode: GET
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_createSnapshotV1

Ce point de terminaison crée un instantané d'une machine virtuelle spécifiée. Un instantané capture l'état et les données de la machine virtuelle à un moment spécifique, permettant aux utilisateurs de restaurer la machine virtuelle à cet état si nécessaire. Cette opération est utile à des fins de sauvegarde, de récupération du système et de test des changements sans affecter l'état actuel de la machine virtuelle.

La création d'un nouvel instantané écrasera l'instantané existant !

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_deleteSnapshotV1

Ce point de terminaison supprime un instantané d'une machine virtuelle spécifiée.

• Méthode: DELETE
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_restoreSnapshotV1

La restauration à partir d'un snapshot permet aux utilisateurs de revenir à l'état de la machine virtuelle, ce qui est utile pour la restauration du système, l'annulation des modifications ou les tests.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_startVirtualMachineV1

Ce point de terminaison démarre une machine virtuelle spécifiée. Si la machine virtuelle est déjà en cours d'exécution, la demande sera traitée sans aucun effet.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/start

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)

VPS_stopVirtualMachineV1

Ce point de terminaison arrête une machine virtuelle spécifiée. Si la machine virtuelle est déjà arrêtée, la requête sera traitée sans effet.

• Méthode: POST
• Chemin d'accès: /api/vps/v1/virtual-machines/{virtualMachineId}/stop

Paramètres:

• virtualMachineId: ID de la machine virtuelle (obligatoire)