Hostinger API PHP SDK

About

This is a PHP SDK for the Hostinger API. For more information, please visit https://developers.hostinger.com.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the package via Composer, run the following command:

composer require hostinger/api-php-sdk

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\BillingCatalogApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    client: new GuzzleHttp\Client(),
    config: $config
);
$category = VPS; // string | Filter catalog items by category
$name = .COM*; // string | Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain

try {
    $result = $apiInstance->getCatalogItemListV1($category, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BillingCatalogApi->getCatalogItemListV1: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
BillingCatalogApi	getCatalogItemListV1	GET /api/billing/v1/catalog	Get catalog item list
BillingOrdersApi	createServiceOrderV1	POST /api/billing/v1/orders	Create service order
BillingPaymentMethodsApi	deletePaymentMethodV1	DELETE /api/billing/v1/payment-methods/{paymentMethodId}	Delete payment method
BillingPaymentMethodsApi	getPaymentMethodListV1	GET /api/billing/v1/payment-methods	Get payment method list
BillingPaymentMethodsApi	setDefaultPaymentMethodV1	POST /api/billing/v1/payment-methods/{paymentMethodId}	Set default payment method
BillingSubscriptionsApi	cancelSubscriptionV1	DELETE /api/billing/v1/subscriptions/{subscriptionId}	Cancel subscription
BillingSubscriptionsApi	disableAutoRenewalV1	DELETE /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable	Disable auto-renewal
BillingSubscriptionsApi	enableAutoRenewalV1	PATCH /api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable	Enable auto-renewal
BillingSubscriptionsApi	getSubscriptionListV1	GET /api/billing/v1/subscriptions	Get subscription list
DNSSnapshotApi	getDNSSnapshotListV1	GET /api/dns/v1/snapshots/{domain}	Get DNS snapshot list
DNSSnapshotApi	getDNSSnapshotV1	GET /api/dns/v1/snapshots/{domain}/{snapshotId}	Get DNS snapshot
DNSSnapshotApi	restoreDNSSnapshotV1	POST /api/dns/v1/snapshots/{domain}/{snapshotId}/restore	Restore DNS snapshot
DNSZoneApi	deleteDNSRecordsV1	DELETE /api/dns/v1/zones/{domain}	Delete DNS records
DNSZoneApi	getDNSRecordsV1	GET /api/dns/v1/zones/{domain}	Get DNS records
DNSZoneApi	resetDNSRecordsV1	POST /api/dns/v1/zones/{domain}/reset	Reset DNS records
DNSZoneApi	updateDNSRecordsV1	PUT /api/dns/v1/zones/{domain}	Update DNS records
DNSZoneApi	validateDNSRecordsV1	POST /api/dns/v1/zones/{domain}/validate	Validate DNS records
DomainsAvailabilityApi	checkDomainAvailabilityV1	POST /api/domains/v1/availability	Check domain availability
DomainsForwardingApi	createDomainForwardingV1	POST /api/domains/v1/forwarding	Create domain forwarding
DomainsForwardingApi	deleteDomainForwardingV1	DELETE /api/domains/v1/forwarding/{domain}	Delete domain forwarding
DomainsForwardingApi	getDomainForwardingV1	GET /api/domains/v1/forwarding/{domain}	Get domain forwarding
DomainsPortfolioApi	disableDomainLockV1	DELETE /api/domains/v1/portfolio/{domain}/domain-lock	Disable domain lock
DomainsPortfolioApi	disablePrivacyProtectionV1	DELETE /api/domains/v1/portfolio/{domain}/privacy-protection	Disable privacy protection
DomainsPortfolioApi	enableDomainLockV1	PUT /api/domains/v1/portfolio/{domain}/domain-lock	Enable domain lock
DomainsPortfolioApi	enablePrivacyProtectionV1	PUT /api/domains/v1/portfolio/{domain}/privacy-protection	Enable privacy protection
DomainsPortfolioApi	getDomainDetailsV1	GET /api/domains/v1/portfolio/{domain}	Get domain details
DomainsPortfolioApi	getDomainListV1	GET /api/domains/v1/portfolio	Get domain list
DomainsPortfolioApi	purchaseNewDomainV1	POST /api/domains/v1/portfolio	Purchase new domain
DomainsPortfolioApi	updateDomainNameserversV1	PUT /api/domains/v1/portfolio/{domain}/nameservers	Update domain nameservers
DomainsWHOISApi	createWHOISProfileV1	POST /api/domains/v1/whois	Create WHOIS profile
DomainsWHOISApi	deleteWHOISProfileV1	DELETE /api/domains/v1/whois/{whoisId}	Delete WHOIS profile
DomainsWHOISApi	getWHOISProfileListV1	GET /api/domains/v1/whois	Get WHOIS profile list
DomainsWHOISApi	getWHOISProfileUsageV1	GET /api/domains/v1/whois/{whoisId}/usage	Get WHOIS profile usage
DomainsWHOISApi	getWHOISProfileV1	GET /api/domains/v1/whois/{whoisId}	Get WHOIS profile
ReachContactsApi	createANewContactV1	POST /api/reach/v1/contacts	Create a new contact
ReachContactsApi	deleteAContactV1	DELETE /api/reach/v1/contacts/{uuid}	Delete a contact
ReachContactsApi	listContactGroupsV1	GET /api/reach/v1/contacts/groups	List contact groups
ReachContactsApi	listContactsV1	GET /api/reach/v1/contacts	List contacts
VPSActionsApi	getActionDetailsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions/{actionId}	Get action details
VPSActionsApi	getActionsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/actions	Get actions
VPSBackupsApi	getBackupsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/backups	Get backups
VPSBackupsApi	restoreBackupV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/backups/{backupId}/restore	Restore backup
VPSDataCentersApi	getDataCenterListV1	GET /api/vps/v1/data-centers	Get data center list
VPSDockerManagerApi	createNewProjectV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker	Create new project
VPSDockerManagerApi	deleteProjectV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/down	Delete project
VPSDockerManagerApi	getProjectContainersV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/containers	Get project containers
VPSDockerManagerApi	getProjectContentsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}	Get project contents
VPSDockerManagerApi	getProjectListV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker	Get project list
VPSDockerManagerApi	getProjectLogsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/logs	Get project logs
VPSDockerManagerApi	restartProjectV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/restart	Restart project
VPSDockerManagerApi	startProjectV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/start	Start project
VPSDockerManagerApi	stopProjectV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/stop	Stop project
VPSDockerManagerApi	updateProjectV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/docker/{projectName}/update	Update project
VPSFirewallApi	activateFirewallV1	POST /api/vps/v1/firewall/{firewallId}/activate/{virtualMachineId}	Activate firewall
VPSFirewallApi	createFirewallRuleV1	POST /api/vps/v1/firewall/{firewallId}/rules	Create firewall rule
VPSFirewallApi	createNewFirewallV1	POST /api/vps/v1/firewall	Create new firewall
VPSFirewallApi	deactivateFirewallV1	POST /api/vps/v1/firewall/{firewallId}/deactivate/{virtualMachineId}	Deactivate firewall
VPSFirewallApi	deleteFirewallRuleV1	DELETE /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Delete firewall rule
VPSFirewallApi	deleteFirewallV1	DELETE /api/vps/v1/firewall/{firewallId}	Delete firewall
VPSFirewallApi	getFirewallDetailsV1	GET /api/vps/v1/firewall/{firewallId}	Get firewall details
VPSFirewallApi	getFirewallListV1	GET /api/vps/v1/firewall	Get firewall list
VPSFirewallApi	syncFirewallV1	POST /api/vps/v1/firewall/{firewallId}/sync/{virtualMachineId}	Sync firewall
VPSFirewallApi	updateFirewallRuleV1	PUT /api/vps/v1/firewall/{firewallId}/rules/{ruleId}	Update firewall rule
VPSMalwareScannerApi	getScanMetricsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Get scan metrics
VPSMalwareScannerApi	installMonarxV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Install Monarx
VPSMalwareScannerApi	uninstallMonarxV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/monarx	Uninstall Monarx
VPSOSTemplatesApi	getTemplateDetailsV1	GET /api/vps/v1/templates/{templateId}	Get template details
VPSOSTemplatesApi	getTemplatesV1	GET /api/vps/v1/templates	Get templates
VPSPTRRecordsApi	createPTRRecordV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}	Create PTR record
VPSPTRRecordsApi	deletePTRRecordV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/ptr/{ipAddressId}	Delete PTR record
VPSPostInstallScriptsApi	createPostInstallScriptV1	POST /api/vps/v1/post-install-scripts	Create post-install script
VPSPostInstallScriptsApi	deletePostInstallScriptV1	DELETE /api/vps/v1/post-install-scripts/{postInstallScriptId}	Delete post-install script
VPSPostInstallScriptsApi	getPostInstallScriptV1	GET /api/vps/v1/post-install-scripts/{postInstallScriptId}	Get post-install script
VPSPostInstallScriptsApi	getPostInstallScriptsV1	GET /api/vps/v1/post-install-scripts	Get post-install scripts
VPSPostInstallScriptsApi	updatePostInstallScriptV1	PUT /api/vps/v1/post-install-scripts/{postInstallScriptId}	Update post-install script
VPSPublicKeysApi	attachPublicKeyV1	POST /api/vps/v1/public-keys/attach/{virtualMachineId}	Attach public key
VPSPublicKeysApi	createPublicKeyV1	POST /api/vps/v1/public-keys	Create public key
VPSPublicKeysApi	deletePublicKeyV1	DELETE /api/vps/v1/public-keys/{publicKeyId}	Delete public key
VPSPublicKeysApi	getPublicKeysV1	GET /api/vps/v1/public-keys	Get public keys
VPSRecoveryApi	startRecoveryModeV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/recovery	Start recovery mode
VPSRecoveryApi	stopRecoveryModeV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/recovery	Stop recovery mode
VPSSnapshotsApi	createSnapshotV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Create snapshot
VPSSnapshotsApi	deleteSnapshotV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Delete snapshot
VPSSnapshotsApi	getSnapshotV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot	Get snapshot
VPSSnapshotsApi	restoreSnapshotV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/snapshot/restore	Restore snapshot
VPSVirtualMachineApi	getAttachedPublicKeysV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/public-keys	Get attached public keys
VPSVirtualMachineApi	getMetricsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}/metrics	Get metrics
VPSVirtualMachineApi	getVirtualMachineDetailsV1	GET /api/vps/v1/virtual-machines/{virtualMachineId}	Get virtual machine details
VPSVirtualMachineApi	getVirtualMachinesV1	GET /api/vps/v1/virtual-machines	Get virtual machines
VPSVirtualMachineApi	purchaseNewVirtualMachineV1	POST /api/vps/v1/virtual-machines	Purchase new virtual machine
VPSVirtualMachineApi	recreateVirtualMachineV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/recreate	Recreate virtual machine
VPSVirtualMachineApi	resetHostnameV1	DELETE /api/vps/v1/virtual-machines/{virtualMachineId}/hostname	Reset hostname
VPSVirtualMachineApi	restartVirtualMachineV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/restart	Restart virtual machine
VPSVirtualMachineApi	setHostnameV1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/hostname	Set hostname
VPSVirtualMachineApi	setNameserversV1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/nameservers	Set nameservers
VPSVirtualMachineApi	setPanelPasswordV1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/panel-password	Set panel password
VPSVirtualMachineApi	setRootPasswordV1	PUT /api/vps/v1/virtual-machines/{virtualMachineId}/root-password	Set root password
VPSVirtualMachineApi	setupPurchasedVirtualMachineV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/setup	Setup purchased virtual machine
VPSVirtualMachineApi	startVirtualMachineV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/start	Start virtual machine
VPSVirtualMachineApi	stopVirtualMachineV1	POST /api/vps/v1/virtual-machines/{virtualMachineId}/stop	Stop virtual machine

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
• VPSV1ActionActionResource
• VPSV1ActionListResponse
• VPSV1BackupBackupResource
• VPSV1BackupListResponse
• VPSV1DataCenterDataCenterResource
• VPSV1DockerManagerContainerPortResource
• VPSV1DockerManagerContainerResource
• VPSV1DockerManagerContainerStatsResource
• VPSV1DockerManagerContentResource
• VPSV1DockerManagerLogEntryResource
• VPSV1DockerManagerLogsResource
• VPSV1DockerManagerProjectResource
• VPSV1FirewallFirewallResource
• VPSV1FirewallFirewallRuleResource
• VPSV1FirewallListResponse
• VPSV1FirewallRulesStoreRequest
• VPSV1FirewallStoreRequest
• VPSV1IPAddressIPAddressResource
• VPSV1MalwareMetricsResource
• VPSV1MetricsMetricsCollection
• VPSV1MetricsMetricsResource
• VPSV1PostInstallScriptListResponse
• VPSV1PostInstallScriptPostInstallScriptResource
• VPSV1PostInstallScriptStoreRequest
• VPSV1PublicKeyAttachRequest
• VPSV1PublicKeyListResponse
• VPSV1PublicKeyPublicKeyResource
• VPSV1PublicKeyStoreRequest
• VPSV1SnapshotSnapshotResource
• VPSV1TemplateTemplateResource
• VPSV1VirtualMachineDockerManagerUpRequest
• VPSV1VirtualMachineHostnameUpdateRequest
• VPSV1VirtualMachineMetricGetRequest
• VPSV1VirtualMachineNameserversUpdateRequest
• VPSV1VirtualMachinePTRStoreRequest
• VPSV1VirtualMachinePanelPasswordUpdateRequest
• VPSV1VirtualMachinePurchaseRequest
• VPSV1VirtualMachineRecoveryStartRequest
• VPSV1VirtualMachineRecreateRequest
• VPSV1VirtualMachineRootPasswordUpdateRequest
• VPSV1VirtualMachineSetupRequest
• VPSV1VirtualMachineSetupRequestPublicKey
• VPSV1VirtualMachineVirtualMachineResource