pidginhost/sdk-php

The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script

0.8.0 2026-05-17 16:13 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

MIT

• PidginHost

• php
• rest
• api
• sdk
• openapi
• openapitools
• openapi-generator

README

The Pidgin Host API allows you to manage Services and resources within the Pidgin Host cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the Pidgin Host control panel is also available through the API, allowing you to script the complex actions that your situation requires.

For more information, please visit https://www.pidginhost.com.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/pidginhost/sdk-php.git"
    }
  ],
  "require": {
    "pidginhost/sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: cookieAuth
$config = PidginHost\Sdk\Configuration::getDefaultConfiguration()->setApiKey('sessionid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = PidginHost\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sessionid', 'Bearer');

// Configure API key authorization: tokenAuth
$config = PidginHost\Sdk\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = PidginHost\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new PidginHost\Sdk\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$api_token_create = new \PidginHost\Sdk\Model\APITokenCreate(); // \PidginHost\Sdk\Model\APITokenCreate

try {
    $result = $apiInstance->accountApiTokensCreate($api_token_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountApiTokensCreate: ', $e->getMessage(), PHP_EOL;
}

Quickstart

<?php
require_once 'vendor/autoload.php';

use PidginHost\Sdk\PidginHost;

$client = new PidginHost(getenv('PIDGINHOST_API_TOKEN'));

// List all servers
$servers = $client->cloud->cloudServersList();
foreach ($servers as $server) {
    echo $server->getName() . "\n";
}

// List SSH keys
$keys = $client->account->accountSshKeysList();

The PidginHost client exposes these API groups:

• $client->account -- account, companies, SSH keys
• $client->auth -- authentication, tokens
• $client->billing -- invoices, payments, funds
• $client->cloud -- servers, images, volumes, IPs, firewalls, networks
• $client->dedicated -- dedicated servers
• $client->domain -- domains, registrants, TLDs
• $client->freedns -- free DNS zones and records
• $client->hosting -- web hosting
• $client->kubernetes -- clusters, resource pools, routes
• $client->support -- support tickets

API Endpoints

All URIs are relative to https://www.pidginhost.com

Class	Method	HTTP request	Description
AccountApi	accountApiTokensCreate	POST /api/account/api-tokens/
AccountApi	accountApiTokensDestroy	DELETE /api/account/api-tokens/{id}/
AccountApi	accountApiTokensList	GET /api/account/api-tokens/
AccountApi	accountCompaniesCreate	POST /api/account/companies/
AccountApi	accountCompaniesDestroy	DELETE /api/account/companies/{id}/
AccountApi	accountCompaniesList	GET /api/account/companies/
AccountApi	accountCompaniesPartialUpdate	PATCH /api/account/companies/{id}/
AccountApi	accountCompaniesRetrieve	GET /api/account/companies/{id}/
AccountApi	accountCompaniesUpdate	PUT /api/account/companies/{id}/
AccountApi	accountEmailsList	GET /api/account/emails/
AccountApi	accountProfilePartialUpdate	PATCH /api/account/profile
AccountApi	accountProfileRetrieve	GET /api/account/profile
AccountApi	accountProfileUpdate	PUT /api/account/profile
AccountApi	accountSshKeysCreate	POST /api/account/ssh-keys/
AccountApi	accountSshKeysDestroy	DELETE /api/account/ssh-keys/{id}/
AccountApi	accountSshKeysList	GET /api/account/ssh-keys/
AccountApi	accountSshKeysPartialUpdate	PATCH /api/account/ssh-keys/{id}/
AccountApi	accountSshKeysRetrieve	GET /api/account/ssh-keys/{id}/
AccountApi	accountSshKeysUpdate	PUT /api/account/ssh-keys/{id}/
AuthApi	authCliSessionCreate	POST /api/auth/cli-session/
AuthApi	authCliSessionRetrieve	GET /api/auth/cli-session/{session_id}/
BillingApi	billingDepositsCreate	POST /api/billing/deposits/
BillingApi	billingDepositsList	GET /api/billing/deposits/
BillingApi	billingDepositsRetrieve	GET /api/billing/deposits/{id}/
BillingApi	billingFundsList	GET /api/billing/funds/
BillingApi	billingFundsLogList	GET /api/billing/funds-log/
BillingApi	billingFundsNotificationSettingsCreate	POST /api/billing/funds/notification-settings/
BillingApi	billingInvoicesList	GET /api/billing/invoices/
BillingApi	billingInvoicesPayWithFundsCreate	POST /api/billing/invoices/{id}/pay-with-funds/
BillingApi	billingInvoicesPdfRetrieve	GET /api/billing/invoices/{id}/pdf/
BillingApi	billingInvoicesRetrieve	GET /api/billing/invoices/{id}/
BillingApi	billingServicesCancelCreate	POST /api/billing/services/{id}/cancel/
BillingApi	billingServicesChangeBillingCycleCreate	POST /api/billing/services/{id}/change-billing-cycle/
BillingApi	billingServicesChangeCompanyCreate	POST /api/billing/services/{id}/change-company/
BillingApi	billingServicesList	GET /api/billing/services/
BillingApi	billingServicesRetrieve	GET /api/billing/services/{id}/
BillingApi	billingServicesToggleAutoPaymentCreate	POST /api/billing/services/{id}/toggle-auto-payment/
BillingApi	billingSubscriptionsList	GET /api/billing/subscriptions/
BillingApi	billingSubscriptionsRetrieve	GET /api/billing/subscriptions/{id}/
CloudApi	cloudBucketsCreate	POST /api/cloud/buckets/
CloudApi	cloudBucketsCredentialsRevealCreate	POST /api/cloud/buckets/{id}/credentials/reveal/
CloudApi	cloudBucketsCredentialsRotateCreate	POST /api/cloud/buckets/{id}/credentials/rotate/
CloudApi	cloudBucketsDestroy	DELETE /api/cloud/buckets/{id}/
CloudApi	cloudBucketsList	GET /api/cloud/buckets/
CloudApi	cloudBucketsResizeCreate	POST /api/cloud/buckets/{id}/resize/
CloudApi	cloudBucketsRetrieve	GET /api/cloud/buckets/{id}/
CloudApi	cloudBucketsVisibilityCreate	POST /api/cloud/buckets/{id}/visibility/
CloudApi	cloudFirewallRulesSetCreate	POST /api/cloud/firewall-rules-set/
CloudApi	cloudFirewallRulesSetDestroy	DELETE /api/cloud/firewall-rules-set/{id}/
CloudApi	cloudFirewallRulesSetList	GET /api/cloud/firewall-rules-set/
CloudApi	cloudFirewallRulesSetPartialUpdate	PATCH /api/cloud/firewall-rules-set/{id}/
CloudApi	cloudFirewallRulesSetRetrieve	GET /api/cloud/firewall-rules-set/{id}/
CloudApi	cloudFirewallRulesSetRulesCreate	POST /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi	cloudFirewallRulesSetRulesDestroy	DELETE /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi	cloudFirewallRulesSetRulesList	GET /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi	cloudFirewallRulesSetRulesPartialUpdate	PATCH /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi	cloudFirewallRulesSetRulesRetrieve	GET /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi	cloudFirewallRulesSetRulesUpdate	PUT /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi	cloudFirewallRulesSetUpdate	PUT /api/cloud/firewall-rules-set/{id}/
CloudApi	cloudFloatingIpv4AuthorizationsList	GET /api/cloud/floating-ipv4/{id}/authorizations/
CloudApi	cloudFloatingIpv4AuthorizeCreate	POST /api/cloud/floating-ipv4/{id}/authorize/
CloudApi	cloudFloatingIpv4Create	POST /api/cloud/floating-ipv4/
CloudApi	cloudFloatingIpv4Destroy	DELETE /api/cloud/floating-ipv4/{id}/
CloudApi	cloudFloatingIpv4List	GET /api/cloud/floating-ipv4/
CloudApi	cloudFloatingIpv4Retrieve	GET /api/cloud/floating-ipv4/{id}/
CloudApi	cloudFloatingIpv4UnauthorizeCreate	POST /api/cloud/floating-ipv4/{id}/unauthorize/
CloudApi	cloudFloatingIpv6AuthorizationsList	GET /api/cloud/floating-ipv6/{id}/authorizations/
CloudApi	cloudFloatingIpv6AuthorizeCreate	POST /api/cloud/floating-ipv6/{id}/authorize/
CloudApi	cloudFloatingIpv6Create	POST /api/cloud/floating-ipv6/
CloudApi	cloudFloatingIpv6Destroy	DELETE /api/cloud/floating-ipv6/{id}/
CloudApi	cloudFloatingIpv6List	GET /api/cloud/floating-ipv6/
CloudApi	cloudFloatingIpv6Retrieve	GET /api/cloud/floating-ipv6/{id}/
CloudApi	cloudFloatingIpv6UnauthorizeCreate	POST /api/cloud/floating-ipv6/{id}/unauthorize/
CloudApi	cloudGenerationsList	GET /api/cloud/generations/	List hardware generations
CloudApi	cloudGenerationsRetrieve	GET /api/cloud/generations/{slug}/
CloudApi	cloudImagesList	GET /api/cloud/images/
CloudApi	cloudImagesRetrieve	GET /api/cloud/images/{id}/
CloudApi	cloudIpv4Create	POST /api/cloud/ipv4/
CloudApi	cloudIpv4Destroy	DELETE /api/cloud/ipv4/{id}/
CloudApi	cloudIpv4DetachCreate	POST /api/cloud/ipv4/{id}/detach/
CloudApi	cloudIpv4List	GET /api/cloud/ipv4/
CloudApi	cloudIpv4RdnsCreate	POST /api/cloud/ipv4/{id}/rdns/
CloudApi	cloudIpv4RdnsRetrieve	GET /api/cloud/ipv4/{id}/rdns/
CloudApi	cloudIpv4Retrieve	GET /api/cloud/ipv4/{id}/
CloudApi	cloudIpv6Create	POST /api/cloud/ipv6/
CloudApi	cloudIpv6Destroy	DELETE /api/cloud/ipv6/{id}/
CloudApi	cloudIpv6DetachCreate	POST /api/cloud/ipv6/{id}/detach/
CloudApi	cloudIpv6List	GET /api/cloud/ipv6/
CloudApi	cloudIpv6RdnsCreate	POST /api/cloud/ipv6/{id}/rdns/
CloudApi	cloudIpv6RdnsRetrieve	GET /api/cloud/ipv6/{id}/rdns/
CloudApi	cloudIpv6Retrieve	GET /api/cloud/ipv6/{id}/
CloudApi	cloudPrivateNetworksAddServerCreate	POST /api/cloud/private-networks/{id}/add-server/
CloudApi	cloudPrivateNetworksCreate	POST /api/cloud/private-networks/
CloudApi	cloudPrivateNetworksDestroy	DELETE /api/cloud/private-networks/{id}/
CloudApi	cloudPrivateNetworksList	GET /api/cloud/private-networks/
CloudApi	cloudPrivateNetworksPartialUpdate	PATCH /api/cloud/private-networks/{id}/
CloudApi	cloudPrivateNetworksRemoveServerCreate	POST /api/cloud/private-networks/{id}/remove-server/
CloudApi	cloudPrivateNetworksRetrieve	GET /api/cloud/private-networks/{id}/
CloudApi	cloudPrivateNetworksUpdate	PUT /api/cloud/private-networks/{id}/
CloudApi	cloudServerPackagesByGenerationRetrieve	GET /api/cloud/server-packages/by-generation/
CloudApi	cloudServerPackagesList	GET /api/cloud/server-packages/
CloudApi	cloudServerPackagesRetrieve	GET /api/cloud/server-packages/{id}/
CloudApi	cloudServersActivityRetrieve	GET /api/cloud/servers/{id}/activity/
CloudApi	cloudServersAttachIpv4Create	POST /api/cloud/servers/{id}/attach-ipv4/
CloudApi	cloudServersAttachIpv6Create	POST /api/cloud/servers/{id}/attach-ipv6/
CloudApi	cloudServersConsoleCreate	POST /api/cloud/servers/{id}/console/
CloudApi	cloudServersCreate	POST /api/cloud/servers/
CloudApi	cloudServersDestroy	DELETE /api/cloud/servers/{id}/
CloudApi	cloudServersDestroyProtectionCreate	POST /api/cloud/servers/{id}/destroy-protection/
CloudApi	cloudServersDetachIpv4Create	POST /api/cloud/servers/{id}/detach-ipv4/
CloudApi	cloudServersDetachIpv6Create	POST /api/cloud/servers/{id}/detach-ipv6/
CloudApi	cloudServersList	GET /api/cloud/servers/
CloudApi	cloudServersModifyPackageCreate	POST /api/cloud/servers/{id}/modify-package/
CloudApi	cloudServersPartialUpdate	PATCH /api/cloud/servers/{id}/
CloudApi	cloudServersPowerManagementCreate	POST /api/cloud/servers/{id}/power-management/
CloudApi	cloudServersPowerManagementRetrieve	GET /api/cloud/servers/{id}/power-management/
CloudApi	cloudServersPublicInterfaceCreate	POST /api/cloud/servers/{id}/public-interface/
CloudApi	cloudServersPublicInterfaceDestroy	DELETE /api/cloud/servers/{id}/public-interface/
CloudApi	cloudServersPublicInterfaceRetrieve	GET /api/cloud/servers/{id}/public-interface/
CloudApi	cloudServersRetrieve	GET /api/cloud/servers/{id}/
CloudApi	cloudServersRetryProvisionCreate	POST /api/cloud/servers/{id}/retry-provision/
CloudApi	cloudServersSnapshotsCreate	POST /api/cloud/servers/{id}/snapshots/
CloudApi	cloudServersSnapshotsDestroy	DELETE /api/cloud/servers/{id}/snapshots/{snapshot_name}/
CloudApi	cloudServersSnapshotsList	GET /api/cloud/servers/{id}/snapshots/
CloudApi	cloudServersSnapshotsRollbackCreate	POST /api/cloud/servers/{id}/snapshots/{snapshot_name}/rollback/
CloudApi	cloudServersUpdate	PUT /api/cloud/servers/{id}/
CloudApi	cloudServersUsageRetrieve	GET /api/cloud/servers/{id}/usage/
CloudApi	cloudServersVolumesCreate	POST /api/cloud/servers/{server_id}/volumes/
CloudApi	cloudServersVolumesDestroy	DELETE /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi	cloudServersVolumesList	GET /api/cloud/servers/{server_id}/volumes/
CloudApi	cloudServersVolumesPartialUpdate	PATCH /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi	cloudServersVolumesRetrieve	GET /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi	cloudServersVolumesUpdate	PUT /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi	cloudStorageProductsList	GET /api/cloud/storage-products/
CloudApi	cloudStorageProductsRetrieve	GET /api/cloud/storage-products/{id}/
CloudApi	cloudVolumesAttachCreate	POST /api/cloud/volumes/{id}/attach/
CloudApi	cloudVolumesDestroy	DELETE /api/cloud/volumes/{id}/
CloudApi	cloudVolumesDetachCreate	POST /api/cloud/volumes/{id}/detach/
CloudApi	cloudVolumesList	GET /api/cloud/volumes/
CloudApi	cloudVolumesPartialUpdate	PATCH /api/cloud/volumes/{id}/
CloudApi	cloudVolumesRetrieve	GET /api/cloud/volumes/{id}/
CloudApi	cloudVolumesUpdate	PUT /api/cloud/volumes/{id}/
DedicatedApi	dedicatedServersList	GET /api/dedicated/servers/
DedicatedApi	dedicatedServersPowerCreate	POST /api/dedicated/servers/{id}/power/
DedicatedApi	dedicatedServersRdnsCreate	POST /api/dedicated/servers/{id}/rdns/
DedicatedApi	dedicatedServersReinstallCreate	POST /api/dedicated/servers/{id}/reinstall/
DedicatedApi	dedicatedServersRetrieve	GET /api/dedicated/servers/{id}/
DomainApi	domainDomainCancelCreate	POST /api/domain/domain/{domain}/cancel/
DomainApi	domainDomainCheckAvailabilityCreate	POST /api/domain/domain/check-availability/
DomainApi	domainDomainContactsCreate	POST /api/domain/domain/{domain}/contacts/
DomainApi	domainDomainCreate	POST /api/domain/domain/
DomainApi	domainDomainList	GET /api/domain/domain/
DomainApi	domainDomainNameserversCreate	POST /api/domain/domain/{domain}/nameservers/
DomainApi	domainDomainPartialUpdate	PATCH /api/domain/domain/{domain}/
DomainApi	domainDomainRenewCreate	POST /api/domain/domain/{domain}/renew/
DomainApi	domainDomainRetrieve	GET /api/domain/domain/{domain}/
DomainApi	domainDomainTransferRoDomainCreate	POST /api/domain/domain/transfer-ro-domain/
DomainApi	domainDomainUpdate	PUT /api/domain/domain/{domain}/
DomainApi	domainRegistrantsCreate	POST /api/domain/registrants/
DomainApi	domainRegistrantsDestroy	DELETE /api/domain/registrants/{id}/
DomainApi	domainRegistrantsList	GET /api/domain/registrants/
DomainApi	domainRegistrantsPartialUpdate	PATCH /api/domain/registrants/{id}/
DomainApi	domainRegistrantsRetrieve	GET /api/domain/registrants/{id}/
DomainApi	domainRegistrantsUpdate	PUT /api/domain/registrants/{id}/
DomainApi	domainTldList	GET /api/domain/tld/
DomainApi	domainTldRetrieve	GET /api/domain/tld/{id}/
EmailApi	emailApiCredentialsCreate	POST /api/email/api_credentials/
EmailApi	emailApiCredentialsDestroy	DELETE /api/email/api_credentials/{id}/
EmailApi	emailApiCredentialsList	GET /api/email/api_credentials/
EmailApi	emailApiCredentialsRetrieve	GET /api/email/api_credentials/{id}/
EmailApi	emailDomainsCreate	POST /api/email/domains/
EmailApi	emailDomainsInboundRoutesCreate	POST /api/email/domains/{domain_pk}/inbound_routes/
EmailApi	emailDomainsInboundRoutesList	GET /api/email/domains/{domain_pk}/inbound_routes/
EmailApi	emailDomainsList	GET /api/email/domains/
EmailApi	emailDomainsRetrieve	GET /api/email/domains/{id}/
EmailApi	emailDomainsRotateDkimCreate	POST /api/email/domains/{id}/rotate_dkim/
EmailApi	emailDomainsToggleInboundCreate	POST /api/email/domains/{id}/toggle_inbound/
EmailApi	emailDomainsVerifyCreate	POST /api/email/domains/{id}/verify/
EmailApi	emailInboundRoutesCreate	POST /api/email/inbound_routes/
EmailApi	emailInboundRoutesDestroy	DELETE /api/email/inbound_routes/{id}/
EmailApi	emailInboundRoutesList	GET /api/email/inbound_routes/
EmailApi	emailInboundRoutesPartialUpdate	PATCH /api/email/inbound_routes/{id}/
EmailApi	emailInboundRoutesRetrieve	GET /api/email/inbound_routes/{id}/
EmailApi	emailMessagesRetrieve	GET /api/email/messages/{message_id}/
EmailApi	emailSandboxAddressesCreate	POST /api/email/sandbox_addresses/
EmailApi	emailSandboxAddressesDestroy	DELETE /api/email/sandbox_addresses/{id}/
EmailApi	emailSandboxAddressesList	GET /api/email/sandbox_addresses/
EmailApi	emailSandboxAddressesRetrieve	GET /api/email/sandbox_addresses/{id}/
EmailApi	emailSendCreate	POST /api/email/send/
EmailApi	emailServicesApiCredentialsCreate	POST /api/email/services/{service_pk}/api_credentials/
EmailApi	emailServicesApiCredentialsList	GET /api/email/services/{service_pk}/api_credentials/
EmailApi	emailServicesCancelCreate	POST /api/email/services/{id}/cancel/
EmailApi	emailServicesChangeTierPartialUpdate	PATCH /api/email/services/{id}/change_tier/
EmailApi	emailServicesCreate	POST /api/email/services/
EmailApi	emailServicesDedicatedIpCreate	POST /api/email/services/{id}/dedicated_ip/
EmailApi	emailServicesDedicatedIpDestroy	DELETE /api/email/services/{id}/dedicated_ip/
EmailApi	emailServicesDestroy	DELETE /api/email/services/{id}/
EmailApi	emailServicesDomainsCreate	POST /api/email/services/{service_pk}/domains/
EmailApi	emailServicesDomainsList	GET /api/email/services/{service_pk}/domains/
EmailApi	emailServicesList	GET /api/email/services/
EmailApi	emailServicesMessagesRetrieve	GET /api/email/services/{service_pk}/messages/
EmailApi	emailServicesPartialUpdate	PATCH /api/email/services/{id}/
EmailApi	emailServicesRestoreCreate	POST /api/email/services/{id}/restore/
EmailApi	emailServicesRetrieve	GET /api/email/services/{id}/
EmailApi	emailServicesSandboxAddressesCreate	POST /api/email/services/{service_pk}/sandbox_addresses/
EmailApi	emailServicesSandboxAddressesList	GET /api/email/services/{service_pk}/sandbox_addresses/
EmailApi	emailServicesSmtpCredentialsCreate	POST /api/email/services/{service_pk}/smtp_credentials/
EmailApi	emailServicesSmtpCredentialsList	GET /api/email/services/{service_pk}/smtp_credentials/
EmailApi	emailServicesStatsRetrieve	GET /api/email/services/{service_pk}/stats/
EmailApi	emailServicesSuppressionsCreate	POST /api/email/services/{service_pk}/suppressions/
EmailApi	emailServicesSuppressionsList	GET /api/email/services/{service_pk}/suppressions/
EmailApi	emailSmtpCredentialsCreate	POST /api/email/smtp_credentials/
EmailApi	emailSmtpCredentialsDestroy	DELETE /api/email/smtp_credentials/{id}/
EmailApi	emailSmtpCredentialsList	GET /api/email/smtp_credentials/
EmailApi	emailSmtpCredentialsRetrieve	GET /api/email/smtp_credentials/{id}/
EmailApi	emailSuppressionsCreate	POST /api/email/suppressions/
EmailApi	emailSuppressionsDestroy	DELETE /api/email/suppressions/{id}/
EmailApi	emailSuppressionsList	GET /api/email/suppressions/
EmailApi	emailSuppressionsRetrieve	GET /api/email/suppressions/{id}/
FreednsApi	freednsDnsActivateCreate	POST /api/freedns/dns/activate/
FreednsApi	freednsDnsAddRecordCreate	POST /api/freedns/dns/add-record/
FreednsApi	freednsDnsDeactivateCreate	POST /api/freedns/dns/deactivate/
FreednsApi	freednsDnsDeleteRecordCreate	POST /api/freedns/dns/delete-record/
FreednsApi	freednsDnsList	GET /api/freedns/dns/
FreednsApi	freednsDnsRecordsList	GET /api/freedns/dns/records/
HostingApi	hostingHostingChangePasswordCreate	POST /api/hosting/hosting/{id}/change-password/
HostingApi	hostingHostingList	GET /api/hosting/hosting/
HostingApi	hostingHostingRetrieve	GET /api/hosting/hosting/{id}/
KubernetesApi	kubernetesClusterTypesList	GET /api/kubernetes/cluster-types/
KubernetesApi	kubernetesClustersConnectVmCreate	POST /api/kubernetes/clusters/{id}/connect-vm/
KubernetesApi	kubernetesClustersConnectedVmsRetrieve	GET /api/kubernetes/clusters/{id}/connected-vms/
KubernetesApi	kubernetesClustersCreate	POST /api/kubernetes/clusters/
KubernetesApi	kubernetesClustersDestroy	DELETE /api/kubernetes/clusters/{id}/
KubernetesApi	kubernetesClustersDisconnectVmCreate	POST /api/kubernetes/clusters/{id}/disconnect-vm/
KubernetesApi	kubernetesClustersEligibleVmsRetrieve	GET /api/kubernetes/clusters/{id}/eligible-vms/
KubernetesApi	kubernetesClustersHttproutesCreate	POST /api/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi	kubernetesClustersHttproutesDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi	kubernetesClustersHttproutesPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi	kubernetesClustersHttproutesRetrieve	GET /api/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi	kubernetesClustersHttproutesRetrieve2	GET /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi	kubernetesClustersHttproutesUpdate	PUT /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi	kubernetesClustersKubeVersionUpgradeCreate	POST /api/kubernetes/clusters/{id}/kube-version-upgrade/
KubernetesApi	kubernetesClustersKubeconfigCreate	POST /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi	kubernetesClustersKubeconfigRetrieve	GET /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi	kubernetesClustersLbFirewallCreate	POST /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi	kubernetesClustersLbFirewallDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi	kubernetesClustersLbFirewallList	GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi	kubernetesClustersLbFirewallPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi	kubernetesClustersLbFirewallRetrieve	GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi	kubernetesClustersLbFirewallUpdate	PUT /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi	kubernetesClustersList	GET /api/kubernetes/clusters/
KubernetesApi	kubernetesClustersPartialUpdate	PATCH /api/kubernetes/clusters/{id}/
KubernetesApi	kubernetesClustersPortForwardsCreate	POST /api/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi	kubernetesClustersPortForwardsDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi	kubernetesClustersPortForwardsPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi	kubernetesClustersPortForwardsRetrieve	GET /api/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi	kubernetesClustersPortForwardsRetrieve2	GET /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi	kubernetesClustersPortForwardsUpdate	PUT /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi	kubernetesClustersResourcePoolsCreate	POST /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi	kubernetesClustersResourcePoolsDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi	kubernetesClustersResourcePoolsList	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi	kubernetesClustersResourcePoolsNodesDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi	kubernetesClustersResourcePoolsNodesList	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/
KubernetesApi	kubernetesClustersResourcePoolsNodesMetricsRetrieve	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/metrics/
KubernetesApi	kubernetesClustersResourcePoolsNodesRetrieve	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi	kubernetesClustersResourcePoolsNodesRrdRetrieve	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/rrd/
KubernetesApi	kubernetesClustersResourcePoolsPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi	kubernetesClustersResourcePoolsRetrieve	GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi	kubernetesClustersResourcePoolsUpdate	PUT /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi	kubernetesClustersRetrieve	GET /api/kubernetes/clusters/{id}/
KubernetesApi	kubernetesClustersTalosVersionUpgradeCreate	POST /api/kubernetes/clusters/{id}/talos-version-upgrade/
KubernetesApi	kubernetesClustersTcproutesCreate	POST /api/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi	kubernetesClustersTcproutesDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi	kubernetesClustersTcproutesPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi	kubernetesClustersTcproutesRetrieve	GET /api/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi	kubernetesClustersTcproutesRetrieve2	GET /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi	kubernetesClustersTcproutesUpdate	PUT /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi	kubernetesClustersToggleCloudVmAccessCreate	POST /api/kubernetes/clusters/{id}/toggle-cloud-vm-access/
KubernetesApi	kubernetesClustersUdproutesCreate	POST /api/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi	kubernetesClustersUdproutesDestroy	DELETE /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi	kubernetesClustersUdproutesPartialUpdate	PATCH /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi	kubernetesClustersUdproutesRetrieve	GET /api/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi	kubernetesClustersUdproutesRetrieve2	GET /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi	kubernetesClustersUdproutesUpdate	PUT /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi	kubernetesClustersUpdate	PUT /api/kubernetes/clusters/{id}/
KubernetesApi	kubernetesClustersUpgradeFeatureCreate	POST /api/kubernetes/clusters/{id}/upgrade-feature/
SchemaApi	schemaRetrieve	GET /api/schema/
SupportApi	supportDepartmentsList	GET /api/support/departments/
SupportApi	supportTicketsCloseCreate	POST /api/support/tickets/{id}/close/
SupportApi	supportTicketsCreate	POST /api/support/tickets/
SupportApi	supportTicketsList	GET /api/support/tickets/
SupportApi	supportTicketsMessagesAttachmentRetrieve	GET /api/support/tickets/{id}/messages/{message_id}/attachment/
SupportApi	supportTicketsReopenCreate	POST /api/support/tickets/{id}/reopen/
SupportApi	supportTicketsReplyCreate	POST /api/support/tickets/{id}/reply/
SupportApi	supportTicketsRetrieve	GET /api/support/tickets/{id}/

Models

• APITokenCreate
• APITokenList
• ActivateFreeDNS
• ActivateFreeDNSResponse
• ActivityLogEntry
• ActivityLogResponse
• AddServerResponse
• Address
• ApiCredential
• AttachIPv4
• AttachIPv6
• AttachVolume
• Bucket
• CLISessionCreateResponse
• CLISessionPollResponse
• CLISessionPollResponseStatusEnum
• CancelServiceResponse
• ChangeBillingCycle
• ChangeBillingCycleResponse
• ChangeCompany
• ChangeCompanyResponse
• ChangePassword
• CheckAvailability
• ClusterAdd
• ClusterAddResponse
• ClusterDetail
• ClusterPackage
• ClusterType
• ClusterTypeEnum
• Company
• ConnectVMRequest
• ConnectVMResponse
• ConnectedVM
• ConnectedVMsResponse
• ConsoleToken
• ContactTypeEnum
• ContactsUpdate
• ContactsUpdateResponse
• CountryEnum
• DNSRecord
• DNSRecordCreate
• DNSRecordCreateTypeEnum
• DNSRecordMutateResponse
• DeactivateFreeDNS
• DeactivateFreeDNSResponse
• DedicatedRDNS
• DedicatedServer
• DeleteRecord
• DeleteRecordResponse
• Department
• Deposit
• DepositCreate
• DepositStatusEnum
• DestroyProtection
• DetachIPv4
• DetachIPv4Response
• DetachIPv6
• DetachIPv6Response
• DetachVolume
• DisconnectVMRequest
• DisconnectVMResponse
• DnsSourceEnum
• Domain
• DomainAdd
• DomainCancelResponse
• DomainCreate
• DomainRegistrant
• EligibleVM
• EligibleVMsResponse
• EmailHistory
• EmailService
• FeatureUpgradeRequest
• FeatureUpgradeResponse
• FeaturesEnum
• FirewallRule
• FirewallRuleDirectionEnum
• FirewallRulesSet
• FirewallRulesSetStatusEnum
• FloatingIPAuthorization
• FloatingIPAuthorizeRequest
• FloatingIPv4
• FloatingIPv4AuthorizeResponse
• FloatingIPv4Create
• FloatingIPv4UnauthorizeResponse
• FloatingIPv6
• FloatingIPv6AuthorizeResponse
• FloatingIPv6Create
• FloatingIPv6UnauthorizeResponse
• FreeDNSDomain
• FundsBalanceResponse
• FundsLog
• FwPolicyOutEnum
• HTTPRoute
• HardwareGeneration
• HostingChangePasswordResponse
• HostingService
• InboundRoute
• InvoiceDetail
• InvoiceList
• KubeUpgradeResponse
• KubeVersionEnum
• LBFirewallRule
• LBFirewallRuleActionEnum
• LBFirewallRuleDirectionEnum
• LowBalanceSettings
• ModeEnum
• NameserversUpdate
• NameserversUpdateResponse
• NodeMetricsResponse
• NodeRRDResponse
• NotificationSettingsResponse
• OSImage
• OperationEnum
• PaginatedAPITokenListList
• PaginatedApiCredentialList
• PaginatedClusterDetailList
• PaginatedClusterTypeList
• PaginatedCompanyList
• PaginatedDedicatedServerList
• PaginatedDepositList
• PaginatedDomainList
• PaginatedDomainRegistrantList
• PaginatedEmailHistoryList
• PaginatedEmailServiceList
• PaginatedFloatingIPAuthorizationList
• PaginatedFloatingIPv4List
• PaginatedFloatingIPv6List
• PaginatedFundsLogList
• PaginatedHostingServiceList
• PaginatedInboundRouteList
• PaginatedInvoiceListList
• PaginatedLBFirewallRuleList
• PaginatedOSImageList
• PaginatedPrivateNetworkList
• PaginatedPublicIPv4List
• PaginatedPublicIPv6List
• PaginatedResourcePoolList
• PaginatedResourcePoolNodeList
• PaginatedSSHKeyList
• PaginatedSandboxAddressList
• PaginatedSendingDomainList
• PaginatedServerList
• PaginatedServerProductList
• PaginatedServiceListList
• PaginatedSmtpCredentialList
• PaginatedSnapshotList
• PaginatedStorageProductList
• PaginatedSubscriptionList
• PaginatedSuppressionEntryList
• PaginatedTLDList
• PaginatedTicketListList
• PatchedClusterDetail
• PatchedCompany
• PatchedDomain
• PatchedDomainRegistrant
• PatchedEmailService
• PatchedFirewallRule
• PatchedFirewallRulesSet
• PatchedHTTPRoute
• PatchedInboundRoute
• PatchedLBFirewallRule
• PatchedPrivateNetwork
• PatchedProfile
• PatchedResourcePool
• PatchedSSHKey
• PatchedServerDetail
• PatchedSubscribe
• PatchedTCPRoute
• PatchedUDPRoute
• PatchedVolume
• PayWithFundsResponse
• PowerAction
• PowerActionActionEnum
• PowerActionResponse
• PowerManagement
• PowerManagementRequest
• PowerManagementRequestActionEnum
• Priority3cdEnum
• PrivateNetwork
• PrivateNetworkAddHost
• PrivateNetworkRemoveHost
• Profile
• PublicIPv4
• PublicIPv6
• PublicInterface
• RDNSUpdateResponse
• ReasonEnum
• Reinstall
• ReinstallResponse
• RemoveServerResponse
• RenewDomain
• ResourcePool
• ResourcePoolAdd
• ResourcePoolAddResponse
• ResourcePoolNode
• RetryProvision
• ReverseDNS
• SSHKey
• SandboxAddress
• ScopeEnum
• SendingDomain
• SendingDomainStatusEnum
• Server
• ServerAdd
• ServerAddResponse
• ServerDetail
• ServerProduct
• ServerProductUpgrade
• ServerUpgradeResponse
• ServerUsageResponse
• Service
• ServiceList
• SmtpCredential
• Snapshot
• SnapshotCreate
• SnapshotCreateQueued
• SnapshotDeleteQueued
• SnapshotRollbackQueued
• SourceEnum
• Status03cEnum
• Status63aEnum
• StatusA57Enum
• StatusEf2Enum
• StorageProduct
• Subscribe
• Subscription
• SubscriptionStatusEnum
• SuppressionEntry
• TCPRoute
• TLD
• TalosUpgradeResponse
• ThresholdTypeEnum
• TicketCloseResponse
• TicketCreate
• TicketCreatePriorityEnum
• TicketDetail
• TicketList
• TicketReopenResponse
• TicketReply
• TicketReplyResponse
• TierEnum
• ToggleAutoPaymentResponse
• ToggleCloudVMAccessResponse
• TransferRoDomain
• Type2faEnum
• UDPRoute
• Volume

Authorization

Authentication schemes defined for the API:

cookieAuth

• Type: API key
• API key parameter name: sessionid
• Location:

tokenAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[e-mail]

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0 (v1)
  • Package version: 0.8.0
  • Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen