PlanetHoster logo
API docs by Redocly

PlanetHoster API (3.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 provides a comprehensive set of tools for managing domain names and web hosting services. It enables users to perform a wide range of actions, including domain registration, DNS management, hosting configuration, SSL certificate management, and application deployment. With support for multiple programming languages and web technologies, the API empowers developers to automate and streamline operations related to domains, hosting accounts, emails, databases, and security settings, offering a flexible and efficient hosting experience.

Looking for our legacy API? Access the documentation here: Legacy API Documentation

Details

  • SSL Required: All requests must be made over encrypted TLS/SSL connections.
  • Supported HTTP Verbs: The API supports GET, POST, PUT, PATCH, and DELETE. If your client does not support all verbs, you can override the verb using the X-Http-Method-Override HTTP header.
  • Response Codes: By default, successful API calls return an HTTP 200 OK status with a JSON object in the response.
  • Error Handling: Errors are returned with HTTP status codes 4XX or 5XX, along with a JSON object containing an "error" message and an optional "error_code" integer.
  • UTF-8 Encoding: All strings sent to and received from the API must be UTF-8 encoded.
  • ETag Support: The API sends ETag headers and supports the If-None-Match header for cache validation.
  • Authentication: Unless otherwise specified, all API methods require authentication via X-API-USER and X-API-KEY.

Authentication and Whitelisting

  1. To access the API, you must first whitelist your IP addresses.
  2. Authentication requires both an API user and an API key, which should be included in the HTTP headers of your requests.

You can find your whitelisted IP addresses and credentials in the PlanetHoster Client Area - Reseller Section.

X-API-USER

Your unique API user identifier.

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

X-API-KEY

Your API key for authentication.

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

General Operations

General PlanetHoster account operations.

Test API connection

Performs a simple test to verify the connection to the PlanetHoster API.

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

Responses

Request samples 

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

Response samples

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

Account info

Retrieve detailed information about your reseller account, including credits, currency, and the number of active orders, and domains.

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

Responses

Request samples 

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

Response samples

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

TLD pricing information

Retrieves pricing details for domain name registration, renewal, and transfer across all TLDs offered by PlanetHoster. The response also indicates whether WHOIS ID protection is supported for each TLD and whether an EPP code is required for domain transfers.

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

Currency in which to retrieve the prices (e.g., USD, EUR, CAD).

Responses

Request samples

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

Response samples

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

Domains Management

Manage domain names, including registration and renewal operations.

Account domains

Retrieves a list of all active domains associated with your account. The response includes the total number of active domains and their corresponding domain names.

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

Responses

Request samples 

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

Response samples

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

Domain information

Retrieves detailed information about a domain that has been successfully registered or for which a transfer order has been created. This includes registration details, transfer status, and additional domain-related data.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

Content type
application/json
{
  • "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"
}

Check domain availability

Verifies if a specific domain name is available for registration. The request requires both the Second-Level Domain (SLD) and Top-Level Domain (TLD) to be provided. The response includes whether the domain is available, if it is categorized as a premium domain, and pricing details for premium domains.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

Content type
application/json
{
  • "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
}

Register domain

Initiates the domain registration process, allowing you to register a domain name for a duration between 1 and 10 years.

The registration can be customized with specific nameservers and an ID protection option. Premium domains may incur higher registration fees.

Some domains may require additional information. For more details, refer to our Knowledge Base article on Country-Code Domain Specifications.

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

Parameters required to register the domain.

period
required
integer [ 1 .. 10 ]

The number of years to register the domain.
See TLD prices for details on pricing per TLD.

ns1
required
string

Primary nameserver to use for DNS lookup of the domain.

ns2
required
string

Secondary nameserver to use for DNS lookup of the domain.

ns3
string

Optional third nameserver for DNS lookup.

ns4
string

Optional fourth nameserver for DNS lookup.

ns5
string

Optional fifth nameserver for DNS lookup.

id_protection
required
boolean

Indicates whether WHOIS ID protection should be enabled for this domain.
Note that some TLDs may not support ID protection.
See TLD prices for more details.

register_if_premium
required
boolean

Proceed with registration even if the domain is classified as a premium domain, which may result in higher costs.

use_planethoster_nameservers
required
boolean

Set this to true if you are using PlanetHoster's default nameservers (nsa.n0c.com, nsb.n0c.com, and nsc.n0c.com).
If enabled, a DNS zone will automatically be created for the domain after successful registration.

addtl_field
object

An object representing additional fields required for the specific TLD being registered.
Note: Some fields may be mandatory based on the TLD.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

registrant_first_name
required
string

The first name of the individual registering the domain.

registrant_last_name
required
string

The last name of the individual registering the domain.

registrant_email
required
string

The email address of the domain registrant, used for communication regarding domain management.

registrant_company_name
string

The name of the company or organization associated with the domain registration. This field can be left blank if the registration is for personal use.

registrant_address1
required
string

The primary street address of the registrant or their organization, including civic number.

registrant_address2
string

An additional address line for the registrant, if applicable. This field can be left blank.

registrant_city
required
string

The city where the registrant resides or is registered.

registrant_postal_code
required
string

The postal or ZIP code of the registrant’s residence.

registrant_state
required
string

The state or province where the registrant resides.

registrant_country_code
required
string

The two-letter country code representing the registrant’s country of residence. Refer to the country code list here.

registrant_phone
required
string

The phone number of the registrant, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

admin_first_name
string

The first name of the individual listed as the administrative contact for the domain.

admin_last_name
string

The last name of the individual listed as the administrative contact for the domain.

admin_email
string

The email address of the administrative contact, used for domain-related communication.

admin_company_name
string

The name of the company or organization associated with the administrative contact. This field can be left blank if the registration is for personal use.

admin_address1
string

The primary street address of the administrative contact, including the civic number.

admin_address2
string

An additional address line for the administrative contact, if applicable. This field can be left blank.

admin_city
string

The city where the administrative contact is located.

admin_postal_code
string

The postal or ZIP code of the administrative contact’s address.

admin_state
string

The state or province where the administrative contact is located.

admin_country_code
string

The two-letter ISO 3166-1 country code for the administrative contact's country. Refer to the country code list here.

admin_phone
string

The phone number of the administrative contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

billing_first_name
string

The first name of the individual listed as the billing contact for the domain.

billing_last_name
string

The last name of the individual listed as the billing contact for the domain.

billing_email
string

The email address of the billing contact, used for domain-related billing inquiries.

billing_company_name
string

The name of the company or organization associated with the billing contact. This field can be left blank if the registration is for personal use.

billing_address1
string

The primary street address of the billing contact, including the civic number.

billing_address2
string

An additional address line for the billing contact, if applicable. This field can be left blank.

billing_city
string

The city where the billing contact is located.

billing_postal_code
string

The postal or ZIP code of the billing contact’s address.

billing_state
string

The state or province where the billing contact is located.

billing_country_code
string

The two-letter ISO 3166-1 country code for the billing contact's country. Refer to the country code list here.

billing_phone
string

The phone number of the billing contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

tech_first_name
string

The first name of the individual listed as the technical contact for the domain.

tech_last_name
string

The last name of the individual listed as the technical contact for the domain.

tech_email
string

The email address of the technical contact, used for domain-related technical inquiries.

tech_company_name
string

The name of the company or organization associated with the technical contact. This field can be left blank if the registration is for personal use.

tech_address1
string

The primary street address of the technical contact, including the civic number.

tech_address2
string

An additional address line for the technical contact, if applicable. This field can be left blank.

tech_city
string

The city where the technical contact is located.

tech_postal_code
string

The postal or ZIP code of the technical contact’s address.

tech_state
string

The state or province where the technical contact is located.

tech_country_code
string

The two-letter ISO 3166-1 country code for the technical contact's country. Refer to the country code list here.

tech_phone
string

The phone number of the technical contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

Responses

Request samples

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

Transfer domain

Initiates the process to transfer a domain name from your current registrar to PlanetHoster. This allows you to consolidate domain management within the PlanetHoster platform. The transfer requires the domain's Second-Level Domain (SLD), Top-Level Domain (TLD), and the domain's transfer authorization code (EPP code) from your current registrar.

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

Parameters required for initiating a domain transfer.

epp_code
required
string

The domain transfer authorization code, also known as the EPP code or transfer key. This is required to authorize the transfer from your current registrar.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Renew domain

Renews an active domain name registration for a specified period of 1 to 10 years. This ensures that the domain remains active and registered under your ownership for the chosen duration.

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

Parameters required for domain renewal.

period
required
integer [ 1 .. 10 ]

The number of years to renew the domain registration.
Refer to TLD prices for pricing details based on the domain extension.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Contacts details

Retrieves the WHOIS contact information for an active domain name. This operation provides detailed insights into the registered contacts associated with the domain, including personal and company details. This information is crucial for domain management and can assist in various administrative processes.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Update contact details

Updates the WHOIS contact information for the specified active domain name. This operation allows you to modify essential details such as the registrant's name, address, email, and phone number. It is important to keep this information accurate to ensure effective communication regarding domain management and ownership.

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

Contact update parameters.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

registrant_first_name
required
string

The first name of the individual registering the domain.

registrant_last_name
required
string

The last name of the individual registering the domain.

registrant_email
required
string

The email address of the domain registrant, used for communication regarding domain management.

registrant_company_name
string

The name of the company or organization associated with the domain registration. This field can be left blank if the registration is for personal use.

registrant_address1
required
string

The primary street address of the registrant or their organization, including civic number.

registrant_address2
string

An additional address line for the registrant, if applicable. This field can be left blank.

registrant_city
required
string

The city where the registrant resides or is registered.

registrant_postal_code
required
string

The postal or ZIP code of the registrant’s residence.

registrant_state
required
string

The state or province where the registrant resides.

registrant_country_code
required
string

The two-letter country code representing the registrant’s country of residence. Refer to the country code list here.

registrant_phone
required
string

The phone number of the registrant, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

admin_first_name
string

The first name of the individual listed as the administrative contact for the domain.

admin_last_name
string

The last name of the individual listed as the administrative contact for the domain.

admin_email
string

The email address of the administrative contact, used for domain-related communication.

admin_company_name
string

The name of the company or organization associated with the administrative contact. This field can be left blank if the registration is for personal use.

admin_address1
string

The primary street address of the administrative contact, including the civic number.

admin_address2
string

An additional address line for the administrative contact, if applicable. This field can be left blank.

admin_city
string

The city where the administrative contact is located.

admin_postal_code
string

The postal or ZIP code of the administrative contact’s address.

admin_state
string

The state or province where the administrative contact is located.

admin_country_code
string

The two-letter ISO 3166-1 country code for the administrative contact's country. Refer to the country code list here.

admin_phone
string

The phone number of the administrative contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

billing_first_name
string

The first name of the individual listed as the billing contact for the domain.

billing_last_name
string

The last name of the individual listed as the billing contact for the domain.

billing_email
string

The email address of the billing contact, used for domain-related billing inquiries.

billing_company_name
string

The name of the company or organization associated with the billing contact. This field can be left blank if the registration is for personal use.

billing_address1
string

The primary street address of the billing contact, including the civic number.

billing_address2
string

An additional address line for the billing contact, if applicable. This field can be left blank.

billing_city
string

The city where the billing contact is located.

billing_postal_code
string

The postal or ZIP code of the billing contact’s address.

billing_state
string

The state or province where the billing contact is located.

billing_country_code
string

The two-letter ISO 3166-1 country code for the billing contact's country. Refer to the country code list here.

billing_phone
string

The phone number of the billing contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for France.

tech_first_name
string

The first name of the individual listed as the technical contact for the domain.

tech_last_name
string

The last name of the individual listed as the technical contact for the domain.

tech_email
string

The email address of the technical contact, used for domain-related technical inquiries.

tech_company_name
string

The name of the company or organization associated with the technical contact. This field can be left blank if the registration is for personal use.

tech_address1
string

The primary street address of the technical contact, including the civic number.

tech_address2
string

An additional address line for the technical contact, if applicable. This field can be left blank.

tech_city
string

The city where the technical contact is located.

tech_postal_code
string

The postal or ZIP code of the technical contact’s address.

tech_state
string

The state or province where the technical contact is located.

tech_country_code
string

The two-letter ISO 3166-1 country code for the technical contact's country. Refer to the country code list here.

tech_phone
string

The phone number of the technical contact, including the area code. International calling codes should precede the number, e.g., '+1' for Canada or '+33' for 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.",
  • "admin_first_name": "John.",
  • "admin_last_name": "Doe.",
  • "admin_email": "johndoe@mydomain.com.",
  • "admin_company_name": "string",
  • "admin_address1": "123 Parkway Lane.",
  • "admin_address2": "222 rue Halfway.",
  • "admin_city": "Montreal.",
  • "admin_postal_code": "44444.",
  • "admin_state": "Quebec.",
  • "admin_country_code": "CA.",
  • "admin_phone": "+1.5145555555.",
  • "billing_first_name": "John.",
  • "billing_last_name": "Doe.",
  • "billing_email": "johndoe@mydomain.com.",
  • "billing_company_name": "string",
  • "billing_address1": "123 Parkway Lane.",
  • "billing_address2": "222 rue Halfway.",
  • "billing_city": "Montreal.",
  • "billing_postal_code": "44444.",
  • "billing_state": "Quebec.",
  • "billing_country_code": "CA.",
  • "billing_phone": "+1.5145555555.",
  • "tech_first_name": "John.",
  • "tech_last_name": "Doe.",
  • "tech_email": "johndoe@mydomain.com.",
  • "tech_company_name": "string",
  • "tech_address1": "123 Parkway Lane.",
  • "tech_address2": "222 rue Halfway.",
  • "tech_city": "Montreal.",
  • "tech_postal_code": "44444.",
  • "tech_state": "Quebec.",
  • "tech_country_code": "CA.",
  • "tech_phone": "+1.5145555555."
}

Response samples

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

Registrar lock

Retrieve the lock status of a registered domain name. This operation informs you whether the domain is currently locked or unlocked.
A locked domain cannot be transferred to another registrar, providing an additional layer of security against unauthorized transfer attempts.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Activate registrar lock

Activates the registrar lock on a registered and active domain name. This process prevents unauthorized transfers by ensuring that the domain cannot be moved to another registrar without first being unlocked.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Deactivate registrar lock

Deactivates the registrar lock on a registered and active domain name, allowing it to be transferred to another registrar. This operation is essential for managing domain ownership changes prior to initiating a transfer.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Get nameservers

Fetches the nameservers associated with a registered domain name. This operation ensures that you can view the current nameserver settings for your domain, which are essential for directing traffic and managing DNS records. Note: At least two nameservers must be associated with the domain for this operation to succeed.

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

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Update nameservers

Updates the nameservers associated with your domain. This operation allows you to specify the primary and secondary nameservers, as well as optional backup nameservers for redundancy.
Ensure that all specified nameservers are valid and currently operational; otherwise, the update may fail.

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

Parameters for updating the nameservers.

ns1
required
string

The primary nameserver for the domain, responsible for initial DNS queries.

ns2
required
string

The secondary nameserver for the domain, used for redundancy and load balancing.

ns3
string

An optional backup nameserver, providing additional redundancy.

ns4
string

Another optional backup nameserver for increased reliability.

ns5
string

A fifth optional backup nameserver, further enhancing redundancy.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (TLD) without the leading period.

Responses

Request samples

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

Response samples

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

Email EPP code

Sends the EPP code (also known as the Auth Info code) for the specified domain to the email address of the domain registrant. The EPP code is required when transferring a domain to another registrar, and this operation ensures it is securely sent to the appropriate email on file.

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

Parameters required to request the EPP code for a domain.

sld
required
string

The Second-Level Domain (SLD), which is the domain name excluding the Top-Level Domain (TLD).

tld
required
string

The Top-Level Domain (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",
  • "domain_name": "mydomain.com"
}

Hostings Management

Manage hosting services, including configurations and account settings.

The World Information

Retrieves detailed information about your The World service and all associated sub-accounts. This includes resource allocation, status, and other essential details for managing sub-hostings. Useful for monitoring available resources and managing the status of your sub-accounts.

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

Responses

Request samples 

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

Response samples

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

HybridClouds Information

Retrieves detailed information about all your N0C HybridCloud servers and their associated accounts. This includes resource allocation, server status, and essential details for managing your HybridCloud servers.

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

Responses

Request samples 

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

Response samples

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

Create account

Creates a new N0C account on either a HybridCloud or The World hosting platform, allocating the specified resources and optionally pre-installing a CMS.

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

Parameters required to create the account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

disk_space
integer

Maximum disk space allowed for the account (in GB).

domain
required
string

Primary domain for the account.

cpu
integer

Number of CPU cores allocated to the account.

memory
integer

Amount of memory allocated to the account (in GB).

io
integer

I/O bandwidth allocated to the account (in MB/s).

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

Optionally pre-install a CMS during account creation.

Responses

Request samples

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

Response samples

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

Modify account

Update the resource allocation for a N0C account hosted on either the HybridCloud or The World platform. This operation allows you to adjust the CPU, memory, I/O, and disk space as needed.

Additionally, this endpoint can be used to change the hosting account password.

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

Parameters to modify an hosting account.

One of
One of
Any of
disk_space
integer

Disk space limit for the account (in GB).

cpu
required
integer

Number of CPU cores to allocate to the account.

memory
integer

Amount of memory (in GB) to allocate to the account.

io
integer

I/O bandwidth (in MB/s) to allocate to the account.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Delete hosting account

Permanently deletes a N0C account from either the HybridCloud or The World hosting platforms.

Note: The account must be suspended prior to deletion.

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

Parameters required for account deletion.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

password
required
string

The password for the N0C account, required to confirm deletion.

Responses

Request samples

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

Response samples

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

Suspend account

Initiates the suspension of a World account. Provide a reason for the suspension to ensure proper record-keeping.

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

Parameters required to suspend the account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

reason
required
string

The reason for the account suspension.

Responses

Request samples

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

Response samples

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

Unsuspend account

Reactivates a suspended World hosting account, restoring access to the services associated with the account.

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

Parameters required to unsuspend a suspended account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Enables Temporary URL

Enables a temporary URL for the primary domain of a hosting account, allowing access via a unique URL during development or maintenance.

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

Parameters required to enable the temporary URL.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Disables Temporary URL

Disables the temporary URL for the primary domain of a hosting account, removing the temporary access link.

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

Parameters required to disable the temporary URL.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Emails

Create, manage, and configure email accounts associated with your domains.

List emails

Retrieve a list of all email accounts associated with a specific account.

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

Parameters required to retrieve the email accounts.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Add email

Creates a new email address associated with a specified domain.

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

Parameters required to create the new email account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain under which the email address will be created.

password
required
string

The password for the new email account.

mailUser
required
string

The username for the email address (e.g., 'info' for info@mydomain.com).

quota
integer

The maximum size of the email account's storage in megabytes.

Responses

Request samples

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

Response samples

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

Edit email

Updates the password and/or quota of an existing email account.

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

Parameters for modifying the email account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain associated with the email account.

mailUser
required
string

The username of the email account to be modified.

password
required
string

New password for the email account, if updating.

quota
integer

New email quota in megabytes (MB) for the account.

Responses

Request samples

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

Response samples

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

Remove email

Deletes an email address from the specified domain.

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

Parameters required to delete the email account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain associated with the email account to be deleted.

mailUser
required
string

The username of the email account to be removed.

Responses

Request samples

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

Response samples

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

Suspend emails

Suspend one or more email addresses associated with the account.

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

Parameters required to suspend email addresses.

One of
email
required
string

The email address to suspend.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Unsuspend emails

Reinstate one or more previously suspended email addresses associated with the account.

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

Parameters required to unsuspend email addresses.

One of
email
required
string

The email address to unsuspend.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Authentication status

Retrieve the current email authentication status for the specified domain.

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

Parameters required to check email authentication.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which to check authentication status.

Responses

Request samples

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

Response samples

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

Enable authentication

Activate a specific email authentication method for the given domain.

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

Parameters required to enable email authentication.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which to enable authentication.

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

The authentication method to enable.

Responses

Request samples

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

Response samples

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

Disable authentication

Deactivate a specific email authentication method for the given domain.

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

Parameters required to disable email authentication.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which to disable authentication.

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

The authentication method to deactivate.

Responses

Request samples

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

Response samples

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

Email Forwarders

Set up and manage email forwarders to redirect emails from one address to another.

List email forwarders

Retrieve all configured email forwarders for an account.

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

Parameters required to retrieve the list of email forwarders.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Add a forwarder

Create a new email forwarder for an email address.

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

Parameters for creating an email forwarder.

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

The email address user used to forward messages.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name where the forwarder will be created.

forwardTo
required
Array of strings

The destination email addresses to which emails will be forwarded.

keepCopy
boolean

Indicates whether a copy of the forwarded emails should be retained on the original email account.

Responses

Request samples

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

Response samples

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

Modify a forwarder

Update an existing email forwarder.

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

Parameters for editing an email forwarder.

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

The email address user used for forwarding messages.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

forwarder_id
required
integer

The ID of the forwarder to be edited.

domain
required
string

The domain associated with the forwarder.

forwardTo
required
Array of strings

The destination email addresses where emails should be forwarded.

keepCopy
boolean

Specifies if a copy of forwarded emails will be kept on the original email account.

Responses

Request samples

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

Response samples

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

Remove a forwarder

Delete an existing email forwarder.

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

Parameters for deleting an email forwarder.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

forwarder_id
required
integer

The ID of the forwarder to be deleted.

Responses

Request samples

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

Response samples

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

Domains

Manage domains associated with your hosting account.

List all domains

Retrieve a list of all domains associated with the hosting account.

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

Parameters required to list all domains.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Add a domain/sub-domain

Adds a new domain or sub-domain to your hosting account.

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

Parameters required to add a new domain.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name to add.

subDomain
string

The sub-domain name, if applicable.

docroot
required
string

The document root for the domain.

Responses

Request samples

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

Response samples

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

Change document root

Updates the document root for an existing domain.

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

Parameters required to update the domain document root.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name whose document root needs to be updated.

docroot
required
string

The new document root for the domain.

Responses

Request samples

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

Response samples

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

Remove a domain

Removes the specified domain from the N0C account.

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

Parameters required to remove a domain.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name to remove.

Responses

Request samples

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

Response samples

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

Suspend domain(s)

Suspend one or multiple domains associated with the hosting account.

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

Parameters specifying the domains to be suspended.

One of
domain
required
string

The domain name to suspend.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Unsuspend domain(s)

Unsuspend one or multiple domains associated with the hosting account.

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

Parameters specifying the domains to be unsuspended.

One of
domain
required
string

The domain name to unsuspend.

id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

DNS

Manage DNS records for your domains, such as A, CNAME, and MX records.

Retrieve DNS zone

Retrieve the complete DNS zone for a specified domain.

Note: If you own the domain without a hosting account, you can still manage the DNS zone with the domain only.

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

Parameters required to retrieve the DNS zone.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the DNS zone is being retrieved.

Responses

Request samples

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

Response samples

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

Modify or Add DNS Zone Records

Add or modify records within the DNS zone.

Note: If you own the domain without a hosting account, you can still manage the DNS zone with the domain only.

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

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the DNS zone is being edited.

required
Array of objects

List of DNS records to be added or modified.

Responses

Request samples

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

Response samples

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

Reset DNS zone

Resets the DNS zone to its default values.

Note: If you only own the domain without a hosting account, you can still manage the DNS zone with the domain only.

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

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the DNS zone will be reset.

Responses

Request samples

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

Response samples

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

SSL

Manage SSL certificates to secure your domains with HTTPS.

Retrieve SSL certificate

Fetch the active SSL certificate for a specified domain. This endpoint provides detailed information about the certificate's status, expiration date, issuer, and any errors that may have occurred during the certificate issuance process.

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

Parameters required to retrieve the SSL certificate.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the SSL certificate is requested.

Responses

Request samples

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

Response samples

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

Renew SSL

Initiates the renewal of an SSL certificate for a specified domain using AutoSSL. This process helps ensure the domain maintains a secure connection, protecting user data and preserving trust in the website's security.

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

Parameters required to initiate the SSL renewal process.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the SSL certificate is to be renewed.

Responses

Request samples

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

Response samples

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

Retrieve Custom SSL

Fetch the Custom SSL certificate installed for a specified domain. This endpoint allows you to retrieve both the certificate and its associated private key.

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

Parameters needed to retrieve the SSL certificate.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the SSL certificate is requested.

Responses

Request samples

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

Response samples

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

Install a Custom SSL

This endpoint allows you to install a custom SSL certificate for a specified domain. By providing the necessary certificate and private key, you can secure your domain with HTTPS. Ensure that the certificate is correctly formatted and associated with the domain you intend to secure.

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

Parameters required for the custom SSL installation.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the SSL certificate will be installed.

certificate
required
string

The SSL certificate.

privateKey
required
string

The private key corresponding to the SSL certificate.

Responses

Request samples

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

Response samples

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

Delete a Custom SSL

This endpoint allows you to delete the current custom SSL certificate associated with a specified domain and revert to AutoSSL. This action will remove the custom certificate, enabling the system to automatically manage the SSL for the domain.

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

Parameters required for the deletion of the custom SSL certificate.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the custom SSL certificate will be deleted.

Responses

Request samples

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

Response samples

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

Validate custom SSL

Validates a custom SSL certificate to ensure its integrity and correctness before installation on a specified domain. This process checks whether the certificate is correctly formatted, properly signed, and matches the domain for which it is intended.

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

Parameters required for validating the custom SSL certificate.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The fully qualified domain name (FQDN) for which the SSL certificate was issued.

certificate
required
string

The SSL certificate that needs to be validated.

Responses

Request samples

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

Response samples

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

Retrieve CSR

Retrieve the list of certificate signing requests (CSRs) associated with a specified domain. This endpoint provides detailed information about each CSR, including the creation date, the CSR itself, any self-signed certificates, and the public key fingerprint. It is useful for tracking and managing the CSRs generated for your domain.

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

Parameters required to fetch CSRs.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the CSRs are requested.

Responses

Request samples

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

Response samples

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

Generate a CSR

Generate a new certificate signing request (CSR) for a specified domain. This endpoint allows you to submit the necessary details, such as the domain name, organization information, and contact email, which will be used to create the CSR. The generated CSR can then be submitted to a Certificate Authority (CA) to obtain an SSL certificate.

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

Parameters required for CSR creation.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the CSR is created.

countryCode
required
string

Two-letter country code of the organization's location.

state
required
string

State or province where the organization is located.

localityName
required
string

City where the organization is located.

organizationName
required
string

Full name of the organization.

organizationUnitName
required
string

Department name within the organization.

email
required
string

Contact email address for the CSR.

Responses

Request samples

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

Response samples

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

Remove a CSR

Delete a specific certificate signing request (CSR) for a domain using its public key fingerprint. This endpoint is useful for cleaning up obsolete or incorrect CSRs, ensuring that only relevant requests are retained in the system.

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

Parameters required to delete the CSR.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name associated with the CSR.

csrPubKeyFingerPrint
required
string

Public key fingerprint of the CSR to be deleted.

Responses

Request samples

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

Response samples

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

Retrieve CSR private key

Retrieve the private key associated with a Certificate Signing Request (CSR) for a specific domain. This key is used to validate the CSR and is essential for SSL certificate generation.

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

Parameters required to retrieve the private key for the specified CSR.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the CSR was generated.

csrPubKeyFingerPrint
required
string

The public key fingerprint of the CSR used to identify the request.

Responses

Request samples

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

Response samples

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

Redirections

Configure and manage domain redirections.

List redirections

Retrieves a comprehensive list of domain redirections. This includes details about whether the redirection uses HTTPS, if 'www.' is added, and the destination URL. It provides insight into how domains are configured to redirect traffic, including the type of redirection used (301 or 302) and whether the domain is redirected to another domain.

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

Parameters required for listing redirections.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Add a Redirection

Creates a domain redirection to a specified URL. This can be used to enforce HTTPS or to prepend 'www.' to the domain name, ensuring that all traffic is directed as desired. This operation is essential for managing site traffic and improving security.

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

Parameters required to set up the redirection.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the redirection will be created.

rType
required
integer
Enum: 301 302

The type of redirection, where 301 indicates a permanent redirect and 302 indicates a temporary redirect.

destinationUrl
required
string

The URL to which the domain will be redirected.

Responses

Request samples

Content type
application/json
Example
{}

Response samples

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

Delete a Redirection

Removes an existing redirection for the specified domain. This operation is useful for managing your site's redirection strategy and allows for the removal of outdated or unnecessary redirects.

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

Parameters required to delete the redirection.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

domain
required
string

The domain name for which the redirection will be deleted.

Responses

Request samples

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

Response samples

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

PHP Configuration

Configure PHP settings for your hosting account, including versions and extensions.

List PHP versions

Retrieve a list of all available PHP versions, including the current active version and the default version for the hosting environment.

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

Parameters to list available PHP versions.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Current PHP version

Get the currently active PHP version configured for the hosting environment.

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

Request parameters to retrieve the current PHP version.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Change PHP version

Change the PHP version currently active for the hosting environment to the specified version.

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

Parameters required to update the PHP version for the hosting account.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version to set as active on the account.

Responses

Request samples

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

Response samples

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

List PHP options

Retrieve the available configuration options for a specific PHP version.

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

Parameters required to fetch the configuration options for a specific PHP version.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which to retrieve configuration options.

Responses

Request samples

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

Response samples

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

Modify PHP options

Update configuration options for a specified PHP version.

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

Parameters required to update the configuration options for a specified PHP version.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which to update configuration options.

required
object

Key-value pairs of PHP configuration options to modify.

Responses

Request samples

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

Response samples

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

Reset PHP options

Reset all PHP configuration options to their default values for a specified PHP version.

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

Parameters required to reset the PHP options to their default values.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which the options should be reset.

Responses

Request samples

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

Response samples

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

List PHP extensions

Retrieve the list of available PHP extensions and their statuses for a specific PHP version.

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

Parameters required to retrieve the extensions for the specified PHP version.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which to fetch the list of extensions.

Responses

Request samples

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

Response samples

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

Modify PHP extensions

Enable or disable PHP extensions for a specified PHP version.

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

Parameters required to modify the PHP extensions for the specified PHP version.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which to modify extensions.

required
object

Lists of PHP extensions to enable or disable.

Responses

Request samples

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

Response samples

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

Reset PHP extensions

Reset all PHP extensions to their default values for a specified PHP version.

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

Parameters required to reset the PHP extensions to their default values.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

version
required
string

The PHP version for which the extensions should be reset.

Responses

Request samples

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

Response samples

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

Node.js Applications

Manage Node.js applications, including deployment and environment configurations.

List Node.js Versions

Retrieve a list of all available Node.js versions that can be used on your hosting account. This endpoint provides details on the supported versions, allowing you to choose the appropriate Node.js version for your application.

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

Parameters required to fetch the list of available Node.js versions.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

List Node.js applications

Retrieve a comprehensive list of all Node.js applications on your hosting account. This endpoint returns details such as the app root directory, Node.js version, URI, domain, startup file, status, and the path to the virtual environment activation script.

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

Parameters required to list Node.js applications.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

Responses

Request samples

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

Response samples

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

Add a Node.js application

Create a new Node.js application on your hosting account. This endpoint allows you to define key details such as the application’s root directory, associated domain, startup file, Node.js version, URI path, and application mode (development or production).

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

Parameters required to create a Node.js application.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

appRoot
required
string

The root directory for your Node.js application.

domain
required
string

The domain name for your application.

startUpFile
string

The file that will be used to start your Node.js application.

uri
string

The URI path for your application.

version
required
string

The version of Node.js to use for your application.

appMode
string
Enum: "development" "production"

The mode in which the application will run, either in development or production.

Responses

Request samples

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

Response samples

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

Modify a Node.js application

Update the configuration of an existing Node.js application on your hosting account. This allows you to change the domain, startup file, URI, Node.js version, root directory, or switch between development and production modes.

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

Parameters to modify an existing Node.js application.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

appRoot
required
string

The current root directory of your Node.js application.

newDomain
string

The new domain name for your application.

startUpFile
string

The new startup file to use for your application.

newUri
string

The new URI path for your application.

version
required
string

The new Node.js version to be used for your application.

newAppMode
string
Enum: "development" "production"

The new operational mode of the application.

newAppRoot
string

The new root folder for your application.

Responses

Request samples

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

Response samples

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

Remove a Node.js application

Permanently delete an existing Node.js application from your hosting account. This action removes the application, and its associated configurations.

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

Parameters required to delete a Node.js application.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

appRoot
required
string

The root directory of the Node.js application you want to delete.

Responses

Request samples

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

Response samples

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

Start a Node.js application

Start a Node.js application that is hosted on your account. This endpoint initiates the application using the specified root directory and domain. Upon success, it returns a message confirming that the Node.js application has been successfully started.

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

Parameters required to start the Node.js application.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

appRoot
required
string

The root directory of the Node.js application you want to start.

domain
required
string

The domain name associated with your Node.js application.

Responses

Request samples

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

Response samples

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

Stop a Node.js application

Stop a Node.js application that is hosted on your account. This endpoint initiates the application using the specified root directory and domain. Upon success, it returns a message confirming that the Node.js application has been successfully stopped.

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

Parameters required to stop the Node.js application.

One of
id
required
integer

Hybricloud Server ID, can be found with the /v3/hybridcloud/info.

username
required
string

N0C HybridCloud username, can be found with the /v3/hybridcloud/info.

appRoot
required
string

The root directory of the Node.js application you want to start.

domain
required
string

The domain name associated with your Node.js application.

Responses

Request samples

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