Skip to content

pidginhost/sdk-js

Repository files navigation

@pidginhost/sdk@0.3.0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

  • Node.js
  • Webpack
  • Browserify

Language level

  • ES5 - you must have a Promises/A+ library installed
  • ES6

Module system

  • CommonJS
  • ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @pidginhost/sdk@0.3.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Quickstart

import { PidginHost } from "@pidginhost/sdk";

const client = new PidginHost(process.env.PIDGINHOST_API_TOKEN!);

// List all servers
const { data: servers } = await client.cloud.cloudServersList();
for (const server of servers) {
  console.log(server.name);
}

// List SSH keys
const { data: keys } = await 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

Documentation for API Endpoints

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

Class Method HTTP request Description
AccountApi accountApiTokensCreate POST /api/account/api-tokens/
AccountApi accountApiTokensCreate2 POST /api/v1/account/api-tokens/
AccountApi accountApiTokensDestroy DELETE /api/account/api-tokens/{id}/
AccountApi accountApiTokensDestroy2 DELETE /api/v1/account/api-tokens/{id}/
AccountApi accountApiTokensList GET /api/account/api-tokens/
AccountApi accountApiTokensList2 GET /api/v1/account/api-tokens/
AccountApi accountCompaniesCreate POST /api/account/companies/
AccountApi accountCompaniesCreate2 POST /api/v1/account/companies/
AccountApi accountCompaniesDestroy DELETE /api/account/companies/{id}/
AccountApi accountCompaniesDestroy2 DELETE /api/v1/account/companies/{id}/
AccountApi accountCompaniesList GET /api/account/companies/
AccountApi accountCompaniesList2 GET /api/v1/account/companies/
AccountApi accountCompaniesPartialUpdate PATCH /api/account/companies/{id}/
AccountApi accountCompaniesPartialUpdate2 PATCH /api/v1/account/companies/{id}/
AccountApi accountCompaniesRetrieve GET /api/account/companies/{id}/
AccountApi accountCompaniesRetrieve2 GET /api/v1/account/companies/{id}/
AccountApi accountCompaniesUpdate PUT /api/account/companies/{id}/
AccountApi accountCompaniesUpdate2 PUT /api/v1/account/companies/{id}/
AccountApi accountEmailsList GET /api/account/emails/
AccountApi accountEmailsList2 GET /api/v1/account/emails/
AccountApi accountProfilePartialUpdate PATCH /api/account/profile
AccountApi accountProfilePartialUpdate2 PATCH /api/v1/account/profile
AccountApi accountProfileRetrieve GET /api/account/profile
AccountApi accountProfileRetrieve2 GET /api/v1/account/profile
AccountApi accountProfileUpdate PUT /api/account/profile
AccountApi accountProfileUpdate2 PUT /api/v1/account/profile
AccountApi accountSshKeysCreate POST /api/account/ssh-keys/
AccountApi accountSshKeysCreate2 POST /api/v1/account/ssh-keys/
AccountApi accountSshKeysDestroy DELETE /api/account/ssh-keys/{id}/
AccountApi accountSshKeysDestroy2 DELETE /api/v1/account/ssh-keys/{id}/
AccountApi accountSshKeysList GET /api/account/ssh-keys/
AccountApi accountSshKeysList2 GET /api/v1/account/ssh-keys/
AccountApi accountSshKeysPartialUpdate PATCH /api/account/ssh-keys/{id}/
AccountApi accountSshKeysPartialUpdate2 PATCH /api/v1/account/ssh-keys/{id}/
AccountApi accountSshKeysRetrieve GET /api/account/ssh-keys/{id}/
AccountApi accountSshKeysRetrieve2 GET /api/v1/account/ssh-keys/{id}/
AccountApi accountSshKeysUpdate PUT /api/account/ssh-keys/{id}/
AccountApi accountSshKeysUpdate2 PUT /api/v1/account/ssh-keys/{id}/
AuthApi authCliSessionCreate POST /api/auth/cli-session/
AuthApi authCliSessionCreate2 POST /api/v1/auth/cli-session/
AuthApi authCliSessionRetrieve GET /api/auth/cli-session/{session_id}/
AuthApi authCliSessionRetrieve2 GET /api/v1/auth/cli-session/{session_id}/
BillingApi billingDepositsCreate POST /api/billing/deposits/
BillingApi billingDepositsCreate2 POST /api/v1/billing/deposits/
BillingApi billingDepositsList GET /api/billing/deposits/
BillingApi billingDepositsList2 GET /api/v1/billing/deposits/
BillingApi billingDepositsRetrieve GET /api/billing/deposits/{id}/
BillingApi billingDepositsRetrieve2 GET /api/v1/billing/deposits/{id}/
BillingApi billingFundsList GET /api/billing/funds/
BillingApi billingFundsList2 GET /api/v1/billing/funds/
BillingApi billingFundsLogList GET /api/billing/funds-log/
BillingApi billingFundsLogList2 GET /api/v1/billing/funds-log/
BillingApi billingFundsNotificationSettingsCreate POST /api/billing/funds/notification-settings/
BillingApi billingFundsNotificationSettingsCreate2 POST /api/v1/billing/funds/notification-settings/
BillingApi billingInvoicesList GET /api/billing/invoices/
BillingApi billingInvoicesList2 GET /api/v1/billing/invoices/
BillingApi billingInvoicesPayWithFundsCreate POST /api/billing/invoices/{id}/pay-with-funds/
BillingApi billingInvoicesPayWithFundsCreate2 POST /api/v1/billing/invoices/{id}/pay-with-funds/
BillingApi billingInvoicesPdfRetrieve GET /api/billing/invoices/{id}/pdf/
BillingApi billingInvoicesPdfRetrieve2 GET /api/v1/billing/invoices/{id}/pdf/
BillingApi billingInvoicesRetrieve GET /api/billing/invoices/{id}/
BillingApi billingInvoicesRetrieve2 GET /api/v1/billing/invoices/{id}/
BillingApi billingServicesCancelCreate POST /api/billing/services/{id}/cancel/
BillingApi billingServicesCancelCreate2 POST /api/v1/billing/services/{id}/cancel/
BillingApi billingServicesChangeBillingCycleCreate POST /api/billing/services/{id}/change-billing-cycle/
BillingApi billingServicesChangeBillingCycleCreate2 POST /api/v1/billing/services/{id}/change-billing-cycle/
BillingApi billingServicesChangeCompanyCreate POST /api/billing/services/{id}/change-company/
BillingApi billingServicesChangeCompanyCreate2 POST /api/v1/billing/services/{id}/change-company/
BillingApi billingServicesList GET /api/billing/services/
BillingApi billingServicesList2 GET /api/v1/billing/services/
BillingApi billingServicesRetrieve GET /api/billing/services/{id}/
BillingApi billingServicesRetrieve2 GET /api/v1/billing/services/{id}/
BillingApi billingServicesToggleAutoPaymentCreate POST /api/billing/services/{id}/toggle-auto-payment/
BillingApi billingServicesToggleAutoPaymentCreate2 POST /api/v1/billing/services/{id}/toggle-auto-payment/
BillingApi billingSubscriptionsList GET /api/billing/subscriptions/
BillingApi billingSubscriptionsList2 GET /api/v1/billing/subscriptions/
BillingApi billingSubscriptionsRetrieve GET /api/billing/subscriptions/{id}/
BillingApi billingSubscriptionsRetrieve2 GET /api/v1/billing/subscriptions/{id}/
CloudApi cloudFirewallRulesSetCreate POST /api/cloud/firewall-rules-set/
CloudApi cloudFirewallRulesSetCreate2 POST /api/v1/cloud/firewall-rules-set/
CloudApi cloudFirewallRulesSetDestroy DELETE /api/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetDestroy2 DELETE /api/v1/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetList GET /api/cloud/firewall-rules-set/
CloudApi cloudFirewallRulesSetList2 GET /api/v1/cloud/firewall-rules-set/
CloudApi cloudFirewallRulesSetPartialUpdate PATCH /api/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetPartialUpdate2 PATCH /api/v1/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetRetrieve GET /api/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetRetrieve2 GET /api/v1/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetRulesCreate POST /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloudFirewallRulesSetRulesCreate2 POST /api/v1/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloudFirewallRulesSetRulesDestroy DELETE /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloudFirewallRulesSetRulesDestroy2 DELETE /api/v1/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloudFirewallRulesSetRulesList GET /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloudFirewallRulesSetRulesList2 GET /api/v1/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloudFirewallRulesSetRulesPartialUpdate PATCH /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloudFirewallRulesSetRulesPartialUpdate2 PATCH /api/v1/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 cloudFirewallRulesSetRulesRetrieve2 GET /api/v1/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 cloudFirewallRulesSetRulesUpdate2 PUT /api/v1/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloudFirewallRulesSetUpdate PUT /api/cloud/firewall-rules-set/{id}/
CloudApi cloudFirewallRulesSetUpdate2 PUT /api/v1/cloud/firewall-rules-set/{id}/
CloudApi cloudImagesList GET /api/cloud/images/
CloudApi cloudImagesList2 GET /api/v1/cloud/images/
CloudApi cloudImagesRetrieve GET /api/cloud/images/{id}/
CloudApi cloudImagesRetrieve2 GET /api/v1/cloud/images/{id}/
CloudApi cloudIpv4Create POST /api/cloud/ipv4/
CloudApi cloudIpv4Create2 POST /api/v1/cloud/ipv4/
CloudApi cloudIpv4Destroy DELETE /api/cloud/ipv4/{id}/
CloudApi cloudIpv4Destroy2 DELETE /api/v1/cloud/ipv4/{id}/
CloudApi cloudIpv4DetachCreate POST /api/cloud/ipv4/{id}/detach/
CloudApi cloudIpv4DetachCreate2 POST /api/v1/cloud/ipv4/{id}/detach/
CloudApi cloudIpv4List GET /api/cloud/ipv4/
CloudApi cloudIpv4List2 GET /api/v1/cloud/ipv4/
CloudApi cloudIpv4RdnsCreate POST /api/cloud/ipv4/{id}/rdns/
CloudApi cloudIpv4RdnsCreate2 POST /api/v1/cloud/ipv4/{id}/rdns/
CloudApi cloudIpv4RdnsRetrieve GET /api/cloud/ipv4/{id}/rdns/
CloudApi cloudIpv4RdnsRetrieve2 GET /api/v1/cloud/ipv4/{id}/rdns/
CloudApi cloudIpv4Retrieve GET /api/cloud/ipv4/{id}/
CloudApi cloudIpv4Retrieve2 GET /api/v1/cloud/ipv4/{id}/
CloudApi cloudIpv6Create POST /api/cloud/ipv6/
CloudApi cloudIpv6Create2 POST /api/v1/cloud/ipv6/
CloudApi cloudIpv6Destroy DELETE /api/cloud/ipv6/{id}/
CloudApi cloudIpv6Destroy2 DELETE /api/v1/cloud/ipv6/{id}/
CloudApi cloudIpv6DetachCreate POST /api/cloud/ipv6/{id}/detach/
CloudApi cloudIpv6DetachCreate2 POST /api/v1/cloud/ipv6/{id}/detach/
CloudApi cloudIpv6List GET /api/cloud/ipv6/
CloudApi cloudIpv6List2 GET /api/v1/cloud/ipv6/
CloudApi cloudIpv6RdnsCreate POST /api/cloud/ipv6/{id}/rdns/
CloudApi cloudIpv6RdnsCreate2 POST /api/v1/cloud/ipv6/{id}/rdns/
CloudApi cloudIpv6RdnsRetrieve GET /api/cloud/ipv6/{id}/rdns/
CloudApi cloudIpv6RdnsRetrieve2 GET /api/v1/cloud/ipv6/{id}/rdns/
CloudApi cloudIpv6Retrieve GET /api/cloud/ipv6/{id}/
CloudApi cloudIpv6Retrieve2 GET /api/v1/cloud/ipv6/{id}/
CloudApi cloudPrivateNetworksAddServerCreate POST /api/cloud/private-networks/{id}/add-server/
CloudApi cloudPrivateNetworksAddServerCreate2 POST /api/v1/cloud/private-networks/{id}/add-server/
CloudApi cloudPrivateNetworksCreate POST /api/cloud/private-networks/
CloudApi cloudPrivateNetworksCreate2 POST /api/v1/cloud/private-networks/
CloudApi cloudPrivateNetworksDestroy DELETE /api/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksDestroy2 DELETE /api/v1/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksList GET /api/cloud/private-networks/
CloudApi cloudPrivateNetworksList2 GET /api/v1/cloud/private-networks/
CloudApi cloudPrivateNetworksPartialUpdate PATCH /api/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksPartialUpdate2 PATCH /api/v1/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksRemoveServerCreate POST /api/cloud/private-networks/{id}/remove-server/
CloudApi cloudPrivateNetworksRemoveServerCreate2 POST /api/v1/cloud/private-networks/{id}/remove-server/
CloudApi cloudPrivateNetworksRetrieve GET /api/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksRetrieve2 GET /api/v1/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksUpdate PUT /api/cloud/private-networks/{id}/
CloudApi cloudPrivateNetworksUpdate2 PUT /api/v1/cloud/private-networks/{id}/
CloudApi cloudServerPackagesList GET /api/cloud/server-packages/
CloudApi cloudServerPackagesList2 GET /api/v1/cloud/server-packages/
CloudApi cloudServerPackagesRetrieve GET /api/cloud/server-packages/{id}/
CloudApi cloudServerPackagesRetrieve2 GET /api/v1/cloud/server-packages/{id}/
CloudApi cloudServersActivityRetrieve GET /api/cloud/servers/{id}/activity/
CloudApi cloudServersActivityRetrieve2 GET /api/v1/cloud/servers/{id}/activity/
CloudApi cloudServersAttachIpv4Create POST /api/cloud/servers/{id}/attach-ipv4/
CloudApi cloudServersAttachIpv4Create2 POST /api/v1/cloud/servers/{id}/attach-ipv4/
CloudApi cloudServersAttachIpv6Create POST /api/cloud/servers/{id}/attach-ipv6/
CloudApi cloudServersAttachIpv6Create2 POST /api/v1/cloud/servers/{id}/attach-ipv6/
CloudApi cloudServersConsoleCreate POST /api/cloud/servers/{id}/console/
CloudApi cloudServersConsoleCreate2 POST /api/v1/cloud/servers/{id}/console/
CloudApi cloudServersCreate POST /api/cloud/servers/
CloudApi cloudServersCreate2 POST /api/v1/cloud/servers/
CloudApi cloudServersDestroy DELETE /api/cloud/servers/{id}/
CloudApi cloudServersDestroy2 DELETE /api/v1/cloud/servers/{id}/
CloudApi cloudServersDestroyProtectionCreate POST /api/cloud/servers/{id}/destroy-protection/
CloudApi cloudServersDestroyProtectionCreate2 POST /api/v1/cloud/servers/{id}/destroy-protection/
CloudApi cloudServersDetachIpv4Create POST /api/cloud/servers/{id}/detach-ipv4/
CloudApi cloudServersDetachIpv4Create2 POST /api/v1/cloud/servers/{id}/detach-ipv4/
CloudApi cloudServersDetachIpv6Create POST /api/cloud/servers/{id}/detach-ipv6/
CloudApi cloudServersDetachIpv6Create2 POST /api/v1/cloud/servers/{id}/detach-ipv6/
CloudApi cloudServersList GET /api/cloud/servers/
CloudApi cloudServersList2 GET /api/v1/cloud/servers/
CloudApi cloudServersModifyPackageCreate POST /api/cloud/servers/{id}/modify-package/
CloudApi cloudServersModifyPackageCreate2 POST /api/v1/cloud/servers/{id}/modify-package/
CloudApi cloudServersPartialUpdate PATCH /api/cloud/servers/{id}/
CloudApi cloudServersPartialUpdate2 PATCH /api/v1/cloud/servers/{id}/
CloudApi cloudServersPowerManagementCreate POST /api/cloud/servers/{id}/power-management/
CloudApi cloudServersPowerManagementCreate2 POST /api/v1/cloud/servers/{id}/power-management/
CloudApi cloudServersPowerManagementRetrieve GET /api/cloud/servers/{id}/power-management/
CloudApi cloudServersPowerManagementRetrieve2 GET /api/v1/cloud/servers/{id}/power-management/
CloudApi cloudServersPublicInterfaceCreate POST /api/cloud/servers/{id}/public-interface/
CloudApi cloudServersPublicInterfaceCreate2 POST /api/v1/cloud/servers/{id}/public-interface/
CloudApi cloudServersPublicInterfaceDestroy DELETE /api/cloud/servers/{id}/public-interface/
CloudApi cloudServersPublicInterfaceDestroy2 DELETE /api/v1/cloud/servers/{id}/public-interface/
CloudApi cloudServersPublicInterfaceRetrieve GET /api/cloud/servers/{id}/public-interface/
CloudApi cloudServersPublicInterfaceRetrieve2 GET /api/v1/cloud/servers/{id}/public-interface/
CloudApi cloudServersRetrieve GET /api/cloud/servers/{id}/
CloudApi cloudServersRetrieve2 GET /api/v1/cloud/servers/{id}/
CloudApi cloudServersRetryProvisionCreate POST /api/cloud/servers/{id}/retry-provision/
CloudApi cloudServersRetryProvisionCreate2 POST /api/v1/cloud/servers/{id}/retry-provision/
CloudApi cloudServersSnapshotsCreate POST /api/cloud/servers/{id}/snapshots/
CloudApi cloudServersSnapshotsCreate2 POST /api/v1/cloud/servers/{id}/snapshots/
CloudApi cloudServersSnapshotsDestroy DELETE /api/cloud/servers/{id}/snapshots/{snapshot_name}/
CloudApi cloudServersSnapshotsDestroy2 DELETE /api/v1/cloud/servers/{id}/snapshots/{snapshot_name}/
CloudApi cloudServersSnapshotsList GET /api/cloud/servers/{id}/snapshots/
CloudApi cloudServersSnapshotsList2 GET /api/v1/cloud/servers/{id}/snapshots/
CloudApi cloudServersSnapshotsRollbackCreate POST /api/cloud/servers/{id}/snapshots/{snapshot_name}/rollback/
CloudApi cloudServersSnapshotsRollbackCreate2 POST /api/v1/cloud/servers/{id}/snapshots/{snapshot_name}/rollback/
CloudApi cloudServersUpdate PUT /api/cloud/servers/{id}/
CloudApi cloudServersUpdate2 PUT /api/v1/cloud/servers/{id}/
CloudApi cloudServersUsageRetrieve GET /api/cloud/servers/{id}/usage/
CloudApi cloudServersUsageRetrieve2 GET /api/v1/cloud/servers/{id}/usage/
CloudApi cloudServersVolumesCreate POST /api/cloud/servers/{server_id}/volumes/
CloudApi cloudServersVolumesCreate2 POST /api/v1/cloud/servers/{server_id}/volumes/
CloudApi cloudServersVolumesDestroy DELETE /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesDestroy2 DELETE /api/v1/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesList GET /api/cloud/servers/{server_id}/volumes/
CloudApi cloudServersVolumesList2 GET /api/v1/cloud/servers/{server_id}/volumes/
CloudApi cloudServersVolumesPartialUpdate PATCH /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesPartialUpdate2 PATCH /api/v1/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesRetrieve GET /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesRetrieve2 GET /api/v1/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesUpdate PUT /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudServersVolumesUpdate2 PUT /api/v1/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloudStorageProductsList GET /api/cloud/storage-products/
CloudApi cloudStorageProductsList2 GET /api/v1/cloud/storage-products/
CloudApi cloudStorageProductsRetrieve GET /api/cloud/storage-products/{id}/
CloudApi cloudStorageProductsRetrieve2 GET /api/v1/cloud/storage-products/{id}/
CloudApi cloudVolumesAttachCreate POST /api/cloud/volumes/{id}/attach/
CloudApi cloudVolumesAttachCreate2 POST /api/v1/cloud/volumes/{id}/attach/
CloudApi cloudVolumesDestroy DELETE /api/cloud/volumes/{id}/
CloudApi cloudVolumesDestroy2 DELETE /api/v1/cloud/volumes/{id}/
CloudApi cloudVolumesDetachCreate POST /api/cloud/volumes/{id}/detach/
CloudApi cloudVolumesDetachCreate2 POST /api/v1/cloud/volumes/{id}/detach/
CloudApi cloudVolumesList GET /api/cloud/volumes/
CloudApi cloudVolumesList2 GET /api/v1/cloud/volumes/
CloudApi cloudVolumesPartialUpdate PATCH /api/cloud/volumes/{id}/
CloudApi cloudVolumesPartialUpdate2 PATCH /api/v1/cloud/volumes/{id}/
CloudApi cloudVolumesRetrieve GET /api/cloud/volumes/{id}/
CloudApi cloudVolumesRetrieve2 GET /api/v1/cloud/volumes/{id}/
CloudApi cloudVolumesUpdate PUT /api/cloud/volumes/{id}/
CloudApi cloudVolumesUpdate2 PUT /api/v1/cloud/volumes/{id}/
DedicatedApi dedicatedServersList GET /api/dedicated/servers/
DedicatedApi dedicatedServersList2 GET /api/v1/dedicated/servers/
DedicatedApi dedicatedServersPowerCreate POST /api/dedicated/servers/{id}/power/
DedicatedApi dedicatedServersPowerCreate2 POST /api/v1/dedicated/servers/{id}/power/
DedicatedApi dedicatedServersRdnsCreate POST /api/dedicated/servers/{id}/rdns/
DedicatedApi dedicatedServersRdnsCreate2 POST /api/v1/dedicated/servers/{id}/rdns/
DedicatedApi dedicatedServersReinstallCreate POST /api/dedicated/servers/{id}/reinstall/
DedicatedApi dedicatedServersReinstallCreate2 POST /api/v1/dedicated/servers/{id}/reinstall/
DedicatedApi dedicatedServersRetrieve GET /api/dedicated/servers/{id}/
DedicatedApi dedicatedServersRetrieve2 GET /api/v1/dedicated/servers/{id}/
DomainApi domainDomainCancelCreate POST /api/domain/domain/{domain}/cancel/
DomainApi domainDomainCancelCreate2 POST /api/v1/domain/domain/{domain}/cancel/
DomainApi domainDomainCheckAvailabilityCreate POST /api/domain/domain/check-availability/
DomainApi domainDomainCheckAvailabilityCreate2 POST /api/v1/domain/domain/check-availability/
DomainApi domainDomainContactsCreate POST /api/domain/domain/{domain}/contacts/
DomainApi domainDomainContactsCreate2 POST /api/v1/domain/domain/{domain}/contacts/
DomainApi domainDomainCreate POST /api/domain/domain/
DomainApi domainDomainCreate2 POST /api/v1/domain/domain/
DomainApi domainDomainList GET /api/domain/domain/
DomainApi domainDomainList2 GET /api/v1/domain/domain/
DomainApi domainDomainNameserversCreate POST /api/domain/domain/{domain}/nameservers/
DomainApi domainDomainNameserversCreate2 POST /api/v1/domain/domain/{domain}/nameservers/
DomainApi domainDomainPartialUpdate PATCH /api/domain/domain/{domain}/
DomainApi domainDomainPartialUpdate2 PATCH /api/v1/domain/domain/{domain}/
DomainApi domainDomainRenewCreate POST /api/domain/domain/{domain}/renew/
DomainApi domainDomainRenewCreate2 POST /api/v1/domain/domain/{domain}/renew/
DomainApi domainDomainRetrieve GET /api/domain/domain/{domain}/
DomainApi domainDomainRetrieve2 GET /api/v1/domain/domain/{domain}/
DomainApi domainDomainTransferRoDomainCreate POST /api/domain/domain/transfer-ro-domain/
DomainApi domainDomainTransferRoDomainCreate2 POST /api/v1/domain/domain/transfer-ro-domain/
DomainApi domainDomainUpdate PUT /api/domain/domain/{domain}/
DomainApi domainDomainUpdate2 PUT /api/v1/domain/domain/{domain}/
DomainApi domainRegistrantsCreate POST /api/domain/registrants/
DomainApi domainRegistrantsCreate2 POST /api/v1/domain/registrants/
DomainApi domainRegistrantsDestroy DELETE /api/domain/registrants/{id}/
DomainApi domainRegistrantsDestroy2 DELETE /api/v1/domain/registrants/{id}/
DomainApi domainRegistrantsList GET /api/domain/registrants/
DomainApi domainRegistrantsList2 GET /api/v1/domain/registrants/
DomainApi domainRegistrantsPartialUpdate PATCH /api/domain/registrants/{id}/
DomainApi domainRegistrantsPartialUpdate2 PATCH /api/v1/domain/registrants/{id}/
DomainApi domainRegistrantsRetrieve GET /api/domain/registrants/{id}/
DomainApi domainRegistrantsRetrieve2 GET /api/v1/domain/registrants/{id}/
DomainApi domainRegistrantsUpdate PUT /api/domain/registrants/{id}/
DomainApi domainRegistrantsUpdate2 PUT /api/v1/domain/registrants/{id}/
DomainApi domainTldList GET /api/domain/tld/
DomainApi domainTldList2 GET /api/v1/domain/tld/
DomainApi domainTldRetrieve GET /api/domain/tld/{id}/
DomainApi domainTldRetrieve2 GET /api/v1/domain/tld/{id}/
FreednsApi freednsDnsActivateCreate POST /api/freedns/dns/activate/
FreednsApi freednsDnsActivateCreate2 POST /api/v1/freedns/dns/activate/
FreednsApi freednsDnsAddRecordCreate POST /api/freedns/dns/add-record/
FreednsApi freednsDnsAddRecordCreate2 POST /api/v1/freedns/dns/add-record/
FreednsApi freednsDnsDeactivateCreate POST /api/freedns/dns/deactivate/
FreednsApi freednsDnsDeactivateCreate2 POST /api/v1/freedns/dns/deactivate/
FreednsApi freednsDnsDeleteRecordCreate POST /api/freedns/dns/delete-record/
FreednsApi freednsDnsDeleteRecordCreate2 POST /api/v1/freedns/dns/delete-record/
FreednsApi freednsDnsList GET /api/freedns/dns/
FreednsApi freednsDnsList2 GET /api/v1/freedns/dns/
FreednsApi freednsDnsRecordsList GET /api/freedns/dns/records/
FreednsApi freednsDnsRecordsList2 GET /api/v1/freedns/dns/records/
HostingApi hostingHostingChangePasswordCreate POST /api/hosting/hosting/{id}/change-password/
HostingApi hostingHostingChangePasswordCreate2 POST /api/v1/hosting/hosting/{id}/change-password/
HostingApi hostingHostingList GET /api/hosting/hosting/
HostingApi hostingHostingList2 GET /api/v1/hosting/hosting/
HostingApi hostingHostingRetrieve GET /api/hosting/hosting/{id}/
HostingApi hostingHostingRetrieve2 GET /api/v1/hosting/hosting/{id}/
KubernetesApi kubernetesClusterTypesList GET /api/kubernetes/cluster-types/
KubernetesApi kubernetesClusterTypesList2 GET /api/v1/kubernetes/cluster-types/
KubernetesApi kubernetesClustersConnectVmCreate POST /api/kubernetes/clusters/{id}/connect-vm/
KubernetesApi kubernetesClustersConnectVmCreate2 POST /api/v1/kubernetes/clusters/{id}/connect-vm/
KubernetesApi kubernetesClustersConnectedVmsRetrieve GET /api/kubernetes/clusters/{id}/connected-vms/
KubernetesApi kubernetesClustersConnectedVmsRetrieve2 GET /api/v1/kubernetes/clusters/{id}/connected-vms/
KubernetesApi kubernetesClustersCreate POST /api/kubernetes/clusters/
KubernetesApi kubernetesClustersCreate2 POST /api/v1/kubernetes/clusters/
KubernetesApi kubernetesClustersDestroy DELETE /api/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersDestroy2 DELETE /api/v1/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersDisconnectVmCreate POST /api/kubernetes/clusters/{id}/disconnect-vm/
KubernetesApi kubernetesClustersDisconnectVmCreate2 POST /api/v1/kubernetes/clusters/{id}/disconnect-vm/
KubernetesApi kubernetesClustersEligibleVmsRetrieve GET /api/kubernetes/clusters/{id}/eligible-vms/
KubernetesApi kubernetesClustersEligibleVmsRetrieve2 GET /api/v1/kubernetes/clusters/{id}/eligible-vms/
KubernetesApi kubernetesClustersHttproutesCreate POST /api/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi kubernetesClustersHttproutesCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi kubernetesClustersHttproutesDestroy DELETE /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersHttproutesDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersHttproutesPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersHttproutesPartialUpdate2 PATCH /api/v1/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 kubernetesClustersHttproutesRetrieve3 GET /api/v1/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi kubernetesClustersHttproutesRetrieve4 GET /api/v1/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersHttproutesUpdate PUT /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersHttproutesUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetesClustersKubeVersionUpgradeCreate POST /api/kubernetes/clusters/{id}/kube-version-upgrade/
KubernetesApi kubernetesClustersKubeVersionUpgradeCreate2 POST /api/v1/kubernetes/clusters/{id}/kube-version-upgrade/
KubernetesApi kubernetesClustersKubeconfigCreate POST /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetesClustersKubeconfigCreate2 POST /api/v1/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetesClustersKubeconfigRetrieve GET /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetesClustersKubeconfigRetrieve2 GET /api/v1/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetesClustersLbFirewallCreate POST /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetesClustersLbFirewallCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetesClustersLbFirewallDestroy DELETE /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallList GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetesClustersLbFirewallList2 GET /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetesClustersLbFirewallPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallPartialUpdate2 PATCH /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallRetrieve GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallRetrieve2 GET /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallUpdate PUT /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersLbFirewallUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetesClustersList GET /api/kubernetes/clusters/
KubernetesApi kubernetesClustersList2 GET /api/v1/kubernetes/clusters/
KubernetesApi kubernetesClustersPartialUpdate PATCH /api/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersPartialUpdate2 PATCH /api/v1/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersPortForwardsCreate POST /api/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi kubernetesClustersPortForwardsCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi kubernetesClustersPortForwardsDestroy DELETE /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersPortForwardsDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersPortForwardsPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersPortForwardsPartialUpdate2 PATCH /api/v1/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 kubernetesClustersPortForwardsRetrieve3 GET /api/v1/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi kubernetesClustersPortForwardsRetrieve4 GET /api/v1/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersPortForwardsUpdate PUT /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersPortForwardsUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetesClustersResourcePoolsCreate POST /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetesClustersResourcePoolsCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetesClustersResourcePoolsDestroy DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsList GET /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetesClustersResourcePoolsList2 GET /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetesClustersResourcePoolsNodesDestroy DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi kubernetesClustersResourcePoolsNodesDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi kubernetesClustersResourcePoolsNodesList GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/
KubernetesApi kubernetesClustersResourcePoolsNodesList2 GET /api/v1/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 kubernetesClustersResourcePoolsNodesMetricsRetrieve2 GET /api/v1/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 kubernetesClustersResourcePoolsNodesRetrieve2 GET /api/v1/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 kubernetesClustersResourcePoolsNodesRrdRetrieve2 GET /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/rrd/
KubernetesApi kubernetesClustersResourcePoolsPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsPartialUpdate2 PATCH /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsRetrieve GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsRetrieve2 GET /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsUpdate PUT /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersResourcePoolsUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetesClustersRetrieve GET /api/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersRetrieve2 GET /api/v1/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersTalosVersionUpgradeCreate POST /api/kubernetes/clusters/{id}/talos-version-upgrade/
KubernetesApi kubernetesClustersTalosVersionUpgradeCreate2 POST /api/v1/kubernetes/clusters/{id}/talos-version-upgrade/
KubernetesApi kubernetesClustersTcproutesCreate POST /api/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi kubernetesClustersTcproutesCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi kubernetesClustersTcproutesDestroy DELETE /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersTcproutesDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersTcproutesPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersTcproutesPartialUpdate2 PATCH /api/v1/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 kubernetesClustersTcproutesRetrieve3 GET /api/v1/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi kubernetesClustersTcproutesRetrieve4 GET /api/v1/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersTcproutesUpdate PUT /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersTcproutesUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetesClustersToggleCloudVmAccessCreate POST /api/kubernetes/clusters/{id}/toggle-cloud-vm-access/
KubernetesApi kubernetesClustersToggleCloudVmAccessCreate2 POST /api/v1/kubernetes/clusters/{id}/toggle-cloud-vm-access/
KubernetesApi kubernetesClustersUdproutesCreate POST /api/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi kubernetesClustersUdproutesCreate2 POST /api/v1/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi kubernetesClustersUdproutesDestroy DELETE /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUdproutesDestroy2 DELETE /api/v1/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUdproutesPartialUpdate PATCH /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUdproutesPartialUpdate2 PATCH /api/v1/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 kubernetesClustersUdproutesRetrieve3 GET /api/v1/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi kubernetesClustersUdproutesRetrieve4 GET /api/v1/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUdproutesUpdate PUT /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUdproutesUpdate2 PUT /api/v1/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetesClustersUpdate PUT /api/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersUpdate2 PUT /api/v1/kubernetes/clusters/{id}/
KubernetesApi kubernetesClustersUpgradeFeatureCreate POST /api/kubernetes/clusters/{id}/upgrade-feature/
KubernetesApi kubernetesClustersUpgradeFeatureCreate2 POST /api/v1/kubernetes/clusters/{id}/upgrade-feature/
SchemaApi schemaRetrieve GET /api/schema/
SchemaApi schemaRetrieve2 GET /api/v1/schema/
SupportApi supportDepartmentsList GET /api/support/departments/
SupportApi supportDepartmentsList2 GET /api/v1/support/departments/
SupportApi supportTicketsCloseCreate POST /api/support/tickets/{id}/close/
SupportApi supportTicketsCloseCreate2 POST /api/v1/support/tickets/{id}/close/
SupportApi supportTicketsCreate POST /api/support/tickets/
SupportApi supportTicketsCreate2 POST /api/v1/support/tickets/
SupportApi supportTicketsList GET /api/support/tickets/
SupportApi supportTicketsList2 GET /api/v1/support/tickets/
SupportApi supportTicketsMessagesAttachmentRetrieve GET /api/support/tickets/{id}/messages/{message_id}/attachment/
SupportApi supportTicketsMessagesAttachmentRetrieve2 GET /api/v1/support/tickets/{id}/messages/{message_id}/attachment/
SupportApi supportTicketsReopenCreate POST /api/support/tickets/{id}/reopen/
SupportApi supportTicketsReopenCreate2 POST /api/v1/support/tickets/{id}/reopen/
SupportApi supportTicketsReplyCreate POST /api/support/tickets/{id}/reply/
SupportApi supportTicketsReplyCreate2 POST /api/v1/support/tickets/{id}/reply/
SupportApi supportTicketsRetrieve GET /api/support/tickets/{id}/
SupportApi supportTicketsRetrieve2 GET /api/v1/support/tickets/{id}/

Documentation For Models

Documentation For 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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors