No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.1.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/szczad/hyperstack-api-python.git(you may need to run pip with root permission: sudo pip install git+https://github.com/szczad/hyperstack-api-python.git)
Then import the package:
import hyperstackInstall 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 hyperstackExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import hyperstack
from hyperstack.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
host = "https://infrahub-api.nexgencloud.com/v1"
)
# 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: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'
# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'
# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hyperstack.CustomerContractApi(api_client)
contract_id = 56 # int |
try:
# Details of Contract by ID for Customer
api_response = api_instance.details_of_contract_by_id_for_customer(contract_id)
print("The response of CustomerContractApi->details_of_contract_by_id_for_customer:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CustomerContractApi->details_of_contract_by_id_for_customer: %s\n" % e)All URIs are relative to https://infrahub-api.nexgencloud.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CustomerContractApi | details_of_contract_by_id_for_customer | GET /pricebook/contracts/{contract_id} | Details of Contract by ID for Customer |
| CustomerContractApi | list_contracts_for_customer | GET /pricebook/contracts | List Contracts for Customer |
| PricebookApi | retrive_pricebook | GET /pricebook | |
| AliveApi | get_alive | GET /billing/alive | GET: Alive |
| ApiKeyApi | generate_api_key | POST /api-key/generate | Generate API Key |
| ApiKeyApi | get_api_key | GET /api-key | Get API Key |
| AssigningMemberRoleApi | assign_rbac_roles | PUT /auth/users/{user_id}/assign-roles | Assign RBAC Roles |
| AssigningMemberRoleApi | remove_role_from_a_user | DELETE /auth/users/{user_id}/roles | Remove role from a user |
| AuthApi | auth_user_information | GET /auth/me | Get me information |
| BillingApi | get_last_day_cost | GET /billing/billing/last-day-cost | GET: Last Day Cost |
| BillingApi | get_usage | GET /billing/billing/usage | GET: Billing usage |
| CallbacksApi | attach_callback_to_virtual_machine | POST /core/virtual-machines/{id}/attach-callback | Attach callback to virtual machine |
| CallbacksApi | attach_callback_to_volume | POST /core/volumes/{id}/attach-callback | Attach callback to volume |
| CallbacksApi | delete_virtual_machine_callback | DELETE /core/virtual-machines/{id}/delete-callback | Delete virtual machine callback |
| CallbacksApi | delete_volume_callback | DELETE /core/volumes/{id}/delete-callback | Delete volume callback |
| CallbacksApi | update_virtual_machine_callback | PUT /core/virtual-machines/{id}/update-callback | Update virtual machine callback |
| CallbacksApi | update_volume_callback | PUT /core/volumes/{id}/update-callback | Update volume callback |
| ComplianceApi | create_compliance | POST /core/compliance | Create compliance |
| ComplianceApi | delete_a_compliance | DELETE /core/compliance/{gpu_model} | Delete a compliance |
| ComplianceApi | retrieve_compliance | GET /core/compliance | Retrieve GPU compliance |
| ComplianceApi | update_a_compliance | PUT /core/compliance | Update a compliance |
| CreditApi | check_balance_as_an_organization | GET /billing/user-credit/credit | GET: View credit and threshold |
| DashboardApi | retrieve_dashboard | GET /core/dashboard | Retrieve Dashboard |
| DeploymentApi | delete_deployment | DELETE /core/marketplace/deployments/{id} | Delete Deployment |
| DeploymentApi | details_of_deployment_by_id | GET /core/marketplace/deployments/{id} | Details of Deployment by ID |
| DeploymentApi | list_deployments | GET /core/marketplace/deployments | List Deployments |
| DeploymentApi | start_deployment | POST /core/marketplace/deployments | Start Deployment |
| EnvironmentApi | create_environment | POST /core/environments | Create environment |
| EnvironmentApi | delete_environment | DELETE /core/environments/{id} | Delete environment |
| EnvironmentApi | list_environments | GET /core/environments | List environments |
| EnvironmentApi | retrieve_environment | GET /core/environments/{id} | Retrieve environment |
| EnvironmentApi | update_environment | PUT /core/environments/{id} | Update environment |
| FirewallAttachmentApi | attach_firewall_to_vms | POST /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs |
| FirewallsApi | add_rules_to_firewall | POST /core/firewalls/{firewall_id}/firewall-rules | Add Rules to Firewall |
| FirewallsApi | create_firewall | POST /core/firewalls | Create Firewall |
| FirewallsApi | delete_firewall | DELETE /core/firewalls/{id} | Delete Firewall |
| FirewallsApi | delete_firewall_rules_from_firewall | DELETE /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Delete Firewall Rules from Firewall |
| FirewallsApi | details_of_firewall_by_id | GET /core/firewalls/{id} | Details of Firewall by ID |
| FirewallsApi | retrieve_firewalls | GET /core/firewalls | Retrieve Firewalls |
| FlavorApi | list_flavors | GET /core/flavors | List flavors |
| FloatingIpApi | attach_public_ip_to_virtual_machine | POST /core/virtual-machines/{id}/attach-floatingip | Attach public IP to virtual machine |
| FloatingIpApi | detach_public_ip_from_virtual_machine | POST /core/virtual-machines/{id}/detach-floatingip | Detach public IP from virtual machine |
| GpuApi | list_gpus | GET /core/gpus | List GPUs |
| ImageApi | list_images | GET /core/images | List images |
| InviteApi | delete_invite | DELETE /auth/invites/{id} | Delete Invite |
| InviteApi | invite_an_user_to_organization | POST /auth/invites | Invite an user to organization |
| InviteApi | list_invites | GET /auth/invites | List Invites |
| KeypairApi | delete_key_pair | DELETE /core/keypair/{id} | Delete key pair |
| KeypairApi | import_key_pair | POST /core/keypairs | Import key pair |
| KeypairApi | list_key_pairs | GET /core/keypairs | List key pairs |
| KeypairApi | update_key_pair_name | PUT /core/keypair/{id} | Update key pair name |
| OrganizationApi | get_organization_info | GET /auth/organizations | Organization Info |
| OrganizationApi | remove_a_member_from_organization | POST /auth/organizations/remove-member | Remove a member from organization |
| OrganizationApi | update_organization_info | PUT /auth/organizations/update | Update organization info |
| PaymentApi | get_details | GET /billing/payment/payment-details | GET: View payment details |
| PaymentApi | post_payment | POST /billing/payment/payment-initiate | POST: Initiate payment |
| PermissionApi | list_permissions | GET /auth/permissions | List Permissions |
| PolicyApi | list_policies | GET /auth/policies | List Policies |
| ProfileApi | create_profile | POST /core/profiles | Create profile |
| ProfileApi | delete_profile | DELETE /core/profiles/{id} | Delete profile |
| ProfileApi | list_profiles | GET /core/profiles | List profiles |
| ProfileApi | retrieve_profile_details | GET /core/profiles/{id} | Retrieve profile details |
| RbacRoleApi | create_rbac_role | POST /auth/roles | Create RBAC Role |
| RbacRoleApi | delete_a_rbac_role | DELETE /auth/roles/{id} | Delete a RBAC Role |
| RbacRoleApi | get_a_rbac_role_detail | GET /auth/roles/{id} | Get a RBAC Role Detail |
| RbacRoleApi | list_rbac_roles | GET /auth/roles | List RBAC Roles |
| RbacRoleApi | update_a_rbac_role | PUT /auth/roles/{id} | Update a RBAC Role |
| RegionApi | list_regions | GET /core/regions | List regions |
| SecurityRulesApi | list_firewall_rule_protocols | GET /core/sg-rules-protocols | List firewall rule protocols |
| StockApi | retrieve_gpu_stocks | GET /core/stocks | |
| TemplateApi | create_template | POST /core/marketplace/templates | Create template |
| TemplateApi | delete_template | DELETE /core/marketplace/templates/{id} | Delete template |
| TemplateApi | list_templates | GET /core/marketplace/templates | List templates |
| TemplateApi | retrieve_template_details | GET /core/marketplace/templates/{id} | Retrieve template details |
| TemplateApi | update_template | PUT /core/marketplace/templates/{id} | Update template |
| UserApi | get_user | GET /billing/user/info | GET: Fetch User Info |
| UserApi | post_user | POST /billing/user/info | POST: Insert user info |
| UserApi | update_user_info | PUT /billing/user/info | PUT: Update user info |
| UserDetailChoiceApi | retrieve_default_flavors_and_images_for_user | GET /core/user/resources/defaults | Retrieve default flavors and images for user |
| UserPermissionApi | list_current_user_permissions | GET /auth/users/me/permissions | List Current User Permissions |
| UserPermissionApi | list_user_permissions | GET /auth/users/{id}/permissions | List User Permissions |
| VirtualMachineApi | add_firewall_rule_to_virtual_machine | POST /core/virtual-machines/{id}/sg-rules | Add firewall rule to virtual machine |
| VirtualMachineApi | attach_firewalls_to_a_vm | POST /core/virtual-machines/{vm_id}/attach-firewalls | Attach Firewalls to a VM |
| VirtualMachineApi | create_virtual_machine | POST /core/virtual-machines | Create virtual machine |
| VirtualMachineApi | delete_firewall_rule_from_virtual_machine | DELETE /core/virtual-machines/{virtual_machine_id}/sg-rules/{sg_rule_id} | Delete firewall rule from virtual machine |
| VirtualMachineApi | delete_virtual_machine | DELETE /core/virtual-machines/{id} | Delete virtual machine |
| VirtualMachineApi | edit_labels_of_an_existing_vm | PUT /core/virtual-machines/{virtual_machine_id}/label | Edit labels of an existing VM |
| VirtualMachineApi | hard_reboot_virtual_machine | GET /core/virtual-machines/{id}/hard-reboot | Hard reboot virtual machine |
| VirtualMachineApi | hibernate_virtual_machine | GET /core/virtual-machines/{virtual_machine_id}/hibernate | Hibernate virtual machine |
| VirtualMachineApi | list_virtual_machines | GET /core/virtual-machines | List all virtual machines |
| VirtualMachineApi | resize_virtual_machine | POST /core/virtual-machines/{virtual_machine_id}/resize | Resize virtual machine |
| VirtualMachineApi | restore_virtual_machine_from_hibernation | GET /core/virtual-machines/{virtual_machine_id}/hibernate-restore | Restore virtual machine from hibernation |
| VirtualMachineApi | retrieve_virtual_machine_details | GET /core/virtual-machines/{id} | Retrieve virtual machine details |
| VirtualMachineApi | retrieve_virtual_machine_performance_metrics | GET /core/virtual-machines/{virtual_machine_id}/metrics | Retrieve virtual machine performance metrics |
| VirtualMachineApi | retrieve_virtual_machines_associated_with_a_contract | GET /core/virtual-machines/contract/{contract_id}/virtual-machines | Retrieve virtual machines associated with a contract |
| VirtualMachineApi | start_virtual_machine | GET /core/virtual-machines/{id}/start | Start virtual machine |
| VirtualMachineApi | stop_virtual_machine | GET /core/virtual-machines/{id}/stop | Stop virtual machine |
| VirtualMachineEventsApi | list_virtual_machine_events | GET /core/virtual-machines/{virtual_machine_id}/events | List virtual machine events |
| VncUrlApi | get_vnc_console_link | GET /core/virtual-machines/{virtual_machine_id}/console/{job_id} | Get VNC Console Link |
| VncUrlApi | request_console | GET /core/virtual-machines/{id}/request-console | Request Instance Console |
| VolumeApi | create_volume | POST /core/volumes | Create volume |
| VolumeApi | delete_volume | DELETE /core/volumes/{id} | Delete volume |
| VolumeApi | list_volume_types | GET /core/volume-types | List volume types |
| VolumeApi | list_volumes | GET /core/volumes | List volumes |
| VolumeAttachmentApi | attach_volumes_to_virtual_machine | POST /core/virtual-machines/{virtual_machine_id}/attach-volumes | Attach volumes to virtual machine |
| VolumeAttachmentApi | detach_volumes_from_virtual_machine | POST /core/virtual-machines/{virtual_machine_id}/detach-volumes | Detach volumes from virtual machine |
- AddUpdateFlavorOrganizationPayload
- AddUserInfoSuccessResponseModel
- AdminAddUpdateImageOrganizationPayload
- AdminBootstrapEnvironmentPayload
- AdminClusterResource
- AdminContainerResource
- AdminContractEventFields
- AdminContractFields
- AdminCountResourcesOrganization
- AdminCountResourcesOrganizations
- AdminCreateContractResponseModel
- AdminEnvrionmentResources
- AdminFlavorDetailFields
- AdminFlavorDetailNodeFields
- AdminFlavorResource
- AdminFlavorResourcesList
- AdminGetContractDetailFields
- AdminGetVersionResponse
- AdminHibernationRestorationPayloadModel
- AdminImageAdminFields
- AdminImageAdminResponse
- AdminImageAdminResponseImage
- AdminImageListAdminResponse
- AdminInstanceResources
- AdminNodeResource
- AdminOrganizationResourceList
- AdminOrganizationResourceResponse
- AdminOrganizationResources
- AdminOrganizationResponseModel
- AdminOrganizationSummaryFields
- AdminOrganizationsResponseModel
- AdminOrganizationsSummaryResponseModel
- AdminUserFields
- AdminUserResponseModel
- AdminUsersResponseModel
- AdminVersionResponseModel
- AdminVolumeResource
- Adminaddorganizationpayload
- Admincreditpostpayload
- Adminpaymenthistoryfields
- Adminpaymenthistoryresponse
- Adminrechargehistoryfields
- Adminrechargehistoryresponse
- Adminthresholdpostpayload
- ApiKeyFields
- ApiKeyVerifyFields
- AssignRbacRolePayload
- AttachCallbackPayload
- AttachCallbackResponse
- AttachFirewallWithVM
- AttachFirewallsToVMPayload
- AttachVolumeFields
- AttachVolumes
- AttachVolumesPayload
- AuthGetTokenResponseModel
- AuthRequestLoginFields
- AuthRequestLoginResponseModel
- AuthUserFields
- AuthUserInfoResponseModel
- BillingResponse
- Billingimmuneresources
- Billingimmuneresourcesresponse
- Billingmetricesfields
- Billingmetricesresponse
- CommonResponseModel
- ComplianceFields
- ComplianceModelFields
- CompliancePayload
- ComplianceResponse
- ContainerOverviewFields
- ContractInstanceFields
- ContractInstancesResponse
- CreateContarctFields
- CreateContractPayload
- CreateDiscountResponse
- CreateDiscountsPayload
- CreateEnvironment
- CreateFirewallPayload
- CreateFirewallRulePayload
- CreateGPU
- CreateInstancesPayload
- CreateProfilePayload
- CreateProfileResponse
- CreateSecurityRulePayload
- CreateUpdateComplianceResponse
- CreateUpdatePermissionPayload
- CreateUpdatePermissionResponseModel
- CreateUpdatePolicyPayload
- CreateUpdatePolicyResponseModel
- CreateUpdateRbacRolePayload
- CreateVolumePayload
- CustomerContractDetailResponseModel
- CustomerContractFields
- CustomerFields
- CustomerPayload
- DashboardInfoResponse
- DeploymentFields
- DeploymentFieldsforstartdeployments
- Deployments
- DetachVolumes
- DetachVolumesPayload
- DiscountEntityModel
- DiscountFields
- DiscountPlanFields
- DiscountResourceFields
- EditlabelofanexistingVMPayload
- Environment
- EnvironmentFields
- EnvironmentFieldsforVolume
- Environments
- ErrorResponseModel
- Excludebillingpostpayload
- Excludebillingpostresponse
- FirewallAttachmentModel
- FirewallAttachmentVMModel
- FirewallDetailFields
- FirewallDetailResponse
- FirewallEnvironmentFields
- FirewallFields
- FirewallResponse
- FirewallRule
- FirewallsListResponse
- FlavorAdminResponse
- FlavorAdminResponseFlavors
- FlavorDetailResponse
- FlavorFields
- FlavorItemGetResponse
- FlavorListResponse
- FlavorObjectFields
- FlavorPayload
- FlavorResponse
- FlavorVMFields
- FlavorVMsResponse
- FutureNodeModel
- FutureNodeResponseModel
- FutureNodeStockModel
- FutureNodeUpdateModel
- FutureNodesStockModel
- GPU
- GPUFields
- GPUList
- GPURegionFields
- GenerateApiKeyResponseModel
- GetAllDiscountForAllOrganizationResponse
- GetAllDiscountsFields
- GetApiKeyResponseModel
- GetContractDetailResponseModel
- GetContractEventsResponseModel
- GetContractsListResponseModel
- GetCustomerContractsListResponseModel
- GetDiscountDetailResponse
- GetDiscountResponse
- GetEntityDiscountDetailResponse
- GetInvitesResponseModel
- GetOrganizationResponseModel
- GetPermissionsResponseModel
- GetPoliciesResponseModel
- GetRbacRolesResponseModel
- GetTokenPayload
- GetUserPermissionsResponseModel
- GetVersionResponse
- Getcreditandthresholdinfo
- Getcreditandthresholdinfoinresponse
- ImageFields
- ImageGetResponse
- ImageLogos
- Images
- ImportKeypairPayload
- ImportKeypairResponse
- InfrahubResourceObjectResponse
- InsertDiscountPlanFields
- Instance
- InstanceAdmin
- InstanceAdminFields
- InstanceEnvironmentFields
- InstanceEvents
- InstanceEventsFields
- InstanceFields
- InstanceFlavorFields
- InstanceImageFields
- InstanceKeypairFields
- InstanceOverviewFields
- InstanceResizePayload
- Instances
- InstancesAdmin
- InstancesSummaryAdmin
- InstancesSummaryFields
- InternalEnvironmentFields
- InternalInstanceFields
- InternalInstanceFlavorFields
- InternalInstanceImageFields
- InternalInstanceKeypairFields
- InternalInstancesResponse
- InternalSecurityRulesFieldsForInstance
- InternalVolumeAttachmentFields
- InternalVolumeFields
- InternalVolumesResponse
- InviteFields
- InviteUserPayload
- InviteUserResponseModel
- KeypairFields
- Keypairs
- LableResonse
- Lastdaycostfields
- Lastdaycostresponse
- LogoGetResponse
- LogoutPayload
- MetricItemFields
- MetricsFields
- NewConfigurationsResponse
- NewModelResponse
- NewStockResponse
- NewStockRetriveResponse
- NewStockUpdateResponseModel
- NodeModel
- NodePayloadModel
- NodePowerUsageModel
- NodeResponseModel
- NodeStockPayloadModel
- NodeStockResponseModel
- NodeStocksPayload
- OrganizationFields
- OrganizationObjectResponse
- OrganizationUserResponseModel
- OverviewInfo
- PaymentDetailsFields
- PaymentDetailsResponse
- PaymentInitiateFields
- PaymentInitiatePayload
- PaymentInitiateResponse
- PermissionFields
- PolicyFields
- PolicyPermissionFields
- PowerUsageModel
- PricebookModel
- PricebookResourceObjectResponse
- ProfileFields
- ProfileListResponse
- ProfileObjectFields
- RbacRoleDetailResponseModel
- RbacRoleField
- RbacRoleFields
- RefreshTokenPayload
- RegionFields
- RegionPayload
- RegionResponse
- Regions
- RemoveMemberFromOrganizationResponseModel
- RemoveMemberPayload
- RequestConsole
- ResourcePayload
- ResponseModel
- RolePermissionFields
- RolePolicyFields
- SecurityGroupRule
- SecurityGroupRuleFields
- SecurityRulesFieldsforInstance
- SecurityRulesProtocolFields
- SetDefaultsPayload
- SingleVisibilityUserResponse
- StartDeployment
- StartDeploymentPayload
- StockVisibilityUserListResponse
- StockVisibilityUserPayload
- SuccessResponseModel
- Template
- TemplateFields
- Templates
- TokenFields
- UpdateContractPayload
- UpdateDiscountsPayload
- UpdateDiscountsStatusPayload
- UpdateEnvironment
- UpdateGPU
- UpdateKeypairName
- UpdateKeypairnameresponse
- UpdateOrganizationPayload
- UpdateOrganizationResponseModel
- UpdateTemplate
- UserDefaultChoiceForAdminFields
- UserDefaultChoiceForUserFields
- UserDefaultChoicesForAdminResponse
- UserDefaultChoicesForUserResponse
- UserPermissionFields
- UserTransferPayload
- Userinfopostpayload
- UsersInfoFields
- UsersInfoListResponse
- VNCURL
- VNCURLFields
- VerifyApiKeyPayload
- VerifyApiKeyResponseModel
- Volume
- VolumeAttachmentFields
- VolumeFields
- VolumeFieldsforInstance
- VolumeOverviewFields
- VolumeTypes
- Volumes
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
- Type: API key
- API key parameter name: api_key
- Location: HTTP header