Skip to content

Latest commit

 

History

History
228 lines (197 loc) · 19.8 KB

README.md

File metadata and controls

228 lines (197 loc) · 19.8 KB

Hostinger API Python SDK

PyPI version

About

This is a Python SDK for the Hostinger API.

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

Requirements.

Python 3.8+

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)

    try:
        # Get catalog item list
        api_response = api_instance.get_catalog_item_list_v1()
        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_new_service_order_v1 POST /api/billing/v1/orders Create new 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 get_subscription_list_v1 GET /api/billing/v1/subscriptions Get subscription list
DNSSnapshotApi get_snapshot_list_v1 GET /api/dns/v1/snapshots/{domain} Get snapshot list
DNSSnapshotApi get_snapshot_v1 GET /api/dns/v1/snapshots/{domain}/{snapshotId} Get snapshot
DNSSnapshotApi restore_snapshot_v1 POST /api/dns/v1/snapshots/{domain}/{snapshotId}/restore Restore snapshot
DNSZoneApi delete_zone_records_v1 DELETE /api/dns/v1/zones/{domain} Delete zone records
DNSZoneApi get_records_v1 GET /api/dns/v1/zones/{domain} Get records
DNSZoneApi reset_zone_records_v1 POST /api/dns/v1/zones/{domain}/reset Reset zone records
DNSZoneApi update_zone_records_v1 PUT /api/dns/v1/zones/{domain} Update zone records
DNSZoneApi validate_zone_records_v1 POST /api/dns/v1/zones/{domain}/validate Validate zone records
DomainsAvailabilityApi check_domain_availability_v1 POST /api/domains/v1/availability Check domain availability
DomainsPortfolioApi get_domain_list_v1 GET /api/domains/v1/portfolio Get domain list
VPSActionsApi get_action_list_v1 GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions Get action list
VPSActionsApi get_action_v1 GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId} Get action
VPSBackupsApi delete_backup_v1 DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId} Delete backup
VPSBackupsApi get_backup_list_v1 GET /api/vps/v1/virtual-machines/{virtualMachineId}/backups Get backup list
VPSBackupsApi restore_backup_v1 POST /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore Restore backup
VPSDataCentersApi get_data_centers_list_v1 GET /api/vps/v1/data-centers Get data centers list
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_list_v1 GET /api/vps/v1/firewall Get firewall list
VPSFirewallApi get_firewall_v1 GET /api/vps/v1/firewall/{firewallId} Get firewall
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_list_v1 GET /api/vps/v1/templates Get template list
VPSOSTemplatesApi get_template_v1 GET /api/vps/v1/templates/{templateId} Get template
VPSPTRRecordsApi create_ptr_record_v1 POST /api/vps/v1/virtual-machines/{virtualMachineId}/ptr Create PTR record
VPSPTRRecordsApi delete_ptr_record_v1 DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ptr Delete PTR record
VPSPostInstallScriptsApi create_post_install_script_v1 POST /api/vps/v1/post-install-scripts Create post-install script
VPSPostInstallScriptsApi delete_a_post_install_script_v1 DELETE /api/vps/v1/post-install-scripts/{postInstallScriptId} Delete a post-install script
VPSPostInstallScriptsApi get_post_install_script_list_v1 GET /api/vps/v1/post-install-scripts Get post-install script list
VPSPostInstallScriptsApi get_post_install_script_v1 GET /api/vps/v1/post-install-scripts/{postInstallScriptId} Get post-install script
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_new_public_key_v1 POST /api/vps/v1/public-keys Create new public key
VPSPublicKeysApi delete_a_public_key_v1 DELETE /api/vps/v1/public-keys/{publicKeyId} Delete a public key
VPSPublicKeysApi get_public_key_list_v1 GET /api/vps/v1/public-keys Get public key list
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_list_v1 GET /api/vps/v1/virtual-machines Get virtual machine list
VPSVirtualMachineApi get_virtual_machine_v1 GET /api/vps/v1/virtual-machines/{virtualMachineId} Get 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_new_virtual_machine_v1 POST /api/vps/v1/virtual-machines/{virtualMachineId}/setup Setup new 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