hostinger_api.DomainsPortfolioApi

All URIs are relative to https://developers.hostinger.com

Method	HTTP request	Description
disable_domain_lock_v1	DELETE /api/domains/v1/portfolio/{domain}/domain-lock	Disable domain lock
disable_privacy_protection_v1	DELETE /api/domains/v1/portfolio/{domain}/privacy-protection	Disable privacy protection
enable_domain_lock_v1	PUT /api/domains/v1/portfolio/{domain}/domain-lock	Enable domain lock
enable_privacy_protection_v1	PUT /api/domains/v1/portfolio/{domain}/privacy-protection	Enable privacy protection
get_domain_details_v1	GET /api/domains/v1/portfolio/{domain}	Get domain details
get_domain_list_v1	GET /api/domains/v1/portfolio	Get domain list
purchase_new_domain_v1	POST /api/domains/v1/portfolio	Purchase new domain
update_domain_nameservers_v1	PUT /api/domains/v1/portfolio/{domain}/nameservers	Update domain nameservers

disable_domain_lock_v1

CommonSuccessEmptyResource disable_domain_lock_v1(domain)

Disable domain lock

Disable domain lock for the domain.

Domain lock needs to be disabled before transferring the domain to another registrar.

Use this endpoint to prepare domains for transfer to other registrars.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Disable domain lock
        api_response = api_instance.disable_domain_lock_v1(domain)
        print("The response of DomainsPortfolioApi->disable_domain_lock_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->disable_domain_lock_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success empty response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_privacy_protection_v1

CommonSuccessEmptyResource disable_privacy_protection_v1(domain)

Disable privacy protection

Disable privacy protection for the domain.

When privacy protection is disabled, domain owner's personal information is visible in public WHOIS database.

Use this endpoint to make domain owner's information publicly visible.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Disable privacy protection
        api_response = api_instance.disable_privacy_protection_v1(domain)
        print("The response of DomainsPortfolioApi->disable_privacy_protection_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->disable_privacy_protection_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success empty response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_domain_lock_v1

CommonSuccessEmptyResource enable_domain_lock_v1(domain)

Enable domain lock

Enable domain lock for the domain.

When domain lock is enabled, the domain cannot be transferred to another registrar without first disabling the lock.

Use this endpoint to secure domains against unauthorized transfers.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Enable domain lock
        api_response = api_instance.enable_domain_lock_v1(domain)
        print("The response of DomainsPortfolioApi->enable_domain_lock_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->enable_domain_lock_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success empty response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enable_privacy_protection_v1

CommonSuccessEmptyResource enable_privacy_protection_v1(domain)

Enable privacy protection

Enable privacy protection for the domain.

When privacy protection is enabled, domain owner's personal information is hidden from public WHOIS database.

Use this endpoint to protect domain owner's personal information from public view.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Enable privacy protection
        api_response = api_instance.enable_privacy_protection_v1(domain)
        print("The response of DomainsPortfolioApi->enable_privacy_protection_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->enable_privacy_protection_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success empty response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_domain_details_v1

DomainsV1DomainDomainExtendedResource get_domain_details_v1(domain)

Get domain details

Retrieve detailed information for specified domain.

Use this endpoint to view comprehensive domain configuration and status.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.domains_v1_domain_domain_extended_resource import DomainsV1DomainDomainExtendedResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name

    try:
        # Get domain details
        api_response = api_instance.get_domain_details_v1(domain)
        print("The response of DomainsPortfolioApi->get_domain_details_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->get_domain_details_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name

Return type

DomainsV1DomainDomainExtendedResource

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_domain_list_v1

List[DomainsV1DomainDomainResource] get_domain_list_v1()

Get domain list

Retrieve all domains associated with your account.

Use this endpoint to view user's domain portfolio.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.domains_v1_domain_domain_resource import DomainsV1DomainDomainResource
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)

    try:
        # Get domain list
        api_response = api_instance.get_domain_list_v1()
        print("The response of DomainsPortfolioApi->get_domain_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->get_domain_list_v1: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[DomainsV1DomainDomainResource]

Authorization

apiToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchase_new_domain_v1

BillingV1OrderOrderResource purchase_new_domain_v1(domains_v1_portfolio_purchase_request)

Purchase new domain

Purchase and register a new domain name.

If registration fails, login to hPanel and check domain registration status.

If no payment method is provided, your default payment method will be used automatically.

If no WHOIS information is provided, default contact information for that TLD will be used. Before making request, ensure WHOIS information for desired TLD exists in your account.

Some TLDs require additional_details to be provided and these will be validated before completing purchase.

Use this endpoint to register new domains for users.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.billing_v1_order_order_resource import BillingV1OrderOrderResource
from hostinger_api.models.domains_v1_portfolio_purchase_request import DomainsV1PortfolioPurchaseRequest
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domains_v1_portfolio_purchase_request = hostinger_api.DomainsV1PortfolioPurchaseRequest() # DomainsV1PortfolioPurchaseRequest | 

    try:
        # Purchase new domain
        api_response = api_instance.purchase_new_domain_v1(domains_v1_portfolio_purchase_request)
        print("The response of DomainsPortfolioApi->purchase_new_domain_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->purchase_new_domain_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domains_v1_portfolio_purchase_request	DomainsV1PortfolioPurchaseRequest

Return type

BillingV1OrderOrderResource

Authorization

apiToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success response	-
422	Validation error response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_domain_nameservers_v1

CommonSuccessEmptyResource update_domain_nameservers_v1(domain, domains_v1_portfolio_update_nameservers_request)

Update domain nameservers

Set nameservers for a specified domain.

Be aware, that improper nameserver configuration can lead to the domain being unresolvable or unavailable.

Use this endpoint to configure custom DNS hosting for domains.

Example

Bearer Authentication (apiToken):

import hostinger_api
from hostinger_api.models.common_success_empty_resource import CommonSuccessEmptyResource
from hostinger_api.models.domains_v1_portfolio_update_nameservers_request import DomainsV1PortfolioUpdateNameserversRequest
from hostinger_api.rest import ApiException
from pprint import pprint


# Configure Bearer authorization: apiToken
configuration = hostinger_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hostinger_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hostinger_api.DomainsPortfolioApi(api_client)
    domain = 'mydomain.tld' # str | Domain name
    domains_v1_portfolio_update_nameservers_request = hostinger_api.DomainsV1PortfolioUpdateNameserversRequest() # DomainsV1PortfolioUpdateNameserversRequest | 

    try:
        # Update domain nameservers
        api_response = api_instance.update_domain_nameservers_v1(domain, domains_v1_portfolio_update_nameservers_request)
        print("The response of DomainsPortfolioApi->update_domain_nameservers_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DomainsPortfolioApi->update_domain_nameservers_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
domain	str	Domain name
domains_v1_portfolio_update_nameservers_request	DomainsV1PortfolioUpdateNameserversRequest

Return type

CommonSuccessEmptyResource

Authorization

apiToken

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success empty response	-
422	Validation error response	-
401	Unauthenticated response	-
500	Error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DomainsPortfolioApi.md

Latest commit

History

DomainsPortfolioApi.md

File metadata and controls

hostinger_api.DomainsPortfolioApi

disable_domain_lock_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

disable_privacy_protection_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_domain_lock_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

enable_privacy_protection_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_domain_details_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_domain_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

purchase_new_domain_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_domain_nameservers_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details