@pidginhost/sdk
v0.7.0
Published
OpenAPI client for @pidginhost/sdk
Downloads
391
Maintainers
Readme
@pidginhost/[email protected]
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 buildPublishing
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/[email protected] --saveunPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --saveQuickstart
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 keysclient.auth-- authentication, tokensclient.billing-- invoices, payments, fundsclient.cloud-- servers, images, volumes, IPs, firewalls, networksclient.dedicated-- dedicated serversclient.domain-- domains, registrants, TLDsclient.freedns-- free DNS zones and recordsclient.hosting-- web hostingclient.kubernetes-- clusters, resource pools, routesclient.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 | 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}/ |
Documentation For 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
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
