hostinger-api 0.0.19

Hostinger API

Hostinger API Python SDK

About

This is a Python SDK for the Hostinger API.

For more information, please visit https://developers.hostinger.com.

Requirements.

Python 3.9+

Installation & Usage

pip install

Setup new virtual environment (optional but recommended):

python3 -m venv venv
source venv/bin/activate

Install the package via pip:

pip install hostinger_api

Then import the package:

import hostinger_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import hostinger_api

Getting Started

Please follow the installation procedure and then run the following:

import hostinger_api
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.BillingCatalogApi(api_client)
    category = 'VPS' # str | Filter catalog items by category (optional)
    name = '.COM*' # str | Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain (optional)

    try:
        # Get catalog item list
        api_response = api_instance.get_catalog_item_list_v1(category=category, name=name)
        print("The response of BillingCatalogApi->get_catalog_item_list_v1:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingCatalogApi->get_catalog_item_list_v1: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
BillingCatalogApi	get_catalog_item_list_v1	GET /api/billing/v1/catalog	Get catalog item list
BillingOrdersApi	create_service_order_v1	POST /api/billing/v1/orders	Create service order
BillingPaymentMethodsApi	delete_payment_method_v1	DELETE /api/billing/v1/payment-methods/{paymentMethodId}	Delete payment method
BillingPaymentMethodsApi	get_payment_method_list_v1	GET /api/billing/v1/payment-methods	Get payment method list
BillingPaymentMethodsApi	set_default_payment_method_v1	POST /api/billing/v1/payment-methods/{paymentMethodId}	Set default payment method
BillingSubscriptionsApi	cancel_subscription_v1	DELETE /api/billing/v1/subscriptions/{subscriptionId}	Cancel subscription
BillingSubscriptionsApi	disable_auto_renewal_v1	DELETE /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable	Disable auto-renewal
BillingSubscriptionsApi	enable_auto_renewal_v1	PATCH /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable	Enable auto-renewal
BillingSubscriptionsApi	get_subscription_list_v1	GET /api/billing/v1/subscriptions	Get subscription list
DNSSnapshotApi	get_dns_snapshot_list_v1	GET /api/dns/v1/snapshots/{domain}	Get DNS snapshot list
DNSSnapshotApi	get_dns_snapshot_v1	GET /api/dns/v1/snapshots/{domain}/{snapshotId}	Get DNS snapshot
DNSSnapshotApi	restore_dns_snapshot_v1	POST /api/dns/v1/snapshots/{domain}/{snapshotId}/restore	Restore DNS snapshot
DNSZoneApi	delete_dns_records_v1	DELETE /api/dns/v1/zones/{domain}	Delete DNS records
DNSZoneApi	get_dns_records_v1	GET /api/dns/v1/zones/{domain}	Get DNS records
DNSZoneApi	reset_dns_records_v1	POST /api/dns/v1/zones/{domain}/reset	Reset DNS records
DNSZoneApi	update_dns_records_v1	PUT /api/dns/v1/zones/{domain}	Update DNS records
DNSZoneApi	validate_dns_records_v1	POST /api/dns/v1/zones/{domain}/validate	Validate DNS records
DomainsAvailabilityApi	check_domain_availability_v1	POST /api/domains/v1/availability	Check domain availability
DomainsForwardingApi	create_domain_forwarding_v1	POST /api/domains/v1/forwarding	Create domain forwarding
DomainsForwardingApi	delete_domain_forwarding_v1	DELETE /api/domains/v1/forwarding/{domain}	Delete domain forwarding
DomainsForwardingApi	get_domain_forwarding_v1	GET /api/domains/v1/forwarding/{domain}	Get domain forwarding
DomainsPortfolioApi	disable_domain_lock_v1	DELETE /api/domains/v1/portfolio/{domain}/domain-lock	Disable domain lock
DomainsPortfolioApi	disable_privacy_protection_v1	DELETE /api/domains/v1/portfolio/{domain}/privacy-protection	Disable privacy protection
DomainsPortfolioApi	enable_domain_lock_v1	PUT /api/domains/v1/portfolio/{domain}/domain-lock	Enable domain lock
DomainsPortfolioApi	enable_privacy_protection_v1	PUT /api/domains/v1/portfolio/{domain}/privacy-protection	Enable privacy protection
DomainsPortfolioApi	get_domain_details_v1	GET /api/domains/v1/portfolio/{domain}	Get domain details
DomainsPortfolioApi	get_domain_list_v1	GET /api/domains/v1/portfolio	Get domain list
DomainsPortfolioApi	purchase_new_domain_v1	POST /api/domains/v1/portfolio	Purchase new domain
DomainsPortfolioApi	update_domain_nameservers_v1	PUT /api/domains/v1/portfolio/{domain}/nameservers	Update domain nameservers
DomainsWHOISApi	create_whois_profile_v1	POST /api/domains/v1/whois	Create WHOIS profile
DomainsWHOISApi	delete_whois_profile_v1	DELETE /api/domains/v1/whois/{whoisId}	Delete WHOIS profile
DomainsWHOISApi	get_whois_profile_list_v1	GET /api/domains/v1/whois	Get WHOIS profile list
DomainsWHOISApi	get_whois_profile_usage_v1	GET /api/domains/v1/whois/{whoisId}/usage	Get WHOIS profile usage
DomainsWHOISApi	get_whois_profile_v1	GET /api/domains/v1/whois/{whoisId}	Get WHOIS profile
ReachContactsApi	create_a_new_contact_v1	POST /api/reach/v1/contacts	Create a new contact
ReachContactsApi	delete_a_contact_v1	DELETE /api/reach/v1/contacts/{uuid}	Delete a contact
ReachContactsApi	list_contact_groups_v1	GET /api/reach/v1/contacts/groups	List contact groups
ReachContactsApi	list_contacts_v1	GET /api/reach/v1/contacts	List contacts
VPSActionsApi	get_action_details_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}	Get action details
VPSActionsApi	get_actions_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions	Get actions
VPSBackupsApi	get_backups_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/backups	Get backups
VPSBackupsApi	restore_backup_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore	Restore backup
VPSDataCentersApi	get_data_center_list_v1	GET /api/vps/v1/data-centers	Get data center list
VPSDockerManagerApi	create_new_project_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker	Create new project
VPSDockerManagerApi	delete_project_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down	Delete project
VPSDockerManagerApi	get_project_containers_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers	Get project containers
VPSDockerManagerApi	get_project_contents_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}	Get project contents
VPSDockerManagerApi	get_project_list_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker	Get project list
VPSDockerManagerApi	get_project_logs_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs	Get project logs
VPSDockerManagerApi	restart_project_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart	Restart project
VPSDockerManagerApi	start_project_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start	Start project
VPSDockerManagerApi	stop_project_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop	Stop project
VPSDockerManagerApi	update_project_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update	Update project
VPSFirewallApi	activate_firewall_v1	POST /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}	Activate firewall
VPSFirewallApi	create_firewall_rule_v1	POST /api/vps/v1/firewall/{firewallId}/rules	Create firewall rule
VPSFirewallApi	create_new_firewall_v1	POST /api/vps/v1/firewall	Create new firewall
VPSFirewallApi	deactivate_firewall_v1	POST /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}	Deactivate firewall
VPSFirewallApi	delete_firewall_rule_v1	DELETE /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Delete firewall rule
VPSFirewallApi	delete_firewall_v1	DELETE /api/vps/v1/firewall/{firewallId}	Delete firewall
VPSFirewallApi	get_firewall_details_v1	GET /api/vps/v1/firewall/{firewallId}	Get firewall details
VPSFirewallApi	get_firewall_list_v1	GET /api/vps/v1/firewall	Get firewall list
VPSFirewallApi	sync_firewall_v1	POST /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}	Sync firewall
VPSFirewallApi	update_firewall_rule_v1	PUT /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Update firewall rule
VPSMalwareScannerApi	get_scan_metrics_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Get scan metrics
VPSMalwareScannerApi	install_monarx_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Install Monarx
VPSMalwareScannerApi	uninstall_monarx_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Uninstall Monarx
VPSOSTemplatesApi	get_template_details_v1	GET /api/vps/v1/templates/{templateId}	Get template details
VPSOSTemplatesApi	get_templates_v1	GET /api/vps/v1/templates	Get templates
VPSPTRRecordsApi	create_ptr_record_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}	Create PTR record
VPSPTRRecordsApi	delete_ptr_record_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}	Delete PTR record
VPSPostInstallScriptsApi	create_post_install_script_v1	POST /api/vps/v1/post-install-scripts	Create post-install script
VPSPostInstallScriptsApi	delete_post_install_script_v1	DELETE /api/vps/v1/post-install-scripts/{postInstallScriptId}	Delete post-install script
VPSPostInstallScriptsApi	get_post_install_script_v1	GET /api/vps/v1/post-install-scripts/{postInstallScriptId}	Get post-install script
VPSPostInstallScriptsApi	get_post_install_scripts_v1	GET /api/vps/v1/post-install-scripts	Get post-install scripts
VPSPostInstallScriptsApi	update_post_install_script_v1	PUT /api/vps/v1/post-install-scripts/{postInstallScriptId}	Update post-install script
VPSPublicKeysApi	attach_public_key_v1	POST /api/vps/v1/public-keys/attach/{virtualMachineId}	Attach public key
VPSPublicKeysApi	create_public_key_v1	POST /api/vps/v1/public-keys	Create public key
VPSPublicKeysApi	delete_public_key_v1	DELETE /api/vps/v1/public-keys/{publicKeyId}	Delete public key
VPSPublicKeysApi	get_public_keys_v1	GET /api/vps/v1/public-keys	Get public keys
VPSRecoveryApi	start_recovery_mode_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/recovery	Start recovery mode
VPSRecoveryApi	stop_recovery_mode_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/recovery	Stop recovery mode
VPSSnapshotsApi	create_snapshot_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Create snapshot
VPSSnapshotsApi	delete_snapshot_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Delete snapshot
VPSSnapshotsApi	get_snapshot_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Get snapshot
VPSSnapshotsApi	restore_snapshot_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore	Restore snapshot
VPSVirtualMachineApi	get_attached_public_keys_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys	Get attached public keys
VPSVirtualMachineApi	get_metrics_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/metrics	Get metrics
VPSVirtualMachineApi	get_virtual_machine_details_v1	GET /api/vps/v1/virtual-machines/{virtualMachineId}	Get virtual machine details
VPSVirtualMachineApi	get_virtual_machines_v1	GET /api/vps/v1/virtual-machines	Get virtual machines
VPSVirtualMachineApi	purchase_new_virtual_machine_v1	POST /api/vps/v1/virtual-machines	Purchase new virtual machine
VPSVirtualMachineApi	recreate_virtual_machine_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/recreate	Recreate virtual machine
VPSVirtualMachineApi	reset_hostname_v1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/hostname	Reset hostname
VPSVirtualMachineApi	restart_virtual_machine_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/restart	Restart virtual machine
VPSVirtualMachineApi	set_hostname_v1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/hostname	Set hostname
VPSVirtualMachineApi	set_nameservers_v1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers	Set nameservers
VPSVirtualMachineApi	set_panel_password_v1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password	Set panel password
VPSVirtualMachineApi	set_root_password_v1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/root-password	Set root password
VPSVirtualMachineApi	setup_purchased_virtual_machine_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/setup	Setup purchased virtual machine
VPSVirtualMachineApi	start_virtual_machine_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/start	Start virtual machine
VPSVirtualMachineApi	stop_virtual_machine_v1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/stop	Stop virtual machine

Documentation For Models

• BillingV1CatalogCatalogItemPriceResource
• BillingV1CatalogCatalogItemResource
• BillingV1OrderOrderBillingAddressResource
• BillingV1OrderOrderResource
• BillingV1OrderStoreRequest
• BillingV1OrderStoreRequestItemsInner
• BillingV1OrderVirtualMachineOrderResource
• BillingV1PaymentMethodPaymentMethodResource
• BillingV1SubscriptionCancelRequest
• BillingV1SubscriptionSubscriptionResource
• CommonSchemaPaginationMetaSchema
• CommonSuccessEmptyResource
• DNSV1SnapshotSnapshotResource
• DNSV1SnapshotSnapshotWithContentResource
• DNSV1ZoneDestroyRequest
• DNSV1ZoneDestroyRequestFiltersInner
• DNSV1ZoneNameRecordResource
• DNSV1ZoneRecordResource
• DNSV1ZoneResetRequest
• DNSV1ZoneUpdateRequest
• DNSV1ZoneUpdateRequestZoneInner
• DNSV1ZoneUpdateRequestZoneInnerRecordsInner
• DomainsV1AvailabilityAvailabilityRequest
• DomainsV1AvailabilityAvailabilityResource
• DomainsV1DomainDomainExtendedResource
• DomainsV1DomainDomainExtendedResourceDomainContacts
• DomainsV1DomainDomainExtendedResourceNameServers
• DomainsV1DomainDomainResource
• DomainsV1ForwardingForwardingResource
• DomainsV1ForwardingStoreRequest
• DomainsV1PortfolioPurchaseRequest
• DomainsV1PortfolioPurchaseRequestDomainContacts
• DomainsV1PortfolioUpdateNameserversRequest
• DomainsV1WHOISProfileResource
• DomainsV1WHOISStoreRequest
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject2Errors
• ReachListContactsV1200Response
• ReachV1ContactsContactResource
• ReachV1ContactsGroupsContactGroupResource
• ReachV1ContactsStoreRequest
• VPSGetActionsV1200Response
• VPSGetBackupsV1200Response
• VPSGetFirewallListV1200Response
• VPSGetPostInstallScriptsV1200Response
• VPSGetPublicKeysV1200Response
• VPSV1ActionActionResource
• VPSV1BackupBackupResource
• VPSV1DataCenterDataCenterResource
• VPSV1DockerManagerContainerPortResource
• VPSV1DockerManagerContainerResource
• VPSV1DockerManagerContainerStatsResource
• VPSV1DockerManagerContentResource
• VPSV1DockerManagerLogEntryResource
• VPSV1DockerManagerLogsResource
• VPSV1DockerManagerProjectResource
• VPSV1FirewallFirewallResource
• VPSV1FirewallFirewallRuleResource
• VPSV1FirewallRulesStoreRequest
• VPSV1FirewallStoreRequest
• VPSV1IPAddressIPAddressResource
• VPSV1MalwareMetricsResource
• VPSV1MetricsMetricsCollection
• VPSV1MetricsMetricsResource
• VPSV1PostInstallScriptPostInstallScriptResource
• VPSV1PostInstallScriptStoreRequest
• VPSV1PublicKeyAttachRequest
• VPSV1PublicKeyPublicKeyResource
• VPSV1PublicKeyStoreRequest
• VPSV1SnapshotSnapshotResource
• VPSV1TemplateTemplateResource
• VPSV1VirtualMachineDockerManagerUpRequest
• VPSV1VirtualMachineHostnameUpdateRequest
• VPSV1VirtualMachineMetricGetRequest
• VPSV1VirtualMachineNameserversUpdateRequest
• VPSV1VirtualMachinePTRStoreRequest
• VPSV1VirtualMachinePanelPasswordUpdateRequest
• VPSV1VirtualMachinePurchaseRequest
• VPSV1VirtualMachineRecoveryStartRequest
• VPSV1VirtualMachineRecreateRequest
• VPSV1VirtualMachineRootPasswordUpdateRequest
• VPSV1VirtualMachineSetupRequest
• VPSV1VirtualMachineSetupRequestPublicKey
• VPSV1VirtualMachineVirtualMachineResource