PlanetHoster logo
API docs by Redocly

PlanetHoster API (3.0.0)

Download OpenAPI specification:Download

Support Technique: tech@support.planethoster.info License: Apache 2.0 Terms of Service

| English Version

Description

L'API PlanetHoster fournit un ensemble complet d'outils pour gérer les noms de domaine et les services d'hébergement web. Elle permet aux utilisateurs d'effectuer un large éventail d'actions, y compris l'enregistrement de domaines, la gestion DNS, la configuration d'hébergement, la gestion des certificats SSL et le déploiement d'applications. Avec le support de plusieurs langages de programmation et technologies web, l'API permet aux développeurs d'automatiser et de simplifier les opérations liées aux domaines, aux comptes d'hébergement, aux e-mails, aux bases de données et aux paramètres de sécurité, offrant une expérience d'hébergement flexible et efficace.

Vous cherchez notre ancienne API ? Accédez à la documentation ici : Documentation de l'ancienne API

Détails

  • SSL Requis : Toutes les requêtes doivent être effectuées via des connexions TLS/SSL chiffrées.
  • Verbes HTTP Supportés : L'API prend en charge GET, POST, PUT, PATCH et DELETE. Si votre client ne prend pas en charge tous les verbes, vous pouvez remplacer le verbe en utilisant l'en-tête HTTP X-Http-Method-Override.
  • Codes de Réponse : Par défaut, les appels API réussis retournent un statut HTTP 200 OK avec un objet JSON dans la réponse.
  • Gestion des Erreurs : Les erreurs sont retournées avec des codes d'état HTTP 4XX ou 5XX, accompagnés d'un objet JSON contenant un message "error" et un entier "error_code" optionnel.
  • Encodage UTF-8 : Toutes les chaînes envoyées à et reçues de l'API doivent être encodées en UTF-8.
  • Support ETag : L'API envoie des en-têtes ETag et prend en charge l'en-tête If-None-Match pour la validation du cache.
  • Authentification : Sauf indication contraire, toutes les méthodes de l'API nécessitent une authentification via X-API-USER et X-API-KEY.

Authentification et Liste Blanche

  1. Pour accéder à l'API, vous devez d'abord mettre vos adresses IP sur liste blanche.
  2. L'authentification nécessite à la fois un utilisateur API et une clé API, qui doivent être inclus dans les en-têtes HTTP de vos requêtes.

Vous pouvez trouver vos adresses IP sur liste blanche et vos identifiants dans la Zone Client PlanetHoster - Section Revendeur.

X-API-USER

Votre identifiant utilisateur API unique.

Security Scheme Type: API Key
Header parameter name: X-API-USER

X-API-KEY

Votre clé API pour l'authentification.

Security Scheme Type: API Key
Header parameter name: X-API-KEY

Opérations Générales

Opérations générales du compte PlanetHoster.

Tester la connexion

Effectue un test simple pour vérifier la connexion à l'API PlanetHoster.

Authorizations:
(X-API-KEYX-API-USER)

Responses

Exemples de requêtes 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/v3/hello'

Exemples de réponses

Content type
application/json
{
  • "message": "Connected successfully",
  • "successful_connection": true
}

Informations du compte

Récupère des informations détaillées sur votre compte revendeur, y compris les crédits, la devise, ainsi que le nombre de commandes et de domaines actifs.

Authorizations:
(X-API-KEYX-API-USER)

Responses

Exemples de requêtes 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/v3/account/info'

Exemples de réponses

Content type
application/json
{
  • "message": "Account information successfully obtained",
  • "credit_remaining": 500.51,
  • "credit_currency": "CAD",
  • "num_active_orders": 3,
  • "num_active_domains": 3
}

Informations de prix des TLD

Récupère les détails des prix pour l'enregistrement, le renouvellement et le transfert de noms de domaine pour tous les TLD proposés par PlanetHoster. La réponse indique également si la protection WHOIS ID est prise en charge pour chaque TLD et si un code EPP est requis pour les transferts de domaines.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
currency_code
string

Devise dans laquelle récupérer les prix (par exemple, USD, EUR, CAD).

Responses

Exemples de requêtes

Content type
application/json
{
  • "currency_code": "EUR"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Successfully retrieved prices",
  • "currency_code": "EUR",
  • "tlds": {
    }
}

Gestion des Domaines

Gérer les noms de domaine, y compris les opérations d'enregistrement et de renouvellement.

Domaines du compte

Récupère la liste de tous les domaines actifs associés à votre compte. La réponse inclut le nombre total de domaines actifs ainsi que leurs noms respectifs.

Authorizations:
(X-API-KEYX-API-USER)

Responses

Exemples de requêtes 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/v3/domains'

Exemples de réponses

Content type
application/json
{
  • "num_active_domains": 5,
  • "active_domains": [
    ]
}

Informations sur le domaine

Récupère des informations détaillées sur un domaine qui a été enregistré avec succès ou pour lequel une commande de transfert a été créée. Cela inclut les détails de l'enregistrement, le statut du transfert et d'autres données liées au domaine.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Domain info successfully obtained.",
  • "order_id": 1122,
  • "is_transfer": false,
  • "is_registration": true,
  • "registration_date": "2022-02-02",
  • "expiry_date": "2024-02-02",
  • "registration_status": "Active",
  • "registration_status_info": "transfer_in_progress",
  • "purchase_status": "Paid",
  • "id_protection": true,
  • "domain_statuses": "clientTransferProhibited",
  • "transfer_request_status": "Pending",
  • "transfer_request_denied_reason": "Reject by registrar",
  • "transfer_request_denied_at": "2024-02-02",
  • "transfer_request_confirmed_at": "2024-02-02"
}

Disponibilité d'un domaine

Vérifie si un nom de domaine spécifique est disponible pour l'enregistrement. La requête nécessite que le Second-Level Domain (SLD) et le Top-Level Domain (TLD) soient fournis. La réponse inclut des informations sur la disponibilité du domaine, s'il est catégorisé comme domaine premium, ainsi que les détails de tarification pour les domaines premium.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "available": true,
  • "message": "Available",
  • "is_premium": true,
  • "premium_register_price": 100.11,
  • "premium_renew_price": 100.11
}

Enregistrer un domaine

Lance le processus d'enregistrement d'un nom de domaine, permettant de l'enregistrer pour une durée comprise entre 1 et 10 ans.

L'enregistrement peut être personnalisé avec des serveurs de noms spécifiques et une option de protection de l'identité WHOIS. Les domaines premium peuvent entraîner des frais d'enregistrement plus élevés.

Certains domaines peuvent nécessiter des informations supplémentaires. Pour plus de détails, consultez notre article de la base de connaissances sur les conditions particulières des domaines de pays.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour enregistrer le domaine.

period
required
integer [ 1 .. 10 ]

Le nombre d'années pour lesquelles le domaine est enregistré.
Voir les tarifs des TLD pour les détails sur les prix par TLD.

ns1
required
string

Serveur de noms primaire utilisé pour la résolution DNS du domaine.

ns2
required
string

Serveur de noms secondaire utilisé pour la résolution DNS du domaine.

ns3
string

Serveur de noms tertiaire facultatif pour la résolution DNS.

ns4
string

Serveur de noms quaternaire facultatif pour la résolution DNS.

ns5
string

Serveur de noms quinquenaire facultatif pour la résolution DNS.

id_protection
required
boolean

Indique si la protection d'identité WHOIS doit être activée pour ce domaine.
Notez que certains TLD ne prennent pas en charge la protection d'identité WHOIS.
Voir les tarifs des TLD pour plus de détails.

register_if_premium
required
boolean

Poursuivre l'enregistrement même si le domaine est classé comme un domaine premium, ce qui peut entraîner des coûts plus élevés.

use_planethoster_nameservers
required
boolean

Définir cette option sur true si vous utilisez les serveurs de noms par défaut de PlanetHoster (nsa.n0c.com, nsb.n0c.com, et nsc.n0c.com).
Si activé, une zone DNS sera automatiquement créée pour le domaine après un enregistrement réussi.

addtl_field
object

Un objet représentant les champs supplémentaires requis pour le TLD spécifique en cours d'enregistrement.
Note : certains champs peuvent être obligatoires en fonction du TLD.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

registrant_first_name
required
string

Prénom du titulaire du domaine.

registrant_last_name
required
string

Nom de famille du titulaire du domaine.

registrant_email
required
string

Adresse e-mail du titulaire utilisée pour les communications relative au domaine.

registrant_company_name
string

Le nom de la société ou de l'organisation associée à l'enregistrement du domaine. Ce champ peut être laissé vide si l'enregistrement est à des fins personnelles.

registrant_address1
required
string

L'adresse principale du titulaire ou de son organisation, y compris le numéro civique.

registrant_address2
string

Ligne d'adresse additionelle du titulaire, si applicable Ce champ peut être laissé vide.

registrant_city
required
string

Ville où se trouve le titulaire du domaine.

registrant_postal_code
required
string

Code postal de l'adresse du titulaire du domaine.

registrant_state
required
string

État ou province où se trouve le titulaire du domaine.

registrant_country_code
required
string

Le code de deux lettres représentant le pays de résidence du titulaire. Consultez la liste des codes de pays ici.

registrant_phone
required
string

Numéro de téléphone du titulaire, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

admin_first_name
string

Prénom du contact administratif pour le domaine.

admin_last_name
string

Nom de famille du contact administratif pour le domaine.

admin_email
string

Adresse e-mail du contact administratif utilisée pour la gestion du domaine.

admin_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact administratif. Laisser vide si l'enregistrement est à titre personnel.

admin_address1
string

Adresse principale du contact administratif, incluant le numéro civique.

admin_address2
string

Ligne d'adresse additionelle du contact administratif, si applicable Ce champ peut être laissé vide.

admin_city
string

Ville où se trouve le contact administratif.

admin_postal_code
string

Code postal de l'adresse du contact administratif.

admin_state
string

État ou province où se trouve le contact administratif.

admin_country_code
string

Le code de deux lettres représentant le pays de résidence du contact administratif. Consultez la liste des codes de pays ici.

admin_phone
string

Numéro de téléphone du contact administratif, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

billing_first_name
string

Prénom du contact de facturation pour le domaine.

billing_last_name
string

Nom de famille du contact de facturation pour le domaine.

billing_email
string

Adresse e-mail du contact de facturation utilisée pour les communications financières liées au domaine.

billing_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact de facturation. Laisser vide si l'enregistrement est à titre personnel.

billing_address1
string

Adresse principale du contact de facturation, incluant le numéro civique.

billing_address2
string

Ligne d'adresse additionelle du contact de facturation, si applicable Ce champ peut être laissé vide.

billing_city
string

Ville où se trouve le contact de facturation.

billing_postal_code
string

Code postal de l'adresse du contact de facturation.

billing_state
string

État ou province où se trouve le contact de facturation.

billing_country_code
string

Le code de deux lettres représentant le pays de résidence du contact administratif. Consultez la liste des codes de pays ici.

billing_phone
string

Numéro de téléphone du contact de facturation, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

tech_first_name
string

Prénom du contact technique pour le domaine.

tech_last_name
string

Nom de famille du contact technique pour le domaine.

tech_email
string

Adresse e-mail du contact technique utilisée pour les demandes techniques liées au domaine.

tech_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact technique. Laisser vide si l'enregistrement est à titre personnel.

tech_address1
string

Adresse principale du contact technique, incluant le numéro civique.

tech_address2
string

Ligne d'adresse additionelle du contact technique, si applicable Laisser vide si non nécessaire.

tech_city
string

Ville où se trouve le contact technique.

tech_postal_code
string

Code postal de l'adresse du contact technique.

tech_state
string

État ou province où se trouve le contact technique.

tech_country_code
string

Le code de deux lettres représentant le pays de résidence du contact technique. Consultez la liste des codes de pays ici.

tech_phone
string

Numéro de téléphone du contact technique, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

Responses

Exemples de requêtes

Content type
application/json
{
  • "period": 2,
  • "ns1": "ns1.resellersite.com",
  • "ns2": "ns2.resellersite.com",
  • "ns3": "ns3.resellersite.com",
  • "ns4": "ns4.resellersite.com",
  • "ns5": "ns5.resellersite.com",
  • "id_protection": true,
  • "register_if_premium": true,
  • "use_planethoster_nameservers": true,
  • "addtl_field": { },
  • "sld": "mydomain",
  • "tld": "com",
  • "registrant_first_name": "John.",
  • "registrant_last_name": "Doe.",
  • "registrant_email": "johndoe@mydomain.com.",
  • "registrant_company_name": "string",
  • "registrant_address1": "123 Parkway Lane.",
  • "registrant_address2": "Bâtiment A, Appartement 12",
  • "registrant_city": "Montreal.",
  • "registrant_postal_code": "44444.",
  • "registrant_state": "Quebec.",
  • "registrant_country_code": "CA.",
  • "registrant_phone": "+1.5145555555.",
  • "admin_first_name": "John.",
  • "admin_last_name": "Doe.",
  • "admin_email": "johndoe@mydomain.com.",
  • "admin_company_name": "string",
  • "admin_address1": "123 Parkway Lane.",
  • "admin_address2": "Bâtiment A, Appartement 12",
  • "admin_city": "Montreal.",
  • "admin_postal_code": "44444.",
  • "admin_state": "Quebec.",
  • "admin_country_code": "CA.",
  • "admin_phone": "+1.5145555555.",
  • "billing_first_name": "John.",
  • "billing_last_name": "Doe.",
  • "billing_email": "johndoe@mydomain.com.",
  • "billing_company_name": "string",
  • "billing_address1": "123 Parkway Lane.",
  • "billing_address2": "Bâtiment A, Appartement 12",
  • "billing_city": "Montreal.",
  • "billing_postal_code": "44444.",
  • "billing_state": "Quebec.",
  • "billing_country_code": "CA.",
  • "billing_phone": "+1.5145555555.",
  • "tech_first_name": "John.",
  • "tech_last_name": "Doe.",
  • "tech_email": "johndoe@mydomain.com.",
  • "tech_company_name": "string",
  • "tech_address1": "123 Parkway Lane.",
  • "tech_address2": "Bâtiment A, Appartement 12",
  • "tech_city": "Montreal.",
  • "tech_postal_code": "44444.",
  • "tech_state": "Quebec.",
  • "tech_country_code": "CA.",
  • "tech_phone": "+1.5145555555."
}

Exemples de réponses

Content type
application/json
{
  • "message": "Domain registration order successfully created",
  • "order_id": 2222,
  • "order_total": 19.99,
  • "expiry_date": "2024-02-02"
}

Transférer un domaine

Transfer a domain name from your current registrar to PlanetHoster.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Initie le processus de transfert d'un nom de domaine depuis votre registrar actuel vers PlanetHoster. Cela vous permet de regrouper la gestion de vos domaines sur la plateforme PlanetHoster. Le transfert nécessite le Second-Level Domain (SLD), le Top-Level Domain (TLD) et le code d'autorisation de transfert (code EPP) fourni par votre registrar actuel.

epp_code
required
string

Transfer secret is a domain transfer secret (transfer key), a key or code.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "epp_code": "a!8/e!__Ph",
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Successfully launch transfer"
}

Renouveler un domaine

Renouvelle l'enregistrement d'un nom de domaine actif pour une durée spécifiée de 1 à 10 ans. Cela garantit que le domaine reste actif et enregistré sous votre propriété pour la durée choisie.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour le renouvellement du domaine.

period
required
integer [ 1 .. 10 ]

Le nombre d'années pour lesquelles le domaine est enregistré.
Voir les tarifs des TLD pour les détails sur les prix par TLD.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "period": 2,
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Domain renewal order created successfully",
  • "order_id": "2222",
  • "order_total": 9.95
}

Détails des contacts

Récupère les informations de contact WHOIS pour un nom de domaine actif. Cette opération fournit des détails approfondis sur les contacts enregistrés associés au domaine, y compris les informations personnelles et les détails de l'entreprise. Ces informations sont cruciales pour la gestion du domaine et peuvent aider dans divers processus administratifs.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Contact(s) successfully obtained",
  • "contacts": [
    ]
}

Mise à jour des contacts

Met à jour les informations de contact WHOIS pour le nom de domaine actif spécifié. Cette opération permet de modifier des détails essentiels tels que le nom du titulaire, l'adresse, l'email et le numéro de téléphone. Il est important de maintenir ces informations à jour pour garantir une communication efficace concernant la gestion et la propriété du domaine.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres de mise à jour du contact.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

registrant_first_name
required
string

Prénom du titulaire du domaine.

registrant_last_name
required
string

Nom de famille du titulaire du domaine.

registrant_email
required
string

Adresse e-mail du titulaire utilisée pour les communications relative au domaine.

registrant_company_name
string

Le nom de la société ou de l'organisation associée à l'enregistrement du domaine. Ce champ peut être laissé vide si l'enregistrement est à des fins personnelles.

registrant_address1
required
string

L'adresse principale du titulaire ou de son organisation, y compris le numéro civique.

registrant_address2
string

Ligne d'adresse additionelle du titulaire, si applicable Ce champ peut être laissé vide.

registrant_city
required
string

Ville où se trouve le titulaire du domaine.

registrant_postal_code
required
string

Code postal de l'adresse du titulaire du domaine.

registrant_state
required
string

État ou province où se trouve le titulaire du domaine.

registrant_country_code
required
string

Le code de deux lettres représentant le pays de résidence du titulaire. Consultez la liste des codes de pays ici.

registrant_phone
required
string

Numéro de téléphone du titulaire, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

admin_first_name
string

Prénom du contact administratif pour le domaine.

admin_last_name
string

Nom de famille du contact administratif pour le domaine.

admin_email
string

Adresse e-mail du contact administratif utilisée pour la gestion du domaine.

admin_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact administratif. Laisser vide si l'enregistrement est à titre personnel.

admin_address1
string

Adresse principale du contact administratif, incluant le numéro civique.

admin_address2
string

Ligne d'adresse additionelle du contact administratif, si applicable Ce champ peut être laissé vide.

admin_city
string

Ville où se trouve le contact administratif.

admin_postal_code
string

Code postal de l'adresse du contact administratif.

admin_state
string

État ou province où se trouve le contact administratif.

admin_country_code
string

Le code de deux lettres représentant le pays de résidence du contact administratif. Consultez la liste des codes de pays ici.

admin_phone
string

Numéro de téléphone du contact administratif, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

billing_first_name
string

Prénom du contact de facturation pour le domaine.

billing_last_name
string

Nom de famille du contact de facturation pour le domaine.

billing_email
string

Adresse e-mail du contact de facturation utilisée pour les communications financières liées au domaine.

billing_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact de facturation. Laisser vide si l'enregistrement est à titre personnel.

billing_address1
string

Adresse principale du contact de facturation, incluant le numéro civique.

billing_address2
string

Ligne d'adresse additionelle du contact de facturation, si applicable Ce champ peut être laissé vide.

billing_city
string

Ville où se trouve le contact de facturation.

billing_postal_code
string

Code postal de l'adresse du contact de facturation.

billing_state
string

État ou province où se trouve le contact de facturation.

billing_country_code
string

Le code de deux lettres représentant le pays de résidence du contact administratif. Consultez la liste des codes de pays ici.

billing_phone
string

Numéro de téléphone du contact de facturation, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

tech_first_name
string

Prénom du contact technique pour le domaine.

tech_last_name
string

Nom de famille du contact technique pour le domaine.

tech_email
string

Adresse e-mail du contact technique utilisée pour les demandes techniques liées au domaine.

tech_company_name
string

Nom de l'entreprise ou de l'organisation associée au contact technique. Laisser vide si l'enregistrement est à titre personnel.

tech_address1
string

Adresse principale du contact technique, incluant le numéro civique.

tech_address2
string

Ligne d'adresse additionelle du contact technique, si applicable Laisser vide si non nécessaire.

tech_city
string

Ville où se trouve le contact technique.

tech_postal_code
string

Code postal de l'adresse du contact technique.

tech_state
string

État ou province où se trouve le contact technique.

tech_country_code
string

Le code de deux lettres représentant le pays de résidence du contact technique. Consultez la liste des codes de pays ici.

tech_phone
string

Numéro de téléphone du contact technique, incluant l'indicatif international. Exemples : '+33' pour la France, '+1' pour le Canada.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com",
  • "registrant_first_name": "John.",
  • "registrant_last_name": "Doe.",
  • "registrant_email": "johndoe@mydomain.com.",
  • "registrant_company_name": "string",
  • "registrant_address1": "123 Parkway Lane.",
  • "registrant_address2": "Bâtiment A, Appartement 12",
  • "registrant_city": "Montreal.",
  • "registrant_postal_code": "44444.",
  • "registrant_state": "Quebec.",
  • "registrant_country_code": "CA.",
  • "registrant_phone": "+1.5145555555.",
  • "admin_first_name": "John.",
  • "admin_last_name": "Doe.",
  • "admin_email": "johndoe@mydomain.com.",
  • "admin_company_name": "string",
  • "admin_address1": "123 Parkway Lane.",
  • "admin_address2": "Bâtiment A, Appartement 12",
  • "admin_city": "Montreal.",
  • "admin_postal_code": "44444.",
  • "admin_state": "Quebec.",
  • "admin_country_code": "CA.",
  • "admin_phone": "+1.5145555555.",
  • "billing_first_name": "John.",
  • "billing_last_name": "Doe.",
  • "billing_email": "johndoe@mydomain.com.",
  • "billing_company_name": "string",
  • "billing_address1": "123 Parkway Lane.",
  • "billing_address2": "Bâtiment A, Appartement 12",
  • "billing_city": "Montreal.",
  • "billing_postal_code": "44444.",
  • "billing_state": "Quebec.",
  • "billing_country_code": "CA.",
  • "billing_phone": "+1.5145555555.",
  • "tech_first_name": "John.",
  • "tech_last_name": "Doe.",
  • "tech_email": "johndoe@mydomain.com.",
  • "tech_company_name": "string",
  • "tech_address1": "123 Parkway Lane.",
  • "tech_address2": "Bâtiment A, Appartement 12",
  • "tech_city": "Montreal.",
  • "tech_postal_code": "44444.",
  • "tech_state": "Quebec.",
  • "tech_country_code": "CA.",
  • "tech_phone": "+1.5145555555."
}

Exemples de réponses

Content type
application/json
{
  • "message": "Contact(s) successfully saved"
}

Verrouillage du domaine

Récupère le statut de verrouillage d'un nom de domaine enregistré. Cette opération vous informe si le domaine est actuellement verrouillé ou déverrouillé.
Un domaine verrouillé ne peut pas être transféré à un autre registraire, offrant une couche de sécurité supplémentaire contre les tentatives de transfert non autorisées.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Lock status successfully obtained",
  • "is_locked": true,
  • "domain_name": "mydomain.com"
}

Verrouiller le domaine

Active le verrouillage du registraire sur un nom de domaine enregistré et actif. Ce processus empêche les transferts non autorisés en garantissant que le domaine ne peut pas être déplacé vers un autre registraire sans d'abord être déverrouillé.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Lock status successfully saved (Locked)",
  • "is_locked": true,
  • "domain_name": "mydomain.com"
}

Déverrouiller le domaine

Désactive le verrouillage du registraire sur un nom de domaine enregistré et actif, permettant ainsi son transfert vers un autre registraire. Cette opération est essentielle pour gérer les changements de propriété des domaines avant d'initier un transfert.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Lock status successfully saved (Locked)",
  • "is_locked": true,
  • "domain_name": "mydomain.com"
}

Obtenir les serveurs de noms

Récupère les serveurs de noms associés à un nom de domaine enregistré. Cette opération vous permet de visualiser les paramètres actuels des serveurs de noms pour votre domaine, qui sont essentiels pour diriger le trafic et gérer les enregistrements DNS. Remarque : Au moins deux serveurs de noms doivent être associés au domaine pour que cette opération réussisse.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Nameservers successfully obtained",
  • "nameservers": [
    ]
}

Mise à jour serveurs de noms

Met à jour les serveurs de noms associés à votre domaine. Cette opération vous permet de spécifier les serveurs de noms primaire et secondaire, ainsi que des serveurs de noms de secours facultatifs pour la redondance.
Assurez-vous que tous les serveurs de noms spécifiés sont valides et actuellement opérationnels ; sinon, la mise à jour peut échouer.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres pour mettre à jour les serveurs de noms.

ns1
required
string

Le serveur de noms principal pour le domaine, responsable des requêtes DNS initiales.

ns2
required
string

Le serveur de noms secondaire pour le domaine, utilisé pour la redondance et l'équilibrage de charge.

ns3
string

Un serveur de noms de secours facultatif, offrant une redondance supplémentaire.

ns4
string

Un autre serveur de noms de secours facultatif pour une fiabilité accrue.

ns5
string

Un cinquième serveur de noms de secours facultatif, améliorant encore la redondance.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "ns1": "ns1.resellersite.com",
  • "ns2": "ns2.resellersite.net",
  • "ns3": "ns3.resellersite.com",
  • "ns4": "ns4.resellersite.com",
  • "ns5": "ns5.resellersite.com",
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Nameserver(s) successfully saved"
}

Envoyer le code EPP

Envoie le code EPP (également connu sous le nom de code Auth Info) pour le domaine spécifié à l'adresse email du titulaire du domaine. Le code EPP est requis lors du transfert d'un domaine vers un autre registraire, et cette opération garantit qu'il est envoyé en toute sécurité à l'email approprié enregistré.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour demander le code EPP pour un domaine.

sld
required
string

Domaine de deuxième niveau (SLD), qui est le nom de domaine sans le TLD.

tld
required
string

Domaine de premier niveau (TLD) sans le point qui le précède.

Responses

Exemples de requêtes

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Epp code successfully sent to registrant email",
  • "epp_code_sent_to": "admin@mydomain.com",
  • "domain_name": "mydomain.com"
}

Gestion des Hébergements

Gérer les services d'hébergement, y compris les configurations et les paramètres de compte.

Détails du The World

Récupère des informations détaillées sur votre service The World et tous les sous-comptes associés. Cela inclut l'allocation des ressources, le statut et d'autres détails essentiels pour gérer les sous-hébergements. Utile pour surveiller les ressources disponibles et gérer le statut de vos sous-comptes.

Authorizations:
(X-API-KEYX-API-USER)

Responses

Exemples de requêtes 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/v3/the-world/info'

Exemples de réponses

Content type
application/json
{
  • "available_resources": {
    },
  • "nb_active_or_suspended_accounts": 1,
  • "world_accounts": [
    ]
}

Détails des HybridClouds

Récupère des informations détaillées sur tous vos serveurs N0C HybridCloud et leurs comptes associés. Cela inclut l'allocation des ressources, l'état des serveurs et d'autres détails essentiels pour la gestion de vos serveurs HybridCloud.

Authorizations:
(X-API-KEYX-API-USER)

Responses

Exemples de requêtes 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/v3/hybridcloud/info'

Exemples de réponses

Content type
application/json
{
  • "nb_n0c_hybridcloud": 2,
  • "n0c_hybridclouds": [
    ]
}

Créer un hébergement

Crée un nouveau compte N0C sur la plateforme d'hébergement HybridCloud ou The World, en allouant les ressources spécifiées et en préinstallant éventuellement un CMS.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour créer le compte.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

disk_space
integer

Espace disque maximum autorisé pour le compte (en Go).

domain
required
string

Domaine principal pour le compte.

cpu
integer

Nombre de cœurs CPU alloués au compte.

memory
integer

Quantité de mémoire allouée au compte (en Go).

io
integer

Bande passante I/O allouée au compte (en Mo/s).

cms_name
string
Enum: "wp" "joomla" "prestashop" "drupal"

Préinstaller optionnellement un CMS lors de la création du compte.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "disk_space": 10,
  • "domain": "test-domain.com",
  • "cpu": 2,
  • "memory": 4,
  • "io": 2,
  • "cms_name": "wp"
}

Exemples de réponses

Content type
application/json
Example
{
  • "account_created": true,
  • "server_hostname": "world-server.planethoster.com",
  • "server_ip": "199.16.XX.XXX",
  • "id": 2222,
  • "username": "usernamexyz",
  • "password": "XXXXXXXXXXXXXXX"
}

Modifier un compte

Mettez à jour l'allocation des ressources pour un compte N0C hébergé sur la plateforme HybridCloud ou The World. Cette opération vous permet d'ajuster le CPU, la mémoire, les entrées/sorties (I/O) et l'espace disque selon les besoins.

De plus, ce point de terminaison (endpoint) peut être utilisé pour changer le mot de passe du compte d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour modifier le compte d'hébergement.

One of
One of
Any of
disk_space
integer

Limite d'espace disque pour le compte (en Go).

cpu
required
integer

Nombre de cœurs CPU à allouer au compte.

memory
integer

Quantité de mémoire (en Go) à allouer au compte.

io
integer

Bande passante I/O (en Mo/s) à allouer au compte.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "disk_space": 10,
  • "cpu": 2,
  • "memory": 4,
  • "io": 2
}

Exemples de réponses

Content type
application/json
Example
{
  • "cpu_updated": true,
  • "mem_updated": true,
  • "io_updated": true,
  • "errors": [ ]
}

Supprimer l'hébergement

Supprime définitivement un compte N0C des plateformes d'hébergement HybridCloud ou The World.

Remarque : Le compte doit être suspendu avant la suppression.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour la suppression du compte.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

password
required
string

Le mot de passe du compte N0C, requis pour confirmer la suppression.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "password": "*2CO6cdy4M8Tv)"
}

Exemples de réponses

Content type
application/json
{
  • "message": "Successfully terminate account"
}

Suspendre un compte

Initie la suspension d'un compte World. Fournissez une raison pour la suspension afin d'assurer une tenue de dossier appropriée.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour suspendre le compte.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

reason
required
string

La raison de la suspension du compte.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "reason": "Suspension reason"
}

Exemples de réponses

Content type
application/json
{
  • "account_suspended": true,
  • "message": "Successfully suspend account",
  • "suspension_reason": "Suspension reason"
}

Réactiver un compte

Réactive un compte d'hébergement World suspendu, restaurant l'accès aux services associés à ce compte.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour réactiver un compte suspendu.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "account_unsuspended": true,
  • "message": "Successfully unsuspend account"
}

Activer l'URL Temporaire

Active une URL temporaire pour le domaine principal d'un compte d'hébergement, permettant l'accès via une URL unique pendant le développement ou la maintenance.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour activer l'URL temporaire.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Désactiver l'URL Temporaire

Désactive l'URL temporaire pour le domaine principal d'un compte d'hébergement, supprimant le lien d'accès temporaire.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour désactiver l'URL temporaire.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "success": true,
  • "data": { }
}

Emails

Créer, gérer des comptes email associés à vos domaines.

Lister les emails

Récupérer la liste de tous les comptes email associés à un compte spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer les comptes email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Ajouter un email

Crée une nouvelle adresse email associée à un domaine spécifié.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour créer le nouveau compte email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le domaine sous lequel l'adresse email sera créée.

password
required
string

Le mot de passe pour le nouveau compte email.

mailUser
required
string

Le nom d'utilisateur pour l'adresse email (par exemple, 'info' pour info@mydomain.com).

quota
integer

La taille maximale de stockage pour le compte email en mégaoctets.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "mailUser": "info",
  • "quota": 5000
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier un email

Met à jour le mot de passe et/ou le quota d'un compte email existant.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres pour modifier le compte email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le domaine associé au compte email.

mailUser
required
string

Le nom d'utilisateur du compte email à modifier.

password
required
string

Nouveau mot de passe pour le compte email, si mise à jour.

quota
integer

Nouveau quota email en mégaoctets (Mo) pour le compte.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "quota": 5000
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer un email

Supprime une adresse email du domaine spécifié.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour supprimer le compte email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le domaine associé au compte email à supprimer.

mailUser
required
string

Le nom d'utilisateur du compte email à supprimer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "mailUser": "info"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Suspendre des emails

Suspendre une ou plusieurs adresses e-mail associées au compte.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour suspendre des adresses e-mail.

One of
email
required
string

L'adresse e-mail à suspendre.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "email": "info@mydomain.com",
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Réactiver des emails

Réactiver une ou plusieurs adresses e-mail précédemment suspendues associées au compte.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres nécessaires pour réactiver les adresses e-mail.

One of
email
required
string

L'adresse e-mail à réactiver.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "email": "info@mydomain.com",
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Statut des authentifications

Récupérer le statut des méthodes d'authentification email actuel pour le domaine spécifié.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour vérifier l'authentification email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel vérifier le statut d'authentification.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Activer l'authentification

Activer une méthode d'authentification email spécifique pour le domaine donné.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour activer l'authentification email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel activer l'authentification.

auth
required
string
Enum: "dkim" "spf" "dMarc"

La méthode d'authentification à activer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "auth": "dkim"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Désactiver l'authentification

Désactiver une méthode d'authentification email spécifique pour le domaine donné.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour désactiver l'authentification email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel désactiver l'authentification.

auth
required
string
Enum: "dkim" "spf" "dMarc"

La méthode d'authentification à désactiver.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "auth": "dkim"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Redirections d'Emails

Configurer et gérer les transferts d'email pour rediriger les emails d'une adresse à une autre.

Lister les redirections

Récupérer toutes les redirections d'emails configurées pour un compte.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer la liste des redirections d'emails.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Ajouter une redirection

Créer une nouvelle redirection d'email pour une adresse email.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour créer une redirection d'email.

One of
kind
required
string
Value: "standard"
forwarder
required
string

L'utilisateur email utilisé pour rediriger les messages.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine où la redirection sera créée.

forwardTo
required
Array of strings

Les adresses email de destination où les emails seront redirigés.

keepCopy
boolean

Indique si une copie des emails redirigés doit être conservée sur le compte email original.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "kind": "standard",
  • "forwarder": "myemail",
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "forwardTo": [
    ],
  • "keepCopy": false
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier une redirection

Mettre à jour une redirection d'email existante.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour modifier une redirection d'email.

One of
kind
required
string
Value: "standard"
forwarder
required
string

L'utilisateur email utilisé pour rediriger les messages.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

forwarder_id
required
integer

L'ID de la redirection à modifier.

domain
required
string

Le domaine associé à la redirection.

forwardTo
required
Array of strings

Les adresses email de destination où les emails doivent être redirigés.

keepCopy
boolean

Spécifie si une copie des emails redirigés sera conservée sur le compte email original.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "kind": "standard",
  • "forwarder": "myemail",
  • "id": "4444",
  • "username": "ffavexdc",
  • "forwarder_id": 935,
  • "domain": "mydomain.com",
  • "forwardTo": [
    ],
  • "keepCopy": false
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer une redirection

Supprimer une redirection d'email existante.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour supprimer une redirection d'email.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

forwarder_id
required
integer

L'ID de la redirection à supprimer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "forwarder_id": 935
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Domaines

Gérer les domaines associés à votre compte d'hébergement.

Lister tous les domaines

Récupérer la liste de tous les domaines associés au compte d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour lister tous les domaines.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Ajouter un domaine/sous-domaine

Ajoute un nouveau domaine ou sous-domaine au compte d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour ajouter un nouveau domaine.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Nom de domaine à ajouter.

subDomain
string

Nom du sous-domaine, le cas échéant.

docroot
required
string

Répertoire racine du domaine.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "subDomain": "sub1",
  • "docroot": "public_html/mydomain/"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier la racine

Modifie la racine du répertoire d'un domaine existant.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour modifier la racine du répertoire du domaine.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Nom de domaine existant.

docroot
required
string

Nouveau répertoire racine du domaine.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "docroot": "public_html/mydomain/"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer un domaine

Supprime le domaine spécifié du compte N0C.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour supprimer un domaine.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Nom de domaine à supprimer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Suspendre domaine(s)

Suspendre un ou plusieurs domaines associés au compte d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres spécifiant les domaines à suspendre.

One of
domain
required
string

Le nom de domaine à suspendre.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "domain": "mydomain.com",
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Réactiver domaine(s)

Réactiver un ou plusieurs domaines associés au compte d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres spécifiant les domaines à réactiver.

One of
domain
required
string

Le nom de domaine à réactiver.

id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "domain": "mydomain.com",
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

DNS

Gérer les enregistrements DNS pour vos domaines, tels que les enregistrements A, CNAME et MX.

Récupérer la zone DNS

Récupérer la zone DNS complète pour un domaine spécifié.

Remarque : Si vous possédez uniquement le domaine sans compte d'hébergement, vous pouvez tout de même gérer la zone DNS avec le domaine uniquement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour récupérer la zone DNS.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la zone DNS est récupérée.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier/ajouter des enregistrements

Permet d'ajouter ou de modifier des enregistrements dans la zone DNS.

Remarque : Si vous possédez uniquement le domaine sans compte d'hébergement, vous pouvez tout de même gérer la zone DNS avec le domaine uniquement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la zone DNS est modifiée.

required
Array of objects

Liste des enregistrements DNS à ajouter ou modifier.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "rrsets": [
    ]
}

Exemples de réponses

Content type
application/json
{
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Réinitialiser la zone DNS

Réinitialise la zone DNS avec les valeurs par défaut.

Remarque : Si vous possédez uniquement le domaine sans compte d'hébergement, vous pouvez tout de même gérer la zone DNS avec le domaine seulement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required
One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la zone DNS sera réinitialisée.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

SSL

Gérer les certificats SSL pour sécuriser vos domaines avec HTTPS.

Récupérer le certificat SSL

Récupère le certificat SSL actif pour un domaine spécifié. Ce point de terminaison (endpoint) fournit des informations détaillées sur le statut du certificat, la date d'expiration, l'émetteur et toute erreur pouvant être survenue lors du processus d'émission du certificat.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer le certificat SSL.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le certificat SSL est demandé.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Renouveler SSL

Lance le renouvellement d'un certificat SSL pour un domaine spécifié en utilisant AutoSSL. Ce processus permet de s'assurer que le domaine maintient une connexion sécurisée, protégeant ainsi les données des utilisateurs et préservant la confiance dans la sécurité du site web.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour initier le processus de renouvellement SSL.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le certificat SSL doit être renouvelé.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Récupérer le SSL personnalisé

Récupérer le certificat SSL personnalisé installé pour un domaine spécifié. Ce point de terminaison (endpoint) vous permet de récupérer à la fois le certificat et sa clé privée associée.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour récupérer le certificat SSL.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le certificat SSL est demandé.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Installer un SSL personnalisé

Ce point de terminaison (endpoint) vous permet d'installer un certificat SSL personnalisé pour un domaine spécifié. En fournissant le certificat nécessaire et la clé privée, vous pouvez sécuriser votre domaine avec HTTPS. Assurez-vous que le certificat est correctement formaté et associé au domaine que vous souhaitez sécuriser.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour l'installation du SSL personnalisé.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le certificat SSL sera installé.

certificate
required
string

Le certificat SSL.

privateKey
required
string

La clé privée associée au certificat SSL.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "certificate": "-----BEGIN CERTIFICATE-----\r\nMIIDqTCCApGgAwIBAgIUf0ySBv1sC/ZP9c67Zu42itgRmOswDQYJKoZIhvcNAQEL\r\nBQAwfTEhMB8GA1UEAxMYbW9yZWhjdGVzdC5zYWJlcmJldGEueHl6MQswCQYDVQQG\r\nEwJDQTELMAkGA1UECBMCUUMxETAPBgNVBAcTCE1vbnRyZWFsMRUwEwYDVQQKEwxQ\r\nbGFuZXRob3N0ZXIxFDASBgNVBAsTC0RldmVsb3BtZW50MB4XDTI0MDkxNzE3MDMw\r\nMFoXDTI0MTAxNzE3MDMwMFowfTEhMB8GA1UEAxMYbW9yZWhjdGVzdC5zYWJlcmJl\r\ndGEueHl6MQswCQYDVQQGEwJDQTELMAkGA1UECBMCUUMxETAPBgNVBAcTCE1vbnRy\r\nZWFsMRUwEwYDVQQKEwxQbGFuZXRob3N0ZXIxFDASBgNVBAsTC0RldmVsb3BtZW50\r\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyBLOv+tJdhxgCx6aZsUr\r\nZqx8yRQFFd3tZSBAHNdnMpv9VPeZrL9kkAet209Dx9/IPhUaY06dSwmiBnuEq+vE\r\nAFuFrAFe5WAcNM//9IRmuakasfspolFDiksCRB7Din4c8QIqFyGpWvFxJLjTl6H2\r\neWKzmRMeZ3A04XcpirvWYe4LM7q8tS+BgMiSsTe7iERpiAwxQK8hFIC8aBRrckDv\r\nvM/vhwypZmb+Y1GfJWgQ+0GQjfme739b/froafKDX+HcaLdOTg8T7FExG0k2r/ay\r\nnf9aieiJask7X9LCKNfwj15J1RA+yz85P8z5LvTKNjC4cBl4aOuhJxxpxbIJlDfo\r\nTwIDAQABoyEwHzAdBgNVHQ4EFgQUBIWBIzBK6AeopgBCO9RgqLy5q/MwDQYJKoZI\r\nhvcNAQELBQADggEBAAAiWP6nbe01kfUi/aEsD0eDZZyOgolnWMzd6M67WEw0nzgh\r\nwhrID0CTAMMhckbPiR9NiAyLQLwXyVkV0jGntX5aQ0tpE5ZtXalfrPp8HLuhuQVo\r\nyulyPOJXv4VjrHGDdCofNKqts5BoWssM3fkncEObMNXFM13jiKL2uX1lrn0T0OQI\r\nOXyfW6VOnSpy2wPRdNkaTPY3u86wQNgjAd4vBH8FYleOsUKBhnILnVgn+T1rt1QC\r\nRT3WMYvSukNJJSSIIY9N833Y97g5qEkFfmPinIS8DYQCO3V2jBcPbqb6r2+aKdT8\r\ni29j6Cs1ITGiNYATIAG162+Vd1YLqn7ItqXubZc=\r\n-----END CERTIFICATE-----\r\n",
  • "privateKey": "-----BEGIN RSA PRIVATE KEY-----\r\nMIIEpAIBAAKCAQEAyBLOv+tJdhxgCx6aZsUrZqx8yRQFFd3tZSBAHNdnMpv9VPeZ\r\nrL9kkAet209Dx9/IPhUaY06dSwmiBnuEq+vEAFuFrAFe5WAcNM//9IRmuakasfsp\r\nolFDiksCRB7Din4c8QIqFyGpWvFxJLjTl6H2eWKzmRMeZ3A04XcpirvWYe4LM7q8\r\ntS+BgMiSsTe7iERpiAwxQK8hFIC8aBRrckDvvM/vhwypZmb+Y1GfJWgQ+0GQjfme\r\n739b/froafKDX+HcaLdOTg8T7FExG0k2r/aynf9aieiJask7X9LCKNfwj15J1RA+\r\nyz85P8z5LvTKNjC4cBl4aOuhJxxpxbIJlDfoTwIDAQABAoIBAQDHKenEJN1ZBQAa\r\nsZk0CryclcIWjKZPUT+bdlI8I7UoLR4u8dd5noDl268W7L3lfwAfxPQivURZSTqQ\r\nR28XkTfovzK+uhKUNWt+qzv5Vb/Iu+zGFecpHMomJWsZEqLG/6mhxOzPYAPtcwGV\r\nc6O2g1UPGtD75YtTnuAVPYEOCNRtYD4DkTzWbWpbkZtVag9jqk0bon0akk6algjm\r\nuDm5xE94uU9hkx2dwcuykgWwTRlDft1okJ7oXu68N1rMcIdEr+chzsHCAEWvHGJ+\r\ncNbLCiTmuJDwKWZpR2SkksHWxwfhHyxrGNzJ4yID6HpUL7oE9hZ1egaUbDbxnrBE\r\nrakESqJZAoGBAOYp8KWn4cqkJMzPJR1+PDSlXDAUlFYq661cImV3LpFF2azNjl6J\r\nYSNKMMuc3rQPifJgRryRE3Nt+d6b9TJc0T5SfWIoqn6vz4/w42AYtSoh/GdxWSSA\r\nY+HbulW1FUdeILAy4tC0pVbFHuoGuIr4mgl2bldirX19SCVQD91FaK2VAoGBAN6I\r\nLnkbZdAI3BxXW0qMcdCiceBa+ME/ehI/6C4dpHCxEuXX2gQWCZb5uq3EZgZbsmc5\r\ng4/+3TTmazP1GVzXkv2FO9HIDEIUplIg4HWd30WLfG9hBR7shAEonuYNTOvwhneh\r\ndVCZo/1MwUk58Lts+Y1B/ItsO6tugc/pDSW4Nt1TAoGADvi1baEg/9RzjFsBGA0J\r\nD4eeGoaMK5q5H9q5Zg49mjeH9ESeuSmIhwohaG0400+bcoeusj9hm4WQ1lkgtvjw\r\np3QoMcVhacI35y4NLEgPKMFzMKtf2A798Eghs8eGrdDCoZN9y4OkqaNC4ogzYt7O\r\n7kSk4sxJartGgR7XGVaVe40CgYEAgE9NXI8rmVRCdiT4gneQeJfxyUcq/2I2ZKds\r\nnIqC8mdnWhenoYuDZAYCWYdQvIHK0DIdZb2ylnn1fjPot9uk6YEVCNSsHL4DWH+U\r\nbLzmrBbNXPs4FKiTRIfDdypcG/7HydrS5fJw1/CV0j8SSz9+dLCDiXCSxzokp1jd\r\nN86L8/kCgYBmokshUEeHNriRpD2Lj0VRA6ZDePPYbOF8Z+x/QoHJONQ2Vjr+YTbk\r\ngv9abhUCTme4E6CBk378qXBUNKxIRjm7tHskVPv5P5Bq0K/pHbiP2kKVcT2N+jab\r\n5R/8Qnc+153PQG3Ba5f9urfnCBU1JKrMyj0uqaLjT0UkMF3Yz312fw==\r\n-----END RSA PRIVATE KEY-----\r\n"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer le SSL personnalisé

Ce point de terminaison (endpoint) vous permet de supprimer le certificat SSL personnalisé actuel associé à un domaine spécifié et de revenir à AutoSSL. Cette action supprimera le certificat personnalisé, permettant au système de gérer automatiquement le SSL pour le domaine.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour la suppression du certificat SSL personnalisé.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le certificat SSL personnalisé sera supprimé.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Valider un certificat SSL

Valide un certificat SSL personnalisé pour s'assurer de son intégrité et de sa conformité avant son installation sur un domaine spécifié. Ce processus vérifie si le certificat est correctement formaté, signé, et correspond au domaine pour lequel il est destiné.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour la validation du certificat SSL personnalisé.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine complet (FQDN) pour lequel le certificat SSL a été émis.

certificate
required
string

Le certificat SSL à valider.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "certificate": "-----BEGIN CERTIFICATE-----\r\nMIIDqTCCApGgAwIBAgIUf0ySBv1sC/ZP9c67Zu42itgRmOswDQYJKoZIhvcNAQEL\r\nBQAwfTEhMB8GA1UEAxMYbW9yZWhjdGVzdC5zYWJlcmJldGEueHl6MQswCQYDVQQG\r\nEwJDQTELMAkGA1UECBMCUUMxETAPBgNVBAcTCE1vbnRyZWFsMRUwEwYDVQQKEwxQ\r\nbGFuZXRob3N0ZXIxFDASBgNVBAsTC0RldmVsb3BtZW50MB4XDTI0MDkxNzE3MDMw\r\nMFoXDTI0MTAxNzE3MDMwMFowfTEhMB8GA1UEAxMYbW9yZWhjdGVzdC5zYWJlcmJl\r\ndGEueHl6MQswCQYDVQQGEwJDQTELMAkGA1UECBMCUUMxETAPBgNVBAcTCE1vbnRy\r\nZWFsMRUwEwYDVQQKEwxQbGFuZXRob3N0ZXIxFDASBgNVBAsTC0RldmVsb3BtZW50\r\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyBLOv+tJdhxgCx6aZsUr\r\nZqx8yRQFFd3tZSBAHNdnMpv9VPeZrL9kkAet209Dx9/IPhUaY06dSwmiBnuEq+vE\r\nAFuFrAFe5WAcNM//9IRmuakasfspolFDiksCRB7Din4c8QIqFyGpWvFxJLjTl6H2\r\neWKzmRMeZ3A04XcpirvWYe4LM7q8tS+BgMiSsTe7iERpiAwxQK8hFIC8aBRrckDv\r\nvM/vhwypZmb+Y1GfJWgQ+0GQjfme739b/froafKDX+HcaLdOTg8T7FExG0k2r/ay\r\nnf9aieiJask7X9LCKNfwj15J1RA+yz85P8z5LvTKNjC4cBl4aOuhJxxpxbIJlDfo\r\nTwIDAQABoyEwHzAdBgNVHQ4EFgQUBIWBIzBK6AeopgBCO9RgqLy5q/MwDQYJKoZI\r\nhvcNAQELBQADggEBAAAiWP6nbe01kfUi/aEsD0eDZZyOgolnWMzd6M67WEw0nzgh\r\nwhrID0CTAMMhckbPiR9NiAyLQLwXyVkV0jGntX5aQ0tpE5ZtXalfrPp8HLuhuQVo\r\nyulyPOJXv4VjrHGDdCofNKqts5BoWssM3fkncEObMNXFM13jiKL2uX1lrn0T0OQI\r\nOXyfW6VOnSpy2wPRdNkaTPY3u86wQNgjAd4vBH8FYleOsUKBhnILnVgn+T1rt1QC\r\nRT3WMYvSukNJJSSIIY9N833Y97g5qEkFfmPinIS8DYQCO3V2jBcPbqb6r2+aKdT8\r\ni29j6Cs1ITGiNYATIAG162+Vd1YLqn7ItqXubZc=\r\n-----END CERTIFICATE-----\r\n"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Récupérer les CSR

Récupérer la liste des demandes de signature de certificat (CSRs) associées à un domaine spécifié. Ce point de terminaison (endpoint) fournit des informations détaillées sur chaque CSR, y compris la date de création, la CSR elle-même, tout certificat auto-signé, et l'empreinte de la clé publique. Il est utile pour suivre et gérer les CSRs générés pour votre domaine.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer les CSRs.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel les CSRs sont demandées.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Générer un CSR

Générer une nouvelle demande de signature de certificat (CSR) pour un domaine spécifié. Ce point de terminaison (endpoint) vous permet de soumettre les détails nécessaires, tels que le nom de domaine, les informations sur l'organisation et l'adresse e-mail de contact, qui seront utilisés pour créer la CSR. La CSR générée peut ensuite être soumise à une autorité de certification (CA) pour obtenir un certificat SSL.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour la création du CSR.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la CSR est créée.

countryCode
required
string

Code de pays à deux lettres de l'emplacement de l'organisation.

state
required
string

État ou province où se trouve l'organisation.

localityName
required
string

Ville où se trouve l'organisation.

organizationName
required
string

Nom complet de l'organisation.

organizationUnitName
required
string

Nom du département au sein de l'organisation.

email
required
string

Adresse e-mail de contact pour le CSR.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "countryCode": "CA",
  • "state": "Quebec",
  • "localityName": "Montreal",
  • "organizationName": "MyBusiness Inc.",
  • "organizationUnitName": "Development",
  • "email": "myemail@mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer un CSR

Supprime une demande de signature de certificat (CSR) spécifique pour un domaine en utilisant l'empreinte de clé publique. Ce point de terminaison (endpoint) est utile pour nettoyer les CSR obsolètes ou incorrects, garantissant que seules les demandes pertinentes sont conservées dans le système.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres nécessaires pour supprimer le CSR.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine associé au CSR.

csrPubKeyFingerPrint
required
string

Empreinte de clé publique du CSR à supprimer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "csrPubKeyFingerPrint": "04858123304ae807a8a600423bd460a8bcb9abf3"
}

Exemples de réponses

Content type
application/json
{
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Récupérer la clé privée CSR

Récupérer la clé privée associée à une demande de signature de certificat (CSR) pour un domaine spécifique. Cette clé est utilisée pour valider le CSR et est essentielle pour la génération du certificat SSL.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer la clé privée pour le CSR spécifié.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel le CSR a été générée.

csrPubKeyFingerPrint
required
string

L'empreinte du certificat public du CSR utilisée pour identifier la demande.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com",
  • "csrPubKeyFingerPrint": "04858123304ae807a8a600423bd460a8bcb9abf3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Redirections

Configurer et gérer les redirections de domaine.

Lister les redirections

Récupère une liste complète des redirections de domaine. Cela inclut des détails sur l'utilisation de HTTPS, si 'www.' est ajouté et l'URL de destination. Il fournit un aperçu de la configuration des domaines pour rediriger le trafic, y compris le type de redirection utilisé (301 ou 302) et si le domaine est redirigé vers un autre domaine.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour lister les redirections.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Ajouter une redirection

Crée une redirection de domaine vers une URL spécifiée. Cela peut être utilisé pour forcer le HTTPS ou pour ajouter 'www.' au nom de domaine, garantissant que tout le trafic est dirigé comme souhaité. Cette opération est essentielle pour gérer le trafic du site et améliorer la sécurité.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour configurer la redirection.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la redirection sera créée.

rType
required
integer
Enum: 301 302

Le type de redirection, où 301 indique une redirection permanente et 302 indique une redirection temporaire.

destinationUrl
required
string

L'URL vers laquelle le domaine sera redirigé.

Responses

Exemples de requêtes

Content type
application/json
Example
{}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer une redirection

Supprime une redirection existante pour le domaine spécifié. Cette opération est utile pour gérer la stratégie de redirection de votre site et permet de supprimer des redirections obsolètes ou inutiles.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour supprimer la redirection.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

domain
required
string

Le nom de domaine pour lequel la redirection sera supprimée.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "domain": "mydomain.com"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Configuration PHP

Configurer les paramètres PHP pour votre compte d'hébergement, y compris les versions et les extensions.

Lister les versions PHP

Récupère une liste de toutes les versions PHP disponibles, y compris la version active actuelle et la version par défaut pour l'environnement d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour lister les versions PHP disponibles.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Version PHP actuelle

Obtenez la version PHP actuellement active pour l'environnement d'hébergement.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres de requête pour récupérer la version PHP actuelle.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Changer la version PHP

Changer la version PHP active pour l'environnement d'hébergement vers la version spécifiée.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour mettre à jour la version PHP pour le compte d'hébergement.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP à définir comme active sur le compte.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Lister les options PHP

Récupère les options de configuration disponibles pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour récupérer les options de configuration pour une version PHP spécifique.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle récupérer les options de configuration.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier les options PHP

Mettre à jour les options de configuration pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour mettre à jour les options de configuration pour une version PHP spécifique.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle mettre à jour les options de configuration.

required
object

Paires clé-valeur des options de configuration PHP à modifier.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3",
  • "options": {
    }
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Réinitialiser les options PHP

Réinitialiser toutes les options de configuration PHP à leurs valeurs par défaut pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour réinitialiser les options PHP à leurs valeurs par défaut.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle les options doivent être réinitialisées.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Lister les extensions PHP

Récupère la liste des extensions PHP disponibles et leur statut pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour récupérer les extensions pour la version PHP spécifique.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle récupérer la liste des extensions.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier les extensions PHP

Activer ou désactiver des extensions PHP pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour modifier les extensions PHP pour la version PHP spécifique.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle modifier les extensions.

required
object

Liste des extensions PHP à activer ou désactiver.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3",
  • "extensions": {
    }
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Réinitialiser les extensions PHP

Réinitialise toutes les extensions PHP à leurs valeurs par défaut pour une version PHP spécifique.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour réinitialiser les extensions PHP à leurs valeurs par défaut.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

version
required
string

La version PHP pour laquelle les extensions doivent être réinitialisées.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "version": "8.3"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Applications Node.js

Gérer les applications Node.js, y compris le déploiement et les configurations d'environnement.

Lister les versions de Node.js

Récupérez une liste de toutes les versions de Node.js disponibles pouvant être utilisées sur votre compte d'hébergement. Ce point de terminaison (endpoint) fournit des détails sur les versions prises en charge, vous permettant de choisir la version de Node.js appropriée pour votre application.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour récupérer la liste des versions disponibles de Node.js.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Liste des applications Node.js

Récupérer une liste complète de toutes les applications Node.js sur votre compte d'hébergement. Ce point de terminaison (endpoint) renvoie des détails tels que le répertoire racine de l'application, la version de Node.js, l'URI, le domaine, le fichier de démarrage, le statut, et le chemin vers le script d'activation de l'environnement virtuel.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour lister les applications Node.js.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Ajouter une application Node.js

Créez une nouvelle application Node.js sur votre compte d'hébergement. Ce point de terminaison (endpoint) vous permet de définir des détails clés tels que le répertoire racine de l'application, le domaine associé, le fichier de démarrage, la version de Node.js, le chemin URI et le mode de l'application (développement ou production).

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour créer une application Node.js.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

appRoot
required
string

Le répertoire racine de votre application Node.js.

domain
required
string

Le nom de domaine de votre application.

startUpFile
string

Le fichier qui sera utilisé pour démarrer votre application Node.js.

uri
string

Le chemin URI de votre application.

version
required
string

La version de Node.js à utiliser pour votre application.

appMode
string
Enum: "development" "production"

Le mode dans lequel l'application fonctionnera, en développement ou en production.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "appRoot": "myapp",
  • "domain": "mydomain.com",
  • "startUpFile": "start.js",
  • "uri": "node/new",
  • "version": "20",
  • "appMode": "development"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Modifier une application Node.js

Mettez à jour la configuration d'une application Node.js existante sur votre compte d'hébergement. Cela vous permet de changer le domaine, le fichier de démarrage, l'URI, la version de Node.js, le répertoire racine ou de basculer entre les modes développement et production.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres pour modifier une application Node.js existante.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

appRoot
required
string

Le répertoire racine actuel de votre application Node.js.

newDomain
string

Le nouveau nom de domaine pour votre application.

startUpFile
string

Le nouveau fichier de démarrage à utiliser pour votre application.

newUri
string

Le nouveau chemin URI pour votre application.

version
required
string

La nouvelle version de Node.js à utiliser pour votre application.

newAppMode
string
Enum: "development" "production"

Le nouveau mode opérationnel de l'application.

newAppRoot
string

Le nouveau dossier racine pour votre application.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "appRoot": "myapp",
  • "newDomain": "mydomain.com",
  • "startUpFile": "start.js",
  • "newUri": "node/new",
  • "version": "20",
  • "newAppMode": "development",
  • "newAppRoot": "myapp"
}

Exemples de réponses

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Supprimer une application Node.js

Supprimez définitivement une application Node.js existante de votre compte d'hébergement. Cette action supprime l'application, ainsi que ses configurations.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json
required

Paramètres requis pour supprimer une application Node.js.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

appRoot
required
string

Le répertoire racine de l'application Node.js que vous souhaitez supprimer.

Responses

Exemples de requêtes

Content type
application/json
Example
{
  • "id": "4444",
  • "username": "ffavexdc",
  • "appRoot": "myapp"
}

Exemples de réponses

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "errors": [ ],
  • "reseller_id": "49gg39ed5888ee6bacebea8d8adab1e7"
}

Démarrer une application Node.js

Démarrez une application Node.js hébergée sur votre compte. Ce point de terminaison (endpoint) initie l'application en utilisant le répertoire racine et le domaine spécifiés. En cas de succès, il renvoie un message confirmant que l'application Node.js a été démarrée avec succès.

Authorizations:
(X-API-KEYX-API-USER)
Request Body schema: application/json

Paramètres requis pour démarrer l'application Node.js.

One of
id
required
integer

ID du serveur Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

username
required
string

Nom d'utilisateur N0C Hybridcloud, peut être trouvé avec /v3/hybridcloud/info.

appRoot
required
string

Le répertoire racine de l'application Node.js que vous souhaitez démarrer.

domain
required
string