PlanetHoster logo
Documentation Powered by ReDoc

PlanetHoster API (2.0.0)

Download OpenAPI specification:Download

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

| Version Française

Description

The PlanetHoster API allows actions related to domain management and web hosting.

Details

  • SSL only: we require that all requests be done over encrypted TLS/SSL connections.
  • Supported HTTP verbs are GET and POST. If your client does not support all HTTP verbs, you can override the verb with X-Http-Method-Override HTTP header.
  • Unless otherwise specified in the method documentation, all successful API calls return an HTTP code 200 with a JSON object.
  • Errors are returned with an HTTP code 4XX or 5XX, a JSON object with properties "error" (an error message) and an "error_code" (optional, an integer).
  • Every string passed to and from the API needs to be UTF-8 encoded.
  • The API sends ETag headers and supports the If-None-Match header.
  • Unless otherwise specified, all API methods require authentication with api_user and api_key.

Authentication and whitelist

  1. In order to be able to contact the API, you must whitelist your IPs.
  2. API user and API key are required in the HTTP header.

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

Domain registered with PlanetHoster related calls.

Tests the connection

Tests the connection to the domain reseller API.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Return information pertinent to your reseller account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Returns domain name prices for registration, renewal and transfer. It also returns whether or not each TLD sold by PlanetHoster supports WHOIS ID protection, and whether it requires an EPP code for domain transfer or not.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Checks whether a domain name is available to register or not.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Retrieve information for a domain you successfully registered or for which you created a transfer order.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Returns the contact information (WHOIS information) for the active domain name.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Saves the contact information (WHOIS information) for the given active domain name.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Contact parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

registrant_first_name
required
string

First name of the domain name registrant contact.

registrant_last_name
required
string

Last name of the domain name registrant contact.

registrant_email
required
string

Email address of the domain name registrant contact.

registrant_company_name
string

Name of company or organization for which the registrant contact is registering the domain name. Can be empty if it is for personal use.

registrant_address1
required
string

Civic number and street name of company or registrant contact's primary residence.

registrant_address2
string

Civic number and street name of registrant contact's secondary residence.
Can be empty.

registrant_city
required
string

Name of the city in which registrant contact resides.

registrant_postal_code
required
string

Postal code or ZIP code of registrant contact's residence.

registrant_state
required
string

State or province of registrant contact's residence.

registrant_country_code
required
string

Two letters code of registrant contact's residence country.
See country code list

registrant_phone
required
string

Phone number, including area code: '+1.' for Canada or '+33.' for France.
With international calling code at the beginning.

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

Get the lock status of a registered domain name.
If a domain is locked, it means that it cannot be transferred.
See /save-registrar-lock for more info.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Lock or unlock a registered and active domain name.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Nameservers parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

lock_action
required
string
Enum: "Lock" "Unlock"

Lock action name.

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

Returns the nameservers for a registered domain name.
There must be at least two existing nameservers associated with a domain name.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Update the nameservers associated with your domain.
The nameservers must exist and be valid nameservers.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Nameservers parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

ns1
required
string

Primary nameserver for the domain.

ns2
required
string

Secondary nameserver for the domain.

ns3
string

Backup nameserver (for redundancy purposes).

ns4
string

Backup nameserver (for redundancy purposes).

ns5
string

Backup nameserver (for redundancy purposes).

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

Retrieves the DNS records for the active domain name registered with PlanetHoster that has at least one PlanetHoster nameserver.

query Parameters
sld
required
string
Example: sld=mydomain

Domain name without the Top-Level Domain (TLD).

tld
required
string
Example: tld=com

TLD without the leading period.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Saves the DNS records for the active domain name registered with PlanetHoster that has at least one PlanetHoster nameserver.
If the DNS zone does not yet exist on PlanetHoster nameservers, it is created.

Note that this call only work for domain that use PlanetHoster DNS. nsa.n0c.com, nsb.n0c.com, nsc.n0c.com

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Records parameters.
You can add more records by incrementing the number at the end of the parameters key.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

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

Record types.

hostname1
required
string

Hostname with which to associate the DNS record.

address1
required
string

Value depends on type given.
For A and AAAA records, this is the IP address.
For CNAME records, this is the canonical name itself.
For MX and MXE records, this is the exchange.
For TXT records, this is the TXT data.

ttl1
integer

DNS TTL (time to live) represents the time each step takes for DNS to cache a record

priority1
integer

Priority is for MX and MXE records only.

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

Deletes the DNS zone on the PlanetHoster DNS servers for the given domain.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Delete zone parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

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

Email to the domain name registrant the EPP code (also called Auth Info) for the given domain.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

EPP code request parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

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

Attempts to register a domain name for 1 to 10 years.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

X-API-SANDBOX
string

Sandbox Environments set 1 to activate.

Request Body schema: application/json

Register parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

period
required
integer [ 1 .. 10 ]

Number of years to register the domain name.
See Tld prices

ns1
required
string

Existing nameserver to use for DNS lookup of the registered domain.

ns2
required
string

Existing nameserver to use for DNS lookup of the registered domain.

ns3
string

Existing nameserver to use for DNS lookup of the registered domain.

ns4
string

Existing nameserver to use for DNS lookup of the registered domain.

ns5
string

Existing nameserver to use for DNS lookup of the registered domain.

id_protection
required
boolean

Whether or not to order WHOIS ID protection for this domain name.
Note that not all TLDs support ID protection.
See Tld prices

register_if_premium
required
boolean

Register the domain name even if it is a Premium domain, which could be much more expensive.

use_planethoster_nameservers
required
boolean

Only set this to true when using 'nsa.n0c.com', 'nsb.n0c.com', and 'nsc.n0c.com' as your ns1, ns2 and ns3 values (ns4 and ns5 should be empty strings in this case). This option creates a DNS zone for the domain name on the nameservers after successful registration.

addtl_field
object

Object that represent additional fields specific for the TLD that is being registered.
See the index of available additional fields for each TLD. Note that some additional fields are required!

registrant_first_name
required
string

First name of the domain name registrant contact.

registrant_last_name
required
string

Last name of the domain name registrant contact.

registrant_email
required
string

Email address of the domain name registrant contact.

registrant_company_name
string

Name of company or organization for which the registrant contact is registering the domain name. Can be empty if it is for personal use.

registrant_address1
required
string

Civic number and street name of company or registrant contact's primary residence.

registrant_address2
string

Civic number and street name of registrant contact's secondary residence.
Can be empty.

registrant_city
required
string

Name of the city in which registrant contact resides.

registrant_postal_code
required
string

Postal code or ZIP code of registrant contact's residence.

registrant_state
required
string

State or province of registrant contact's residence.

registrant_country_code
required
string

Two letters code of registrant contact's residence country.
See country code list

registrant_phone
required
string

Phone number, including area code: '+1.' for Canada or '+33.' for France.
With international calling code at the beginning.

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

Renew an already active domain name for 1-10 years.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Renewal parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

period
required
integer [ 1 .. 10 ]

Number of years to register the domain name. See 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

Transfer a domain name from your current registrar to PlanetHoster.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Transfer parameters.

sld
required
string

Domain name without the Top-Level Domain.

tld
required
string

TLD without the leading period.

epp_code
required
string

Transfer secret is a domain transfer secret (transfer key), a key or 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

What is a World Platform ?

It is a Premium shared hosting platform made by PlanetHoster that offers the latest technology. It is based on a Premium cloud infrastructure located in our data centers in Europe (France and Swiss) and in North America (Canada).

Learn more about World Plateform and World Product.

Get accounts

Displays the World account and all World sub-accounts informations.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

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

Creates a World hosting and assigns the requested resources.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Create account parameters.

domain
required
string

World account principal domain.

country
required
string
Enum: "CA" "FR"

Country code of the requested location.

cpu
integer [ 1 .. 8 ]

Amount of CPU allocated to the account.

mem
integer [ 1 .. 24 ]

Amount of memory allocated to the account (GB).

io
integer [ 1 .. 24 ]

Amount of I/O allocated to the account (MB/s).

ls
boolean

Select litespeed server PRO client only.

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

Proceed to the suspension of a World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Suspend account parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

reason
required
string

Reason for the 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

Proceed to the activation of a suspended World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Unsuspend account parameters.

id
required
integer

World account ID. Can be found with /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

Proceed to the activation of a suspended World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Modify resources parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

cpu
integer [ 1 .. 8 ]

Amount of CPUs allocated to the account.

mem
integer [ 1 .. 24 ]

Amount of memory allocated to the account (GB).

io
integer [ 1 .. 24 ]

Amount of I/O allocated to the account (MB/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

N0C user related calls.

N0C user ID. Can be found with /get-accounts endpoint.

Temporary domain

Generate a free temporary domain to access your main website.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Temporary domain parameters.

id
required
integer

World account ID. Can be found with /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

Disable the temporary domain.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Temporary domain parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

SSH keys

Get SSH keys installed for an account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

SSH keys parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add SSH key

Add a SSH key to the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

SSH key parameters.

pKey
required
string

SSH public key.

comment
string

Related comment.

fromIps
Array of strings
id
required
integer

World account ID. Can be found with /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

Edit an existing SSH key.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

SSH key parameters.

key
required
string

SSH key fingerprint.

comment
string

Related comment.

fromIps
Array of strings
id
required
integer

World account ID. Can be found with /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

Remove an existing SSH key.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

SSH key parameters.

key
required
string

SSH key fingerprint.

id
required
integer

World account ID. Can be found with /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

Get all domains of the account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add

Add a domain to the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Add domain parameters.

domain
required
string

Domain name.

docroot
required
string

Domain document root.

id
required
integer

World account ID. Can be found with /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

Remove the domain from the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove domain parameters.

domain
required
string

Domain name.

id
required
integer

World account ID. Can be found with /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

Add a sub-domain to the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Add sub-domain parameters.

domain
required
string

Domain name.

subDomain
required
string

Sub-domain name.

docroot
required
string

Domain document root.

id
required
integer

World account ID. Can be found with /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

Suspend one or multiple domains.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Suspend domains parameters.

required
Array of objects

Domains to suspend.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Unsuspend domains

Unsuspend one or multiple domains.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Unsuspend domains parameters.

required
Array of objects

Domains to unsuspend.

id
required
integer

World account ID. Can be found with /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

Unsuspend one or multiple domains.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Unsuspend domains parameters.

domain
required
string

Existing domain name.

docroot
required
string

Domain document root.

id
required
integer

World account ID. Can be found with /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

Get domain redirections.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Internal redirection

Redirection that will force HTTPS or www, for example.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Internal redirection parameters.

domain
required
string

Domain name.

https
required
boolean

Force HTTPS or not.

rType
required
integer
Enum: 301 302
www
required
boolean

Force www or not.

id
required
integer

World account ID. Can be found with /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 that will force HTTPS or www, for example.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

External redirection parameters.

domain
required
string

Domain name.

https
required
boolean

Force HTTPS or not.

rType
required
integer
Enum: 301 302
destinationDomain
required
string

Domain you want to redirect to.

id
required
integer

World account ID. Can be found with /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

Delete redirection for a domain.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Delete redirection parameters.

domain
required
string

Domain name.

id
required
integer

World account ID. Can be found with /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

Get domain WAF logs. What is a Web App Firewall?

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Get WAF logs parameters.

domain
required
string

Domain name.

id
required
integer

World account ID. Can be found with /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

Get the domain WAF rules.
What is a Web App Firewall?

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Get WAF rules parameters.

domain
required
string

Domain name.

id
required
integer

World account ID. Can be found with /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

Update WAF rules for the domain.
What is a Web App Firewall?

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Get WAF rules parameters.

domain
required
string

Domain name.

wafDisabledRules
required
Array of integers

Rules to disable.

append
boolean

Append rules to existing disable rules list or reset with new rules list?'

id
required
integer

World account ID. Can be found with /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 DNS zone

Find the complete dns zone.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Find the complete dns zone.

domain
required
string

Domain name

id
integer

ID number of the World account. It can be found with the command /get-accounts.

If you have a world account (hosting), the world account id is REQUIRED. If you only own the domain without a hosting account, it is possible to manage the zone with the domain only.

Responses

Request samples

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

Response samples

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

Zone create / reset to default value

Will add the default values of the dns zone.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json
domain
required
string

Domain name

id
integer

ID number of the World account. It can be found with the command /get-accounts.

If you have a world account (hosting), the world account id is REQUIRED. If you only own the domain without a hosting account, it is possible to manage the zone with the domain only.

Responses

Request samples

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

Response samples

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

Edit / add zone records

Allows you to add or modify records on the DNS zone

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json
domain
required
string

Domain name

id
integer

ID number of the World account. It can be found with the command /get-accounts.

If you have a world account (hosting), the world account id is REQUIRED. If you only own the domain without a hosting account, it is possible to manage the zone with the domain only.

required
Array of objects

Records list

Responses

Request samples

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

Response samples

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

Email

Emails

Get all account emails.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add

Create a new email address.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Add email parameters.

domain
required
string

Domain name.

password
required
string

Email account password.

mailUser
required
string

Email user.

quota
integer

Size of the email quota in MB.

id
required
integer

World account ID. Can be found with /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

Remove an email address.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove email parameters.

domain
required
string

Domain name.

mailUser
required
string

Email user.

id
required
integer

World account ID. Can be found with /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

Change the password of an email account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Change the parameters of the password.

domain
required
string

Domain name.

mailUser
required
string

Email user.

password
required
string

Email account password.

id
required
integer

World account ID. Can be found with /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

Change quota of an email account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Change quota parameters.

domain
required
string

Domain name.

mailUser
required
string

Email user.

quota
required
integer

New email quota in MB.

id
required
integer

World account ID. Can be found with /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

Suspend multiple email addresses.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Suspend emails parameters.

required
object

List of emails to suspend.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Unsuspend emails

Unsuspend multiple email addresses.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Unsuspend emails parameters.

required
object

List of emails to unsuspend.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Authentication

List email authentication.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Email authentication parameters.

domain
required
string

Domain name.

mailUser
required
string

Email user.

id
required
integer

World account ID. Can be found with /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

Enable email authentication.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Email authentication parameters.

domain
required
string

Domain name.

mailUser
required
string

Email user.

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

Email authentication.

id
required
integer

World account ID. Can be found with /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

Disable email authentication.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Email authentication parameters.

domain
required
string

Domain name.

mailUser
required
string

Email user.

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

Email authentication.

id
required
integer

World account ID. Can be found with /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

Get World account databases.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add

Create a new database.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Create database parameters.

name
required
string

Database name.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Remove

Remove database.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove database parameters.

name
required
string

Database name.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Users

Get World account database users.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add user

Create a new database user.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Create the database user parameters.

dbUser
required
string

Database name.

password
required
string

Email account password.

id
required
integer

World account ID. Can be found with /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

Remove a database user.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove database user parameters.

dbUser
required
string

Database name.

id
required
integer

World account ID. Can be found with /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

Grant access to a database for a user.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Grant permission parameters.

databaseName
required
string

Database name.

databaseUsername
required
string

Database username.

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

World account ID. Can be found with /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

Remove access to a database for an user.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove permission parameters.

databaseName
required
string

Database name.

databaseUsername
required
string

Database username.

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

World account ID. Can be found with /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

Get world the cron jobs of the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add

Add cron to the World account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Add cron parameters.

schedule
required
string

Cron schedule.

command
required
string

Cron command.

id
required
integer

World account ID. Can be found with /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

Remove an existing cron job.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove cron parameters.

schedule
string

Cron schedule.

cronId
required
integer

Cron ID. It can be found with /crons.

id
required
integer

World account ID. Can be found with /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

Set cron email.
This email will receive the stdout of the command.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Set cron email parameters.

email
required
string

Cron email.

id
required
integer

World account ID. Can be found with /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

Remove cron email.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

FTP

FTP accounts

Get all FTP accounts.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Add

Create an FTP account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

FTP account creation parameters.

domain
required
string

Domain name.

ftpUser
required
string

FTP username.

path
required
string

Path related to the FTP account.

password
required
string

Email account password.

id
required
integer

World account ID. Can be found with /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

Remove an FTP account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Remove FTP account creation parameters.

domain
required
string

Domain name.

ftpUser
required
string

FTP username.

id
required
integer

World account ID. Can be found with /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

Change the password of the FTP account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

FTP change password parameters.

domain
required
string

Domain name.

ftpUser
required
string

FTP username.

password
required
string

Email account password.

id
required
integer

World account ID. Can be found with /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

Update the path of the FTP account.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

Parameters for changing FTP account path.

domain
required
string

Domain name.

ftpUser
required
string

FTP username.

path
required
string

Path related to the FTP account.

id
required
integer

World account ID. Can be found with /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

List all active connections.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /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

Get Wordpress paths installed.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account ID parameters.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Wordpress installation

Wordpress installation

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

adminUser
required
string

The administrator user

adminPassword
required
string

Administrator password

adminEmail
required
string

Administrator e-mail

domain
required
string

The associated domain name

path
required
string

The installation path

title
required
string

The wordpress title

locale
string
Default: "fr_FR"

Wordpress locales

id
required
integer

World account ID. Can be found with /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": [ ]
}

Delete wordpress installation

Removing a wordpress installation

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

path
required
string

The installation path

id
required
integer

World account ID. Can be found with /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 of CMS available

List the cms available for installation and their versions.

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

Content type
application/json
{}

Installing a CMS

Start the installation of a CMS

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

cmsType
required
string

CMS type

path
required
string

The installation path

domain
required
string

The domain of the CMS

siteName
required
string

The title of the CMS

adminName
required
string

The administrator user

adminPassword
required
string

The admin password

email
required
string

Administrator's email

www
boolean
Default: false

Force the www

https
boolean
Default: true

Force the HTTPS

id
required
integer

World account ID. Can be found with /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 the installed CMS

List the CMS installed on the hosting

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json
id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

List installation in progress

List CMS that have recently been installed or are in the process of being installed

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json
id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Delete a CMS installation

Delete a CMS installation

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json
path
required
string

Installation path

id
required
integer

World account ID. Can be found with /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

Retrieve performance data

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

periodType
required
string
Enum: "day" "hour"

The type of period you are looking for

period
required
number [ 1 .. 90 ]

Search period

id
required
integer

World account ID. Can be found with /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": [ ]
}

Disk usage

Returns disk space usage (response always in BYTE)

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

id
required
integer

World account ID. Can be found with /get-accounts.

Responses

Request samples

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

Response samples

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

Stats apache

Web server statistics (Visits)

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

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

Search period

domain
required
string

The target domain

id
required
integer

World account ID. Can be found with /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 (Unique Visitor)

Web server statistics (Visits)

header Parameters
X-API-USER
required
string

API user provided in the client area.

X-API-KEY
required
string

API key provided in the client area.

Request Body schema: application/json

World account settings credentials.

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

Search period

domain
required
string

The target domain

id
required
integer

World account ID. Can be found with /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": [ ]
}