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

Models

• APITokenCreate
• APITokenList
• ActivateFreeDNS
• ActivateFreeDNSResponse
• ActivityLogEntry
• ActivityLogResponse
• AddServerResponse
• Address
• AttachIPv4
• AttachIPv6
• AttachVolume
• 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
• Domain
• DomainCancelResponse
• DomainCreate
• DomainRegistrant
• EligibleVM
• EligibleVMsResponse
• EmailHistory
• FeatureUpgradeRequest
• FeatureUpgradeResponse
• FeaturesEnum
• FirewallRule
• FirewallRuleDirectionEnum
• FirewallRulesSet
• FirewallRulesSetStatusEnum
• FreeDNSDomain
• FundsBalanceResponse
• FundsLog
• FwPolicyOutEnum
• HTTPRoute
• HardwareGeneration
• HostingChangePasswordResponse
• HostingService
• InvoiceDetail
• InvoiceList
• KubeUpgradeResponse
• KubeVersionEnum
• LBFirewallRule
• LBFirewallRuleActionEnum
• LBFirewallRuleDirectionEnum
• LowBalanceSettings
• NameserversUpdate
• NameserversUpdateResponse
• NodeMetricsResponse
• NodeRRDResponse
• NotificationSettingsResponse
• OSImage
• OperationEnum
• PaginatedAPITokenListList
• PaginatedClusterDetailList
• PaginatedClusterTypeList
• PaginatedCompanyList
• PaginatedDedicatedServerList
• PaginatedDepositList
• PaginatedDomainList
• PaginatedDomainRegistrantList
• PaginatedEmailHistoryList
• PaginatedFundsLogList
• PaginatedHostingServiceList
• PaginatedInvoiceListList
• PaginatedLBFirewallRuleList
• PaginatedOSImageList
• PaginatedPrivateNetworkList
• PaginatedPublicIPv4List
• PaginatedPublicIPv6List
• PaginatedResourcePoolList
• PaginatedResourcePoolNodeList
• PaginatedSSHKeyList
• PaginatedServerList
• PaginatedServerProductList
• PaginatedServiceListList
• PaginatedSnapshotList
• PaginatedStorageProductList
• PaginatedSubscriptionList
• PaginatedTLDList
• PaginatedTicketListList
• PatchedClusterDetail
• PatchedCompany
• PatchedDomain
• PatchedDomainRegistrant
• PatchedFirewallRule
• PatchedFirewallRulesSet
• PatchedHTTPRoute
• PatchedLBFirewallRule
• PatchedPrivateNetwork
• PatchedProfile
• PatchedResourcePool
• PatchedSSHKey
• PatchedServerDetail
• PatchedTCPRoute
• PatchedUDPRoute
• PatchedVolume
• PayWithFundsResponse
• PowerAction
• PowerActionActionEnum
• PowerActionResponse
• PowerManagement
• PowerManagementRequest
• PowerManagementRequestActionEnum
• Priority3cdEnum
• PrivateNetwork
• PrivateNetworkAddHost
• PrivateNetworkRemoveHost
• Profile
• PublicIPv4
• PublicIPv6
• PublicInterface
• RDNSUpdateResponse
• Reinstall
• ReinstallResponse
• RemoveServerResponse
• RenewDomain
• ResourcePool
• ResourcePoolAdd
• ResourcePoolAddResponse
• ResourcePoolNode
• RetryProvision
• ReverseDNS
• SSHKey
• ScopeEnum
• Server
• ServerAdd
• ServerAddResponse
• ServerDetail
• ServerProduct
• ServerProductUpgrade
• ServerUpgradeResponse
• ServerUsageResponse
• Service
• ServiceList
• Snapshot
• SnapshotCreate
• SnapshotCreateQueued
• SnapshotDeleteQueued
• SnapshotRollbackQueued
• SourceEnum
• Status03cEnum
• Status63aEnum
• StatusA57Enum
• StatusEf2Enum
• StorageProduct
• Subscription
• SubscriptionStatusEnum
• TCPRoute
• TLD
• TalosUpgradeResponse
• ThresholdTypeEnum
• TicketCloseResponse
• TicketCreate
• TicketCreatePriorityEnum
• TicketDetail
• TicketList
• TicketReopenResponse
• TicketReply
• TicketReplyResponse
• 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

support@pidginhost.com

About this package

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

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