PlanetHoster logo
API docs by Redocly

PlanetHoster API (2.0.0)

Download OpenAPI specification:Download

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

| English Version

Description

L'API de PlanetHoster permet d'effectuer des actions liées à la gestion des domaines et à l'hébergement web.

Ceci est la documentation de notre ancienne API. Accédez à la documentation actuelle ici: Documentation de l'API

Details

  • SSL uniquement : nous exigeons que toutes les demandes soient effectuées par des connexions TLS/SSL cryptées.
  • Les verbes HTTP pris en charge sont GET et POST. Si votre client ne prend pas en charge tous les verbes HTTP, vous pouvez remplacer le verbe par l'en-tête HTTP X-Http-Method-Override.
  • À moins d'indication contraire dans la documentation de la méthode, tous les appels d'API réussis renvoient un HTTP code 200 avec un objet JSON.
  • Les erreurs sont retournées avec un code HTTP 4XX ou 5XX, un objet JSON avec des propriétés "error" (un message d'erreur) et un "error_code" (nombre entier facultatif).
  • Chaque chaîne transmise à l'API ou provenant de celle-ci doit être codée en UTF-8.
  • L'API envoie des en-têtes ETag et prend en charge l'en-tête If-None-Match.
  • Sauf indication contraire, toutes les méthodes API nécessitent une authentification avec api_user et api_key.

Authentification et liste blanche

  1. Afin de pouvoir contacter l'API, vous devez mettre vos IP sur une liste blanche.
  2. L'utilisateur et la clé de l'API sont requis dans l'en-tête HTTP.

Whitelisted ip and credentials can be found in the PlanetHoster Client Area / Reseller section.

api_user

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

api_key

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

api_sandbox

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

Reseller API

Domaine enregistré avec les appels liés à PlanetHoster.

Tests the connection

Teste la connexion à l'API du revendeur de domaines.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/test-connection'

Response samples

Content type
application/json
{
  • "message": "Connection successful",
  • "successful_connection": true
}

Account info

Retourne les informations relatives au compte avec votre revendeur.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

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

Response samples

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

Tld prices

Donne les prix des noms de domaine pour l'enregistrement, le renouvellement et le transfert. Il indique également si chaque TLD vendu par PlanetHoster supporte ou non la protection WHOIS ID, et s'il requiert ou non un code EPP pour le transfert du domaine.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/tld-prices'

Response samples

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

Check domain availability

Vérifie si un nom de domaine est disponible pour l'enregistrement ou non.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/check-availability?sld=mydomain&tld=com'

Response samples

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

Domain information

Récupérer les informations d'un domaine que vous avez enregistré avec succès ou pour lequel vous avez créé un ordre de transfert.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/domain-info?sld=mydomain&tld=com'

Response samples

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"
}

Contact details

Renvoie les informations de contact (informations WHOIS) pour le nom de domaine actif.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/get-contact-details?sld=mydomain&tld=com'

Response samples

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

Save contact details

Sauvegarde les informations des contacts (informations WHOIS) pour le nom de domaine actif donné.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de contact.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

Domaine de premier niveau (TLD) sans la période de sursis.

registrant_first_name
required
string

Le prénom de la personne qui enregistre le domaine.

registrant_last_name
required
string

Le nom de famille de la personne qui enregistre le domaine.

registrant_email
required
string

L'adresse e-mail du titulaire du domaine, utilisée pour les communications concernant la gestion du 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

L'adresse secondaire du titulaire, le cas échéant. Ce champ peut être laissé vide.

registrant_city
required
string

La ville où réside ou est enregistré le titulaire.

registrant_postal_code
required
string

Le code postal ou le code ZIP de la résidence du titulaire.

registrant_state
required
string

L'état ou la province où réside le titulaire.

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

Le numéro de téléphone du titulaire, y compris l'indicatif régional. Les codes d'appel internationaux doivent précéder le numéro, par exemple, '+1' pour le Canada ou '+33' pour la France.

Responses

Request samples

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": "222 rue Halfway.",
  • "registrant_city": "Montreal.",
  • "registrant_postal_code": "44444.",
  • "registrant_state": "Quebec.",
  • "registrant_country_code": "CA.",
  • "registrant_phone": "+1.5145555555."
}

Response samples

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

Get registrar lock

Obtenir le statut de verrouillage d'un nom de domaine enregistré. Si un domaine est verrouillé, il est impossible de le transférer.
See /save-registrar-lock for more info.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/get-registrar-lock?sld=mydomain&tld=com'

Response samples

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

Save registrar lock

Verrouiller ou déverrouiller un nom de domaine enregistré et actif.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres des serveurs de noms.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

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

lock_action
required
string
Enum: "Lock" "Unlock"

Nom de l'action de verrouillage.

Responses

Request samples

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

Response samples

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

Get nameservers

Renvoie les serveurs de noms pour un nom de domaine enregistré.
Il doit y avoir au moins deux serveurs de noms existants associés à un nom de domaine.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/get-nameservers?sld=mydomain&tld=com'

Response samples

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

Save nameservers

Mise à jour des serveurs de noms (nameservers) associés à votre domaine.
Les serveurs de noms doivent exister et être valides.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres des serveurs de noms.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

Domaine de premir niveau (TLD) sans la période de sursis.

ns1
required
string

Serveur de nom primaire pour le domaine.

ns2
required
string

Serveur de nom secondaire pour le domaine.

ns3
string

Serveur de noms de secours (à des fins de redondance).

ns4
string

Serveur de noms de secours (à des fins de redondance).

ns5
string

Serveur de noms de secours (à des fins de redondance).

Responses

Request samples

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

Response samples

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

Get dns records

Récupère les enregistrements DNS pour le nom de domaine actif enregistré auprès de PlanetHoster qui a au moins un serveur de noms à PlanetHoster.

query Parameters
sld
required
string
Example: sld=mydomain

Nom de domaine sans le domaine de premier niveau (TLD).

tld
required
string
Example: tld=com

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

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

curl -X GET \
-H "X-API-KEY: XXXXX" \
-H "X-API-USER: XXXXX" \
'https://api.planethoster.net/reseller-api/get-ph-dns-records?sld=mydomain&tld=com'

Response samples

Content type
application/json
{
  • "message": "DNS zone found on PlanetHoster nameservers",
  • "records": [
    ]
}

Save dns records

Sauvegarde les enregistrements DNS pour le nom de domaine actif enregistré auprès de PlanetHoster et qui a au moins un serveur de noms PlanetHoster.
Si la zone DNS n'existe pas encore sur les serveurs de noms de PlanetHoster, elle est créée.

Notez que cet appel ne fonctionne que pour les domaines qui utilisent le DNS PlanetHoster. nsa.n0c.com, nsb.n0c.com, nsc.n0c.com

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'enregistrement.
Vous pouvez ajouter d'autres enregistrements en incrémentant le nombre à la fin de la clé de paramètres.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

Domaine de premier niveau (TLD) sans la période de sursis.

type1
required
string
Enum: "A" "AAAA" "CNAME" "MX" "MXE" "TXT"

Types d'enregistrement.

hostname1
required
string

Nom d'hôte auquel associer l'enregistrement DNS.

address1
required
string

La valeur dépend du type donné.
Pour les enregistrements A et AAAA, il s'agit de l'adresse IP.
Pour les enregistrements CNAME, il s'agit du nom canonique lui-même.
Pour les enregistrements MX et MXE, il s'agit de l'échange.
Pour les enregistrements TXT, il s'agit des données TXT.

ttl1
integer

DNS TTL (durée de vie) représente le temps nécessaire à chaque étape pour que DNS mette en cache un enregistrement.

priority1
integer

La priorité n'est utilisée que pour les enregistrements MX et MXE.

Responses

Request samples

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com",
  • "type1": "A",
  • "hostname1": "mydomain.com",
  • "address1": "199.188.199.18",
  • "ttl1": 14000,
  • "priority1": 10
}

Response samples

Content type
application/json
{
  • "message": "Successfully updated DNS record(s)"
}

Delete zone

Supprime la zone DNS d'un domaine donné sur les serveurs DNS de PlanetHoster.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Supprime les paramètres de la zone.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Successfully deleted DNS zone on PlanetHoster DNS servers"
}

Email epp code

Envoyer par courriel au titulaire du nom de domaine le code EPP (également appelé Auth Info) d'un domaine donné.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de la requête de code EPP.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

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

Responses

Request samples

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

Response samples

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

Register domain

Tentatives d'enregistrement d'un nom de domaine pour une période de une à dix années.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

X-API-SANDBOX
string

Environments Sandbox mettre 1 pour activer.

Request Body schema: application/json
required

Paramètres d'enregistrement.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

Domaine de premier niveau (TLD) sans la période de sursis.

period
required
integer [ 1 .. 10 ]

Nombre d'années nécessaires pour enregistrer le nom de domaine.
See Tld prices

ns1
required
string

Serveur de nom (nameserver) existant pour utiliser la fonction "DNS lookup" du domaine enregistré.

ns2
required
string

Serveur de nom (nameserver) existant pour utiliser la fonction "DNS lookup" du domaine enregistré.

ns3
string

Serveur de nom (nameserver) existant pour utiliser la fonction "DNS lookup" du domaine enregistré.

ns4
string

Serveur de nom (nameserver) existant pour utiliser la fonction "DNS lookup" du domaine enregistré.

ns5
string

Serveur de nom (nameserver) existant pour utiliser la fonction "DNS lookup" du domaine enregistré.

id_protection
required
boolean

Faut-il ou non commander une protection WHOIS ID pour ce nom de domaine ?
Notez que certains domaines de premier niveau ne prennent pas en charge la protection des identifiants (ID).
See Tld prices

register_if_premium
required
boolean

Faut-il ou non enregistrer le nom de domaine, même s'il s'agit d'un domaine Premium (qui pourrait être beaucoup plus cher) ?

use_planethoster_nameservers
required
boolean

Ne mettez cette valeur à vrai que si vous utilisez 'nsa.n0c.com', 'nsb.n0c.com', et 'nsc.n0c.com' comme valeurs ns1, ns2 et ns3 (ns4 et ns5 doivent être des chaînes vides dans ce cas). Cette option crée une zone DNS pour le nom de domaine sur les serveurs de noms, après un enregistrement réussi.

addtl_field
object

Objet qui représente des champs supplémentaires spécifiques au domaine de premier niveau en cours d'enregistrement.
Voir l'index des available additional fields pour chaque domaine de premier niveau.
Notez que quelques champs additionnels sont requis !

registrant_first_name
required
string

Le prénom de la personne qui enregistre le domaine.

registrant_last_name
required
string

Le nom de famille de la personne qui enregistre le domaine.

registrant_email
required
string

L'adresse e-mail du titulaire du domaine, utilisée pour les communications concernant la gestion du 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

L'adresse secondaire du titulaire, le cas échéant. Ce champ peut être laissé vide.

registrant_city
required
string

La ville où réside ou est enregistré le titulaire.

registrant_postal_code
required
string

Le code postal ou le code ZIP de la résidence du titulaire.

registrant_state
required
string

L'état ou la province où réside le titulaire.

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

Le numéro de téléphone du titulaire, y compris l'indicatif régional. Les codes d'appel internationaux doivent précéder le numéro, par exemple, '+1' pour le Canada ou '+33' pour la France.

Responses

Request samples

Content type
application/json
{
  • "sld": "mydomain",
  • "tld": "com",
  • "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": { },
  • "registrant_first_name": "John.",
  • "registrant_last_name": "Doe.",
  • "registrant_email": "johndoe@mydomain.com.",
  • "registrant_company_name": "string",
  • "registrant_address1": "123 Parkway Lane.",
  • "registrant_address2": "222 rue Halfway.",
  • "registrant_city": "Montreal.",
  • "registrant_postal_code": "44444.",
  • "registrant_state": "Quebec.",
  • "registrant_country_code": "CA.",
  • "registrant_phone": "+1.5145555555."
}

Response samples

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

Renew domain

Renouveler pour un à dix ans un nom de domaine qui est déjà actif.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres du renouvellement.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

Domaine de premier niveau (TLD) sans la période de sursis.

period
required
integer [ 1 .. 10 ]

Nombre d'années pour enregistrer le nom de domaine.
Voyez Tld prices.

Responses

Request samples

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

Response samples

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

Transfer domain

Transférer un nom de domaine de votre registraire actuel à PlanetHoster.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de transfert.

sld
required
string

Nom de domaine sans le domaine de premier niveau (Top-Level Domain).

tld
required
string

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

epp_code
required
string

Le secret de transfert est formé du secret de transfert de domaine (clé de transfert), d'une clé ou d'un code.

Responses

Request samples

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

Response samples

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

World API

Qu'est-ce qu'une plate-forme World ?

Il s'agit d'une plateforme d'hébergement mutualisée Premium réalisée par PlanetHoster qui offre les dernières technologies. Elle est basée sur une infrastructure cloud Premium située dans nos centres de données en Europe (en France et en Suisse) et en Amérique du Nord (au Canada).

Vous pouvez en apprendre davantage en cliquant sur les liens World Plateform et World Product.

Get accounts

Affiche les informations sur le compte World et tous les sous-comptes World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Responses

Request samples 

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

Response samples

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

Create account

Créer un hébergement World et attribue les ressources demandées.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Créer les paramètres du compte.

domain
required
string

Le domaine principal du compte World.

country
required
string
Enum: "CA" "FR"

Le code du pays de l'emplacement demandé.

cpu
integer [ 1 .. 8 ]

La quantité de CPU allouée au compte.

mem
integer [ 1 .. 24 ]

La quantité de mémoire allouée au compte (Go).

io
integer [ 1 .. 24 ]

La quantité d'E/S (I/O) allouée au compte (Mo/s).

ls
boolean

Sélectionnez le serveur Litespeed client PRO uniquement.

Responses

Request samples

Content type
application/json
{
  • "domain": "test-domain.com",
  • "country": "CA",
  • "cpu": 1,
  • "mem": 1,
  • "io": 1,
  • "ls": true
}

Response samples

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

Suspend account

Procéder à la suspension d'un compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Suspendre les paramètres du compte.

id
required
integer

Identifiant du compte World. Peut être trouvé avec /get-accounts.

reason
required
string

Raison de la suspension.

Responses

Request samples

Content type
application/json
{
  • "id": "2222",
  • "reason": "Suspension reason"
}

Response samples

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

Unsuspend account

Procédez à l'activation d'un compte World suspendu.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Lever la suspension des paramètres du compte.

id
required
integer

Identifiant du compte World. Peut être trouvé avec /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Modify resources

Procéder à l'activation d'un compte World suspendu.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Modifier les paramètres des ressources.

id
required
integer

Identifiant du compte World. Peut être trouvé avec /get-accounts.

cpu
integer [ 1 .. 8 ]

Quantité de CPU allouée au compte.

mem
integer [ 1 .. 24 ]

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

io
integer [ 1 .. 24 ]

Nombre d'E/S (I/O) allouées au compte (Mo/s).

Responses

Request samples

Content type
application/json
{
  • "id": "2222",
  • "cpu": 1,
  • "mem": 1,
  • "io": 1
}

Response samples

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

User

Appels liés à l'usager de N0C.

L'identifiant d'usager de N0C. Peut être trouvé avec le point de terminaison /get-accounts.

Temporary domain

Créer un domaine temporaire gratuit pour accéder à votre site web principal.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres du domaine temporaire.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

Content type
application/json
{
  • "data": "XXXXX.n0c.world",
  • "success": true,
  • "errors": [ ]
}

Disable temporary domain

Désactiver le domaine temporaire.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres du domaine temporaire.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

SSH keys

Obtenir les clés SSH installées pour un compte.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres des clés SSH.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add SSH key

Ajouter une clé SSH au compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres de la clé SSH.

pKey
required
string

Clé SSH publique.

comment
string

Commentaire lié à la clé.

fromIps
Array of strings
id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "pKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDSkT3A1j89RT/540ghIMHXIVwNlAEM3WtmqVG7YN/wYwtsJ8iCszg4/lXQsfLFxYmEVe8L9atgtMGCi5QdYPl4X/c+5YxFfm88Yjfx+2xEgUdOr864eaI22yaNMQ0AlyilmK+PcSyxKP4dzkf6B5Nsw8lhfB5n9F5md6GHLLjOGuBbHYlesKJKASDSADADASDssdsdsGEcHewOCbVs+IJWBFSi6w1enbKGc+RY9KrnzeDKWWqzYnNofiHGVFAuMxrmZOasqlTIKiC2UK3RssssmLxZicWiQD6i2S9szDy6aZ",
  • "comment": "string",
  • "fromIps": [
    ],
  • "id": "2222"
}

Response samples

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

Edit SSH key

Modifier une clé SSH existante.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres de la clé SSH.

key
required
string

Empreinte de la clé SSH.

comment
string

Commentaire lié.

fromIps
Array of strings
id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "key": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff",
  • "comment": "string",
  • "fromIps": [
    ],
  • "id": "2222"
}

Response samples

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

Remove SSH key

Supprimer une clé SSH existante.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres de la clé SSH.

key
required
string

Empreinte de la clé SSH.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "key": "00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff",
  • "id": "2222"
}

Response samples

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

Domain

Domains

Obtenir tous les domaines du compte.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add

Ajouter un domaine au compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Ajouter les paramètres du domaine.

domain
required
string

Nom de domaine.

docroot
required
string

Racine du document du domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "docroot": "public_html/mydomain/",
  • "id": "2222"
}

Response samples

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

Remove

Supprimer le domaine du compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Supprimer les paramètres du domaine.

domain
required
string

Nom de domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

Add sub-domain

Ajout d'un sous-domaine au compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Ajout des paramètres du sous-domaine.

domain
required
string

Nom de domaine.

subDomain
required
string

Nom du sous-domaine.

docroot
required
string

Racine du document du domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

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

Response samples

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

Suspend domains

Suspendre un ou plusieurs domaines.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Suspendre les paramètres de domaines.

required
Array of objects

Domaines à suspendre.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domains": [
    ],
  • "id": "2222"
}

Response samples

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

Unsuspend domains

Lever la suspension d'un ou de plusieurs domaines.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Lever la suspension des paramètres de domaines.

required
Array of objects

Domaines dont il faut lever la suspension.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domains": [
    ],
  • "id": "2222"
}

Response samples

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

Change doc-root

Lever la suspension d'un ou de plusieurs domaines.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Lever la suspension des paramètres du domaine.

domain
required
string

Nom de domaine existant.

docroot
required
string

Racine du document de domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "docroot": "public_html/mydomain/",
  • "id": "2222"
}

Response samples

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

Redirections

Obtenir des redirections de domaines.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Internal redirection

Redirection qui forcera HTTPS ou www, par example.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de redirection interne.

domain
required
string

Nom de domaine.

https
required
boolean

Forcer HTTPS ou non.

rType
required
integer
Enum: 301 302
www
required
boolean

Forcer www ou non.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "https": true,
  • "rType": 301,
  • "www": true,
  • "id": "2222"
}

Response samples

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

External redirection

Redirection qui forcera HTTPS ou www, par example.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de redirection externe.

domain
required
string

Nom de domaine.

https
required
boolean

Forcer HTTPS ou non.

rType
required
integer
Enum: 301 302
destinationDomain
required
string

Le domaine auquel vous désirez rediriger le lien.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "https": true,
  • "rType": 301,
  • "destinationDomain": "google.com",
  • "id": "2222"
}

Response samples

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

Delete redirection

Supprimer la redirection d'un domaine.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Supprimer les paramètres de redirection.

domain
required
string

Nom de domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

WAF logs

Obtenir les journaux des règles de pare-feu d'applications web (WAF) du domaine.
Qu'est-ce qu'un Web App Firewall ?

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Obtenir les paramètres des journaux du WAF.

domain
required
string

Nom de domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

WAF rules

Obtenir les règles du pare-feu d'applications web (WAF) du domaine.
Qu'est-ce qu'un Web App Firewall ?

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Obtenir les paramètres des règles du WAF.

domain
required
string

Nom de domaine.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

Update waf rules

Mettre à jour les règles de pare-feu d'applications web (WAF) du domaine.
Qu'est-ce qu'un Web App Firewall ?

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Obtenir les paramètres des règles du WAF.

domain
required
string

Nom de domaine.

wafDisabledRules
required
Array of integers

Règles à désactiver.

append
boolean

Ajouter des règles à la liste de règles de désactivation existante ou réinitialiser avec une nouvelle liste de règles ?'

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "wafDisabledRules": [
    ],
  • "append": true,
  • "id": "2222"
}

Response samples

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

DNS

Get zone DNS

Retrouver la zone dns complète.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Retrouve la zone dns.

domain
required
string

Nom de domaine.

id
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Si vous possedez un compte world (hosting), le id du compte world est REQUIS. Si vous possédez seulement le domaine sans compte d'hébergement, il est possible de gérer la zone avec le domaine seulement.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

Reset / création de la zone dns

Ajoutera les valeurs par défaut de la zone dns.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required
domain
required
string

Nom de domaine.

id
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Si vous possedez un compte world (hosting), le id du compte world est REQUIS. Si vous possédez seulement le domaine sans compte d'hébergement, il est possible de gérer la zone avec le domaine seulement.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222"
}

Response samples

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

Edit / Ajout des records de la zone DNS

Permet d'ajouter ou modifier des records sur la zone DNS

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required
domain
required
string

Nom de domaine.

id
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Si vous possedez un compte world (hosting), le id du compte world est REQUIS. Si vous possédez seulement le domaine sans compte d'hébergement, il est possible de gérer la zone avec le domaine seulement.

required
Array of objects

Liste des records à ajouter ou modifier

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "id": "2222",
  • "rrsets": [
    ]
}

Response samples

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

Email

Emails

Obtenir tous les courriels du compte.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add

Créer une nouvelle adresse de messagerie.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Ajouter les paramètres de l'adresse de messagerie.

domain
required
string

Nom de domaine.

password
required
string

Mot de passe du compte de messagerie.

mailUser
required
string

Utilisateur du courrier électronique.

quota
integer

Taille du quota de courriels en Mo.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

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

Response samples

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

Remove

Supprimer une adresse de courrier électronique.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Supprimer les paramètres de l'adresse électronique.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "id": "2222"
}

Response samples

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

Change password

Changer le mot de passe d'un compte de messagerie.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Changer les paramètres du mot de passe.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

password
required
string

Mot de passe du compte de messagerie.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "id": "2222"
}

Response samples

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

Change quota

Modifier le quota d'un compte de messagerie.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Modifier les paramètres du quota.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

quota
required
integer

Nouveau quota de courriels en Mo.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "quota": 5000,
  • "id": "2222"
}

Response samples

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

Suspend emails

Suspendre plusieurs adresses électroniques.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Suspendre les paramètres de plusieurs adresses électroniques.

required
object

Liste d'adresses électroniques à suspendre.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "emails": {
    },
  • "id": "2222"
}

Response samples

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

Unsuspend emails

Lever la suspension de plusieurs adresses électroniques.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Lever la suspension des paramètres des adresses électroniques.

required
object

Liste des adresses électroniques dont la suspension doit être levée.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "emails": {
    },
  • "id": "2222"
}

Response samples

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

Authentication

Authentification du courriel de la liste.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres d'authentification du courriel.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "id": "2222"
}

Response samples

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

Enable Authentication

Activer l'authentification des messages électroniques.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres d'authentification des paramètres des courriels.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

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

Authentification du courriel.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "auth": "dkim",
  • "id": "2222"
}

Response samples

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

Disable Authentication

Désactiver l'authentification des courriels.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json

Paramètres d'authentification des courriels.

domain
required
string

Nom de domaine.

mailUser
required
string

Utilisateur du courrier électronique.

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

Authentification des courriels.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "mailUser": "info",
  • "auth": "dkim",
  • "id": "2222"
}

Response samples

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

Database

Databases

Obtenir les bases de données des comptes World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres des numéros d'identification (ID) des comptes World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add

Création d'une nouvelle base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Création des paramètres de la base de données.

name
required
string

Nom de la base de données.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "name": "newdatabase",
  • "id": "2222"
}

Response samples

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

Remove

Supprimer la base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Supprimer les paramètres de la base de données.

name
required
string

Nom de la base de données.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "name": "newdatabase",
  • "id": "2222"
}

Response samples

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

Users

Obtenir la liste des usagers de la base de données du compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add user

Création d'un usager de la base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Création des paramètres de l'usager de la base de données.

dbUser
required
string

Nom de la base de données.

password
required
string

Mot de passe du compte de messagerie.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "dbUser": "newuser",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "id": "2222"
}

Response samples

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

Remove user

Retirer l'usager d'une base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Retirer les paramètres de l'usager d'une base de données.

dbUser
required
string

Nom de la base de données.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "dbUser": "newuser",
  • "id": "2222"
}

Response samples

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

Grant permission

Donner à un utilisateur l'accès à une base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres pour donner une permission.

databaseName
required
string

Nom de la base de données.

databaseUsername
required
string

Nom d'usager de la base de données.

privileges
required
Array of any
Items Enum: "ALTER" "ALTER ROUTINE" "CREATE" "CREATE ROUTINE" "CREATE TEMPORARY TABLES" "CREATE VIEW" "DELETE" "DROP" "EVENT" "EXECUTE" "INDEX" "INSERT" "LOCK TABLES" "REFERENCES" "SELECT" "SHOW VIEW" "TRIGGER" "UPDATE"
id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "databaseName": "existing_database",
  • "databaseUsername": "existing_user",
  • "privileges": [
    ],
  • "id": "2222"
}

Response samples

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

Remove permission

Supprimer l'accès d'un utilisateur à une base de données.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres pour retirer une permission.

databaseName
required
string

Nom de la base de données.

databaseUsername
required
string

Nom d'usager de la base de données.

privileges
required
Array of any
Items Enum: "ALTER" "ALTER ROUTINE" "CREATE" "CREATE ROUTINE" "CREATE TEMPORARY TABLES" "CREATE VIEW" "DELETE" "DROP" "EVENT" "EXECUTE" "INDEX" "INSERT" "LOCK TABLES" "REFERENCES" "SELECT" "SHOW VIEW" "TRIGGER" "UPDATE"
id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "databaseName": "existing_database",
  • "databaseUsername": "existing_user",
  • "privileges": [
    ],
  • "id": "2222"
}

Response samples

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

Cron

Crons

Obtenir les tâches cron du compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add

Ajouter un cron au compte World.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Ajouter les paramètres du cron.

schedule
required
string

Horaire du cron.

command
required
string

Commande du cron.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "schedule": "* * * * *",
  • "command": "whoami",
  • "id": "2222"
}

Response samples

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

Remove

Effacer une tâche cron existante.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Effacer les paramètres du cron.

schedule
string

Horaire du cron.

cronId
required
integer

Numéro d'identification du cron. On peut le trouver avec la commande /crons.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "schedule": "* * * * *",
  • "cronId": "whoami",
  • "id": "2222"
}

Response samples

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

Set email

Définir l'adresse de courriel du cron. Cette adresse de courriel recevra la sortie standard (stdout) de la commande.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Définir les paramètres de l'adresse de courriel du cron.

email
required
string

Adresse de courriel du cron.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "email": "cronemail@mydomain.com",
  • "id": "2222"
}

Response samples

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

Remove email

Enlever l'adresse de courriel du cron.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

FTP

FTP accounts

Obtenir tous les comptes FTP.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Add

Créer un compte FTP.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de création d'un compte FTP.

domain
required
string

Nom de domaine.

ftpUser
required
string

Nom d'usager du FTP.

path
required
string

Chemin d'accès lié au compte FTP.

password
required
string

Mot de passe du compte de messagerie.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "ftpUser": "ftpuser1",
  • "path": "ftpuser/directory",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "id": "2222"
}

Response samples

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

Remove

Supprimer un compte FTP.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Supprimer les paramètres de création d'un compte FTP.

domain
required
string

Domain name.

ftpUser
required
string

FTP username.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "ftpUser": "ftpuser1",
  • "id": "2222"
}

Response samples

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

Change password

Changer le mot de passe du compte FTP.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de changement de mot de passe FTP.

domain
required
string

Nom de domaine.

ftpUser
required
string

Nom d'usager du FTP.

password
required
string

Mot de passe du compte de messagerie.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "ftpUser": "ftpuser1",
  • "password": "(%S0L1dP@SsW0RdZ%&)",
  • "id": "2222"
}

Response samples

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

Update path

Mettre à jour le chemin d'accès au compte FTP.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres de modification du chemin d'accès au compte FTP.

domain
required
string

Nom de domaine.

ftpUser
required
string

Nom d'usager du FTP.

path
required
string

Chemin d'accès lié au compte FTP.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "domain": "mydomain.com",
  • "ftpUser": "ftpuser1",
  • "path": "ftpuser/directory",
  • "id": "2222"
}

Response samples

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

List connections

Lister toutes les connexions actives.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Paramètres d'identification du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Wordpress

Get installed wordpress

Installer les chemins d'accès de Wordpress.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Installation d'un wordpress

Installation d'un wordpress

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

adminUser
required
string

L'utilisateur administrateur

adminPassword
required
string

Le mot de passe administrateur

adminEmail
required
string

Le courriel administrateur

domain
required
string

Le nom de domaine associé

path
required
string

Le path d'installation

title
required
string

Le titre du wordpress

locale
string
Default: "fr_FR"

Locale du wordpress

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "adminUser": "JohnDoe",
  • "adminPassword": "(%S0L1dP@SsW0RdZ%&)",
  • "adminEmail": "john@doe.com",
  • "domain": "domaineexample.com",
  • "path": "/blog",
  • "title": "Blog PlanetHoster",
  • "locale": "fr_FR",
  • "id": "2222"
}

Response samples

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

Supprimer wordpress

Suppression d'une installation wordpress

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

path
required
string

Le path d'installation

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "path": "/blog",
  • "id": "2222"
}

Response samples

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

CMS

List des CMS disponibles

List les cms disponibles à l'installation et leurs versions.

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

Content type
application/json
{}

Installation d'un CMS

Lance l'installation d'un CMS

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

cmsType
required
string

cms type

path
required
string

Le path d'installation

domain
required
string

Le domaine du CMS

siteName
required
string

Le titre du CMS

adminName
required
string

Le user administrateur

adminPassword
required
string

Le mot de passe admin

email
required
string

Le courriel de l'administrateur

www
boolean
Default: false

Force le www

https
boolean
Default: true

Force le https

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "cmsType": "joomla",
  • "path": "jooomla-test/",
  • "domain": "exampledomain.com",
  • "siteName": "Mon joomla de test",
  • "adminName": "JoomlaAdmin",
  • "adminPassword": "(%S0L1dP@SsW0RdZ%&)",
  • "email": "john@doe.com",
  • "www": false,
  • "https": true,
  • "id": "2222"
}

Response samples

Content type
application/json
{
  • "data": "12fa6890-a2a2-223ea-a22a-847de9698035",
  • "success": true,
  • "errors": [ ]
}

List les CMS installés

List les CMS installés sur l'hébergement

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

List les installations en cours

List les CMS qui ont récemment été installés ou qui sont en cours d'installation

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Supprime une installation de CMS

Supprime une installation de CMS

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

path
required
string

Le path d'installation

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "path": "/jooomla-test",
  • "id": "2222"
}

Response samples

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

Stats

Performance

Retrouver les données de performance

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

periodType
required
string
Enum: "day" "hour"

Le type de période recherchée

period
required
number [ 1 .. 90 ]

Periode recherchée

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "periodType": "day",
  • "period": 30,
  • "id": "2222"
}

Response samples

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

Utilisation du disque

Retourne l'utilisaton de l'espace disque (réponse toujours en BYTE)

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "id": "2222"
}

Response samples

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

Stats apache

Statistique du serveur web (Visites)

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

period
required
number
Enum: "30d" "7d" "24h" "12h" "1h"

Periode recherchée

domain
required
string

Le domaine visé

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "period": "7d",
  • "domain": "domainexample.com",
  • "id": "2222"
}

Response samples

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

Stats apache (Visiteur Unique)

Statistique du serveur web (Visites)

header Parameters
X-API-USER
required
string

Utilisateur de l'API fourni dans l'espace client.

X-API-KEY
required
string

Clé API fournie dans l'espace client.

Request Body schema: application/json
required

Identifiants des paramètres du compte World.

period
required
number
Enum: "30d" "7d" "24h" "12h" "1h"

Periode recherchée

domain
required
string

Le domaine visé

id
required
integer

Numéro d'identification (ID) du compte World. Il peut être trouvé avec la commande /get-accounts.

Responses

Request samples

Content type
application/json
{
  • "period": "7d",
  • "domain": "domainexample.com",
  • "id": "2222"
}

Response samples

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