pidginhost-sdk

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.

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

  • API version: 1.0.0 (v1)
  • Package version: 0.13.0
  • Generator version: 7.24.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.pidginhost.com

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/pidginhost/sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/pidginhost/sdk-python.git)

Then import the package:

import pidginhost_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import pidginhost_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import pidginhost_sdk
from pidginhost_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://www.pidginhost.com
# See configuration.py for a list of all supported configuration parameters.
configuration = pidginhost_sdk.Configuration(
    host = "https://www.pidginhost.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with pidginhost_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pidginhost_sdk.AccountApi(api_client)
    api_token_create = pidginhost_sdk.APITokenCreate() # APITokenCreate | 

    try:
        api_response = api_instance.account_api_tokens_create(api_token_create)
        print("The response of AccountApi->account_api_tokens_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->account_api_tokens_create: %s\n" % e)

Quickstart

from pidginhost_sdk.client import PidginHost

client = PidginHost("your-api-token")

# List all servers (paginated: pass page=N for further pages)
page = client.cloud.cloud_servers_list()
for server in page.results:
    print(server.hostname)

# List SSH keys
keys = client.account.account_ssh_keys_list()

# List available images
images = client.cloud.cloud_images_list()

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 account_api_tokens_create POST /api/account/api-tokens/
AccountApi account_api_tokens_destroy DELETE /api/account/api-tokens/{id}/
AccountApi account_api_tokens_list GET /api/account/api-tokens/
AccountApi account_companies_create POST /api/account/companies/
AccountApi account_companies_destroy DELETE /api/account/companies/{id}/
AccountApi account_companies_list GET /api/account/companies/
AccountApi account_companies_partial_update PATCH /api/account/companies/{id}/
AccountApi account_companies_retrieve GET /api/account/companies/{id}/
AccountApi account_companies_update PUT /api/account/companies/{id}/
AccountApi account_emails_list GET /api/account/emails/
AccountApi account_profile_partial_update PATCH /api/account/profile
AccountApi account_profile_retrieve GET /api/account/profile
AccountApi account_profile_update PUT /api/account/profile
AccountApi account_ssh_keys_create POST /api/account/ssh-keys/
AccountApi account_ssh_keys_destroy DELETE /api/account/ssh-keys/{id}/
AccountApi account_ssh_keys_list GET /api/account/ssh-keys/
AccountApi account_ssh_keys_partial_update PATCH /api/account/ssh-keys/{id}/
AccountApi account_ssh_keys_retrieve GET /api/account/ssh-keys/{id}/
AccountApi account_ssh_keys_update PUT /api/account/ssh-keys/{id}/
AuthApi auth_cli_session_create POST /api/auth/cli-session/
AuthApi auth_cli_session_retrieve GET /api/auth/cli-session/{session_id}/
BillingApi billing_deposits_create POST /api/billing/deposits/
BillingApi billing_deposits_list GET /api/billing/deposits/
BillingApi billing_deposits_retrieve GET /api/billing/deposits/{id}/
BillingApi billing_funds_list GET /api/billing/funds/
BillingApi billing_funds_log_list GET /api/billing/funds-log/
BillingApi billing_funds_notification_settings_create POST /api/billing/funds/notification-settings/
BillingApi billing_invoices_list GET /api/billing/invoices/
BillingApi billing_invoices_pay_with_funds_create POST /api/billing/invoices/{id}/pay-with-funds/
BillingApi billing_invoices_pdf_retrieve GET /api/billing/invoices/{id}/pdf/
BillingApi billing_invoices_retrieve GET /api/billing/invoices/{id}/
BillingApi billing_services_cancel_create POST /api/billing/services/{id}/cancel/
BillingApi billing_services_change_billing_cycle_create POST /api/billing/services/{id}/change-billing-cycle/
BillingApi billing_services_change_company_create POST /api/billing/services/{id}/change-company/
BillingApi billing_services_list GET /api/billing/services/
BillingApi billing_services_retrieve GET /api/billing/services/{id}/
BillingApi billing_services_toggle_auto_payment_create POST /api/billing/services/{id}/toggle-auto-payment/
BillingApi billing_subscriptions_list GET /api/billing/subscriptions/
BillingApi billing_subscriptions_retrieve GET /api/billing/subscriptions/{id}/
CloudApi cloud_buckets_create POST /api/cloud/buckets/
CloudApi cloud_buckets_credentials_reveal_create POST /api/cloud/buckets/{id}/credentials/reveal/
CloudApi cloud_buckets_credentials_rotate_create POST /api/cloud/buckets/{id}/credentials/rotate/
CloudApi cloud_buckets_destroy DELETE /api/cloud/buckets/{id}/
CloudApi cloud_buckets_list GET /api/cloud/buckets/
CloudApi cloud_buckets_resize_create POST /api/cloud/buckets/{id}/resize/
CloudApi cloud_buckets_retrieve GET /api/cloud/buckets/{id}/
CloudApi cloud_buckets_visibility_create POST /api/cloud/buckets/{id}/visibility/
CloudApi cloud_firewall_rules_set_create POST /api/cloud/firewall-rules-set/
CloudApi cloud_firewall_rules_set_destroy DELETE /api/cloud/firewall-rules-set/{id}/
CloudApi cloud_firewall_rules_set_list GET /api/cloud/firewall-rules-set/
CloudApi cloud_firewall_rules_set_partial_update PATCH /api/cloud/firewall-rules-set/{id}/
CloudApi cloud_firewall_rules_set_retrieve GET /api/cloud/firewall-rules-set/{id}/
CloudApi cloud_firewall_rules_set_rules_create POST /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloud_firewall_rules_set_rules_destroy DELETE /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloud_firewall_rules_set_rules_list GET /api/cloud/firewall-rules-set/{rules_set_id}/rules/
CloudApi cloud_firewall_rules_set_rules_partial_update PATCH /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloud_firewall_rules_set_rules_retrieve GET /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloud_firewall_rules_set_rules_update PUT /api/cloud/firewall-rules-set/{rules_set_id}/rules/{rule_id}/
CloudApi cloud_firewall_rules_set_update PUT /api/cloud/firewall-rules-set/{id}/
CloudApi cloud_floating_ipv4_authorizations_list GET /api/cloud/floating-ipv4/{id}/authorizations/
CloudApi cloud_floating_ipv4_authorize_create POST /api/cloud/floating-ipv4/{id}/authorize/
CloudApi cloud_floating_ipv4_create POST /api/cloud/floating-ipv4/
CloudApi cloud_floating_ipv4_destroy DELETE /api/cloud/floating-ipv4/{id}/
CloudApi cloud_floating_ipv4_list GET /api/cloud/floating-ipv4/
CloudApi cloud_floating_ipv4_rdns_create POST /api/cloud/floating-ipv4/{id}/rdns/
CloudApi cloud_floating_ipv4_rdns_retrieve GET /api/cloud/floating-ipv4/{id}/rdns/
CloudApi cloud_floating_ipv4_retrieve GET /api/cloud/floating-ipv4/{id}/
CloudApi cloud_floating_ipv4_unauthorize_create POST /api/cloud/floating-ipv4/{id}/unauthorize/
CloudApi cloud_floating_ipv6_authorizations_list GET /api/cloud/floating-ipv6/{id}/authorizations/
CloudApi cloud_floating_ipv6_authorize_create POST /api/cloud/floating-ipv6/{id}/authorize/
CloudApi cloud_floating_ipv6_create POST /api/cloud/floating-ipv6/
CloudApi cloud_floating_ipv6_destroy DELETE /api/cloud/floating-ipv6/{id}/
CloudApi cloud_floating_ipv6_list GET /api/cloud/floating-ipv6/
CloudApi cloud_floating_ipv6_rdns_create POST /api/cloud/floating-ipv6/{id}/rdns/
CloudApi cloud_floating_ipv6_rdns_retrieve GET /api/cloud/floating-ipv6/{id}/rdns/
CloudApi cloud_floating_ipv6_retrieve GET /api/cloud/floating-ipv6/{id}/
CloudApi cloud_floating_ipv6_unauthorize_create POST /api/cloud/floating-ipv6/{id}/unauthorize/
CloudApi cloud_generations_list GET /api/cloud/generations/ List hardware generations
CloudApi cloud_generations_retrieve GET /api/cloud/generations/{slug}/
CloudApi cloud_images_list GET /api/cloud/images/
CloudApi cloud_images_retrieve GET /api/cloud/images/{id}/
CloudApi cloud_ipv4_create POST /api/cloud/ipv4/
CloudApi cloud_ipv4_destroy DELETE /api/cloud/ipv4/{id}/
CloudApi cloud_ipv4_detach_create POST /api/cloud/ipv4/{id}/detach/
CloudApi cloud_ipv4_list GET /api/cloud/ipv4/
CloudApi cloud_ipv4_rdns_create POST /api/cloud/ipv4/{id}/rdns/
CloudApi cloud_ipv4_rdns_retrieve GET /api/cloud/ipv4/{id}/rdns/
CloudApi cloud_ipv4_retrieve GET /api/cloud/ipv4/{id}/
CloudApi cloud_ipv6_create POST /api/cloud/ipv6/
CloudApi cloud_ipv6_destroy DELETE /api/cloud/ipv6/{id}/
CloudApi cloud_ipv6_detach_create POST /api/cloud/ipv6/{id}/detach/
CloudApi cloud_ipv6_list GET /api/cloud/ipv6/
CloudApi cloud_ipv6_rdns_create POST /api/cloud/ipv6/{id}/rdns/
CloudApi cloud_ipv6_rdns_retrieve GET /api/cloud/ipv6/{id}/rdns/
CloudApi cloud_ipv6_retrieve GET /api/cloud/ipv6/{id}/
CloudApi cloud_private_networks_add_server_create POST /api/cloud/private-networks/{id}/add-server/
CloudApi cloud_private_networks_create POST /api/cloud/private-networks/
CloudApi cloud_private_networks_destroy DELETE /api/cloud/private-networks/{id}/
CloudApi cloud_private_networks_list GET /api/cloud/private-networks/
CloudApi cloud_private_networks_partial_update PATCH /api/cloud/private-networks/{id}/
CloudApi cloud_private_networks_remove_server_create POST /api/cloud/private-networks/{id}/remove-server/
CloudApi cloud_private_networks_retrieve GET /api/cloud/private-networks/{id}/
CloudApi cloud_private_networks_update PUT /api/cloud/private-networks/{id}/
CloudApi cloud_server_packages_by_generation_retrieve GET /api/cloud/server-packages/by-generation/
CloudApi cloud_server_packages_list GET /api/cloud/server-packages/
CloudApi cloud_server_packages_retrieve GET /api/cloud/server-packages/{id}/
CloudApi cloud_servers_activity_retrieve GET /api/cloud/servers/{id}/activity/
CloudApi cloud_servers_attach_ipv4_create POST /api/cloud/servers/{id}/attach-ipv4/
CloudApi cloud_servers_attach_ipv6_create POST /api/cloud/servers/{id}/attach-ipv6/
CloudApi cloud_servers_boot_isos_list GET /api/cloud/servers/{id}/boot-isos/
CloudApi cloud_servers_console_create POST /api/cloud/servers/{id}/console/
CloudApi cloud_servers_create POST /api/cloud/servers/
CloudApi cloud_servers_destroy DELETE /api/cloud/servers/{id}/
CloudApi cloud_servers_destroy_protection_create POST /api/cloud/servers/{id}/destroy-protection/
CloudApi cloud_servers_detach_ipv4_create POST /api/cloud/servers/{id}/detach-ipv4/
CloudApi cloud_servers_detach_ipv6_create POST /api/cloud/servers/{id}/detach-ipv6/
CloudApi cloud_servers_list GET /api/cloud/servers/
CloudApi cloud_servers_modify_package_create POST /api/cloud/servers/{id}/modify-package/
CloudApi cloud_servers_partial_update PATCH /api/cloud/servers/{id}/
CloudApi cloud_servers_power_management_create POST /api/cloud/servers/{id}/power-management/
CloudApi cloud_servers_power_management_retrieve GET /api/cloud/servers/{id}/power-management/
CloudApi cloud_servers_public_interface_create POST /api/cloud/servers/{id}/public-interface/
CloudApi cloud_servers_public_interface_destroy DELETE /api/cloud/servers/{id}/public-interface/
CloudApi cloud_servers_public_interface_retrieve GET /api/cloud/servers/{id}/public-interface/
CloudApi cloud_servers_rescue_enter_create POST /api/cloud/servers/{id}/rescue/enter/
CloudApi cloud_servers_rescue_exit_create POST /api/cloud/servers/{id}/rescue/exit/
CloudApi cloud_servers_retrieve GET /api/cloud/servers/{id}/
CloudApi cloud_servers_retry_provision_create POST /api/cloud/servers/{id}/retry-provision/
CloudApi cloud_servers_snapshots_create POST /api/cloud/servers/{id}/snapshots/
CloudApi cloud_servers_snapshots_destroy DELETE /api/cloud/servers/{id}/snapshots/{snapshot_name}/
CloudApi cloud_servers_snapshots_list GET /api/cloud/servers/{id}/snapshots/
CloudApi cloud_servers_snapshots_rollback_create POST /api/cloud/servers/{id}/snapshots/{snapshot_name}/rollback/
CloudApi cloud_servers_update PUT /api/cloud/servers/{id}/
CloudApi cloud_servers_usage_retrieve GET /api/cloud/servers/{id}/usage/
CloudApi cloud_servers_volumes_create POST /api/cloud/servers/{server_id}/volumes/
CloudApi cloud_servers_volumes_destroy DELETE /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloud_servers_volumes_list GET /api/cloud/servers/{server_id}/volumes/
CloudApi cloud_servers_volumes_partial_update PATCH /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloud_servers_volumes_retrieve GET /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloud_servers_volumes_update PUT /api/cloud/servers/{server_id}/volumes/{volume_id}/
CloudApi cloud_storage_products_list GET /api/cloud/storage-products/
CloudApi cloud_storage_products_retrieve GET /api/cloud/storage-products/{id}/
CloudApi cloud_volumes_attach_create POST /api/cloud/volumes/{id}/attach/
CloudApi cloud_volumes_destroy DELETE /api/cloud/volumes/{id}/
CloudApi cloud_volumes_detach_create POST /api/cloud/volumes/{id}/detach/
CloudApi cloud_volumes_list GET /api/cloud/volumes/
CloudApi cloud_volumes_partial_update PATCH /api/cloud/volumes/{id}/
CloudApi cloud_volumes_retrieve GET /api/cloud/volumes/{id}/
CloudApi cloud_volumes_update PUT /api/cloud/volumes/{id}/
DedicatedApi dedicated_servers_list GET /api/dedicated/servers/
DedicatedApi dedicated_servers_power_create POST /api/dedicated/servers/{id}/power/
DedicatedApi dedicated_servers_rdns_create POST /api/dedicated/servers/{id}/rdns/
DedicatedApi dedicated_servers_reinstall_create POST /api/dedicated/servers/{id}/reinstall/
DedicatedApi dedicated_servers_retrieve GET /api/dedicated/servers/{id}/
DomainApi domain_domain_cancel_create POST /api/domain/domain/{domain}/cancel/
DomainApi domain_domain_check_availability_create POST /api/domain/domain/check-availability/
DomainApi domain_domain_contacts_create POST /api/domain/domain/{domain}/contacts/
DomainApi domain_domain_create POST /api/domain/domain/
DomainApi domain_domain_dns_create POST /api/domain/domain/{domain}/dns/
DomainApi domain_domain_dns_destroy DELETE /api/domain/domain/{domain}/dns/{name}/
DomainApi domain_domain_dns_list GET /api/domain/domain/{domain}/dns/
DomainApi domain_domain_list GET /api/domain/domain/
DomainApi domain_domain_nameservers_create POST /api/domain/domain/{domain}/nameservers/
DomainApi domain_domain_partial_update PATCH /api/domain/domain/{domain}/
DomainApi domain_domain_renew_create POST /api/domain/domain/{domain}/renew/
DomainApi domain_domain_retrieve GET /api/domain/domain/{domain}/
DomainApi domain_domain_transfer_ro_domain_create POST /api/domain/domain/transfer-ro-domain/
DomainApi domain_domain_update PUT /api/domain/domain/{domain}/
DomainApi domain_registrants_create POST /api/domain/registrants/
DomainApi domain_registrants_destroy DELETE /api/domain/registrants/{id}/
DomainApi domain_registrants_list GET /api/domain/registrants/
DomainApi domain_registrants_partial_update PATCH /api/domain/registrants/{id}/
DomainApi domain_registrants_retrieve GET /api/domain/registrants/{id}/
DomainApi domain_registrants_update PUT /api/domain/registrants/{id}/
DomainApi domain_tld_list GET /api/domain/tld/
DomainApi domain_tld_retrieve GET /api/domain/tld/{id}/
EmailApi email_api_credentials_create POST /api/email/api_credentials/
EmailApi email_api_credentials_destroy DELETE /api/email/api_credentials/{id}/
EmailApi email_api_credentials_list GET /api/email/api_credentials/
EmailApi email_api_credentials_retrieve GET /api/email/api_credentials/{id}/
EmailApi email_domains_create POST /api/email/domains/
EmailApi email_domains_inbound_routes_create POST /api/email/domains/{domain_pk}/inbound_routes/
EmailApi email_domains_inbound_routes_list GET /api/email/domains/{domain_pk}/inbound_routes/
EmailApi email_domains_list GET /api/email/domains/
EmailApi email_domains_retrieve GET /api/email/domains/{id}/
EmailApi email_domains_rotate_dkim_create POST /api/email/domains/{id}/rotate_dkim/
EmailApi email_domains_toggle_inbound_create POST /api/email/domains/{id}/toggle_inbound/
EmailApi email_domains_verify_create POST /api/email/domains/{id}/verify/
EmailApi email_inbound_routes_create POST /api/email/inbound_routes/
EmailApi email_inbound_routes_destroy DELETE /api/email/inbound_routes/{id}/
EmailApi email_inbound_routes_list GET /api/email/inbound_routes/
EmailApi email_inbound_routes_partial_update PATCH /api/email/inbound_routes/{id}/
EmailApi email_inbound_routes_retrieve GET /api/email/inbound_routes/{id}/
EmailApi email_messages_retrieve GET /api/email/messages/{message_id}/
EmailApi email_sandbox_addresses_create POST /api/email/sandbox_addresses/
EmailApi email_sandbox_addresses_destroy DELETE /api/email/sandbox_addresses/{id}/
EmailApi email_sandbox_addresses_list GET /api/email/sandbox_addresses/
EmailApi email_sandbox_addresses_retrieve GET /api/email/sandbox_addresses/{id}/
EmailApi email_send_create POST /api/email/send/
EmailApi email_services_api_credentials_create POST /api/email/services/{service_pk}/api_credentials/
EmailApi email_services_api_credentials_list GET /api/email/services/{service_pk}/api_credentials/
EmailApi email_services_cancel_create POST /api/email/services/{id}/cancel/
EmailApi email_services_change_tier_partial_update PATCH /api/email/services/{id}/change_tier/
EmailApi email_services_create POST /api/email/services/
EmailApi email_services_dedicated_ip_create POST /api/email/services/{id}/dedicated_ip/
EmailApi email_services_dedicated_ip_destroy DELETE /api/email/services/{id}/dedicated_ip/
EmailApi email_services_destroy DELETE /api/email/services/{id}/
EmailApi email_services_domains_create POST /api/email/services/{service_pk}/domains/
EmailApi email_services_domains_list GET /api/email/services/{service_pk}/domains/
EmailApi email_services_list GET /api/email/services/
EmailApi email_services_messages_retrieve GET /api/email/services/{service_pk}/messages/
EmailApi email_services_partial_update PATCH /api/email/services/{id}/
EmailApi email_services_restore_create POST /api/email/services/{id}/restore/
EmailApi email_services_retrieve GET /api/email/services/{id}/
EmailApi email_services_sandbox_addresses_create POST /api/email/services/{service_pk}/sandbox_addresses/
EmailApi email_services_sandbox_addresses_list GET /api/email/services/{service_pk}/sandbox_addresses/
EmailApi email_services_smtp_credentials_create POST /api/email/services/{service_pk}/smtp_credentials/
EmailApi email_services_smtp_credentials_list GET /api/email/services/{service_pk}/smtp_credentials/
EmailApi email_services_stats_retrieve GET /api/email/services/{service_pk}/stats/
EmailApi email_services_suppressions_create POST /api/email/services/{service_pk}/suppressions/
EmailApi email_services_suppressions_list GET /api/email/services/{service_pk}/suppressions/
EmailApi email_smtp_credentials_create POST /api/email/smtp_credentials/
EmailApi email_smtp_credentials_destroy DELETE /api/email/smtp_credentials/{id}/
EmailApi email_smtp_credentials_list GET /api/email/smtp_credentials/
EmailApi email_smtp_credentials_retrieve GET /api/email/smtp_credentials/{id}/
EmailApi email_suppressions_create POST /api/email/suppressions/
EmailApi email_suppressions_destroy DELETE /api/email/suppressions/{id}/
EmailApi email_suppressions_list GET /api/email/suppressions/
EmailApi email_suppressions_retrieve GET /api/email/suppressions/{id}/
FreednsApi freedns_dns_activate_create POST /api/freedns/dns/activate/
FreednsApi freedns_dns_add_record_create POST /api/freedns/dns/add-record/
FreednsApi freedns_dns_deactivate_create POST /api/freedns/dns/deactivate/
FreednsApi freedns_dns_delete_record_create POST /api/freedns/dns/delete-record/
FreednsApi freedns_dns_list GET /api/freedns/dns/
FreednsApi freedns_dns_records_list GET /api/freedns/dns/records/
HostingApi hosting_hosting_change_password_create POST /api/hosting/hosting/{id}/change-password/
HostingApi hosting_hosting_list GET /api/hosting/hosting/
HostingApi hosting_hosting_retrieve GET /api/hosting/hosting/{id}/
KubernetesApi kubernetes_cluster_types_list GET /api/kubernetes/cluster-types/
KubernetesApi kubernetes_clusters_connect_vm_create POST /api/kubernetes/clusters/{id}/connect-vm/
KubernetesApi kubernetes_clusters_connected_vms_retrieve GET /api/kubernetes/clusters/{id}/connected-vms/
KubernetesApi kubernetes_clusters_create POST /api/kubernetes/clusters/
KubernetesApi kubernetes_clusters_destroy DELETE /api/kubernetes/clusters/{id}/
KubernetesApi kubernetes_clusters_disconnect_vm_create POST /api/kubernetes/clusters/{id}/disconnect-vm/
KubernetesApi kubernetes_clusters_eligible_vms_retrieve GET /api/kubernetes/clusters/{id}/eligible-vms/
KubernetesApi kubernetes_clusters_httproutes_create POST /api/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi kubernetes_clusters_httproutes_destroy DELETE /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetes_clusters_httproutes_list GET /api/kubernetes/clusters/{cluster_id}/httproutes/
KubernetesApi kubernetes_clusters_httproutes_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetes_clusters_httproutes_retrieve GET /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetes_clusters_httproutes_update PUT /api/kubernetes/clusters/{cluster_id}/httproutes/{id}/
KubernetesApi kubernetes_clusters_kube_version_upgrade_create POST /api/kubernetes/clusters/{id}/kube-version-upgrade/
KubernetesApi kubernetes_clusters_kubeconfig_create POST /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetes_clusters_kubeconfig_retrieve GET /api/kubernetes/clusters/{id}/kubeconfig/
KubernetesApi kubernetes_clusters_lb_firewall_create POST /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetes_clusters_lb_firewall_destroy DELETE /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetes_clusters_lb_firewall_list GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/
KubernetesApi kubernetes_clusters_lb_firewall_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetes_clusters_lb_firewall_retrieve GET /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetes_clusters_lb_firewall_update PUT /api/kubernetes/clusters/{cluster_id}/lb-firewall/{id}/
KubernetesApi kubernetes_clusters_list GET /api/kubernetes/clusters/
KubernetesApi kubernetes_clusters_partial_update PATCH /api/kubernetes/clusters/{id}/
KubernetesApi kubernetes_clusters_port_forwards_create POST /api/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi kubernetes_clusters_port_forwards_destroy DELETE /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetes_clusters_port_forwards_list GET /api/kubernetes/clusters/{cluster_id}/port-forwards/
KubernetesApi kubernetes_clusters_port_forwards_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetes_clusters_port_forwards_retrieve GET /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetes_clusters_port_forwards_update PUT /api/kubernetes/clusters/{cluster_id}/port-forwards/{id}/
KubernetesApi kubernetes_clusters_resource_pools_create POST /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetes_clusters_resource_pools_destroy DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetes_clusters_resource_pools_list GET /api/kubernetes/clusters/{cluster_id}/resource-pools/
KubernetesApi kubernetes_clusters_resource_pools_nodes_destroy DELETE /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi kubernetes_clusters_resource_pools_nodes_list GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/
KubernetesApi kubernetes_clusters_resource_pools_nodes_metrics_retrieve GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/metrics/
KubernetesApi kubernetes_clusters_resource_pools_nodes_retrieve GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/
KubernetesApi kubernetes_clusters_resource_pools_nodes_rrd_retrieve GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{pool_id}/nodes/{id}/rrd/
KubernetesApi kubernetes_clusters_resource_pools_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetes_clusters_resource_pools_retrieve GET /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetes_clusters_resource_pools_update PUT /api/kubernetes/clusters/{cluster_id}/resource-pools/{id}/
KubernetesApi kubernetes_clusters_retrieve GET /api/kubernetes/clusters/{id}/
KubernetesApi kubernetes_clusters_talos_version_upgrade_create POST /api/kubernetes/clusters/{id}/talos-version-upgrade/
KubernetesApi kubernetes_clusters_tcproutes_create POST /api/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi kubernetes_clusters_tcproutes_destroy DELETE /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetes_clusters_tcproutes_list GET /api/kubernetes/clusters/{cluster_id}/tcproutes/
KubernetesApi kubernetes_clusters_tcproutes_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetes_clusters_tcproutes_retrieve GET /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetes_clusters_tcproutes_update PUT /api/kubernetes/clusters/{cluster_id}/tcproutes/{id}/
KubernetesApi kubernetes_clusters_toggle_cloud_vm_access_create POST /api/kubernetes/clusters/{id}/toggle-cloud-vm-access/
KubernetesApi kubernetes_clusters_udproutes_create POST /api/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi kubernetes_clusters_udproutes_destroy DELETE /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetes_clusters_udproutes_list GET /api/kubernetes/clusters/{cluster_id}/udproutes/
KubernetesApi kubernetes_clusters_udproutes_partial_update PATCH /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetes_clusters_udproutes_retrieve GET /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetes_clusters_udproutes_update PUT /api/kubernetes/clusters/{cluster_id}/udproutes/{id}/
KubernetesApi kubernetes_clusters_update PUT /api/kubernetes/clusters/{id}/
KubernetesApi kubernetes_clusters_upgrade_feature_create POST /api/kubernetes/clusters/{id}/upgrade-feature/
OApi o_register_create POST /o/register
SchemaApi schema_retrieve GET /api/schema/
SupportApi support_departments_list GET /api/support/departments/
SupportApi support_tickets_close_create POST /api/support/tickets/{id}/close/
SupportApi support_tickets_create POST /api/support/tickets/
SupportApi support_tickets_list GET /api/support/tickets/
SupportApi support_tickets_messages_attachment_retrieve GET /api/support/tickets/{id}/messages/{message_id}/attachment/
SupportApi support_tickets_reopen_create POST /api/support/tickets/{id}/reopen/
SupportApi support_tickets_reply_create POST /api/support/tickets/{id}/reply/
SupportApi support_tickets_retrieve GET /api/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

Author

support@pidginhost.com

Project links

Data verified by PyPI on Aug 18, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for cristiboboc from gravatar.com cristiboboc

Credits

Author: PidginHost

GitHub Statistics

Data verified by PyPI on Aug 18, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT

Requires

Python >=3.9

Tags

OpenAPI OpenAPI-Generator Pidgin Host API

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pidginhost_sdk-0.13.0.tar.gz (237.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pidginhost_sdk-0.13.0-py3-none-any.whl (549.1 kB view details)

Uploaded Python 3

File details

Details for the file pidginhost_sdk-0.13.0.tar.gz.

File metadata

  • Download URL: pidginhost_sdk-0.13.0.tar.gz
  • Upload date:
  • Size: 237.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pidginhost_sdk-0.13.0.tar.gz
Algorithm Hash digest
SHA256 87fc82bc6556fe1cb35422f76f9877092ac943ceaf3dfcd3cd41b8022223da68
MD5 b6829ef7736c6ceacf04acfe5f9c6e9f
BLAKE2b-256 53e393e68d438eb67630d8aea5af40784260621d44c8494b8b7d5e329c1fa0c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pidginhost_sdk-0.13.0.tar.gz:

Publisher: publish.yml on pidginhost/sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pidginhost_sdk-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: pidginhost_sdk-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 549.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pidginhost_sdk-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 947bb4d1d44c2bfc438041cbdb6e53a580e336d56ceee0a491c3da62771bef4a
MD5 db55d1bac16e0f2e546f596a662de64a
BLAKE2b-256 2ab4583e2141f8c866da6503bc5713aa27e34d373cfa378886d71de6263101a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pidginhost_sdk-0.13.0-py3-none-any.whl:

Publisher: publish.yml on pidginhost/sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.13.0 This release

2 files

0.12.2

2 files

0.3.0

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page