@nexgencloud/hyperstack-sdk-javascript

v1.50.2-alpha

Published

25 days ago

Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources. Access this SDK to automate the deployment of your workloads and streamline your infrastructure managemen

0High
0Medium
0Low

sebastianpdw-nexgencloud

shahedmehbub

linhngc

@nexgencloud/hyperstack-sdk-javascript

HyperstackApi - JavaScript client for @nexgencloud/hyperstack-sdk-javascript Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources.

Access this SDK to automate the deployment of your workloads and streamline your infrastructure management.

To contribute, please raise an issue with a bug report, feature request, feedback, or general inquiry. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0
Package version: v1.50.2-alpha
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @nexgencloud/hyperstack-sdk-javascript --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your @nexgencloud/hyperstack-sdk-javascript from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/NexGenCloud/hyperstack-sdk-javascript then install it via:

    npm install NexGenCloud/hyperstack-sdk-javascript --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var HyperstackApi = require('@nexgencloud/hyperstack-sdk-javascript');

var defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['api_key'] = "Token"

var api = new HyperstackApi.AccessKeysApi()
var opts = {
  'body': new HyperstackApi.ObjectStorageAccessKeyCreateRequest() // {ObjectStorageAccessKeyCreateRequest} 
};
api.createAccessKeyEndpoint(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- HyperstackApi.AccessKeysApi | createAccessKeyEndpoint | POST /object-storage/access-keys | Generate a new access key HyperstackApi.AccessKeysApi | deleteAccessKeyEndpoint | DELETE /object-storage/access-keys/{access_key_id} | Remove an existing access key HyperstackApi.AccessKeysApi | listAccessKeysEndpoint | GET /object-storage/access-keys | List access keys HyperstackApi.AliveApi | getAlive | GET /billing/alive | GET: Alive HyperstackApi.AliveApi | getAliveDoc | GET /billing/alive/doc | HyperstackApi.ApiKeyApi | deleteAPIKey | DELETE /api-key/{api_key_id} | Delete API Key HyperstackApi.ApiKeyApi | generateAPIKey | POST /api-key/generate | Generate API Key HyperstackApi.ApiKeyApi | getAPIKey | GET /api-key | Retrieve API Keys HyperstackApi.ApiKeyApi | updateAPIKey | PUT /api-key/{api_key_id} | Update API Key HyperstackApi.AssigningMemberRoleApi | assignRBACRoleToUser | PUT /auth/users/{user_id}/assign-roles | Assign RBAC Role HyperstackApi.AssigningMemberRoleApi | removeRBACRoleFromUser | DELETE /auth/users/{user_id}/roles | Remove RBAC Role From User HyperstackApi.AuthApi | changeOrganizationForToken | GET /auth/token/change-org/{org_id} | HyperstackApi.AuthApi | disableMFA | GET /auth/me/mfa/disable | HyperstackApi.AuthApi | getUserMFAStatus | GET /auth/me/mfa | Get MFA status for authenticated user HyperstackApi.AuthApi | getUserOrganizations | GET /auth/me/organizations | Get User Organizations HyperstackApi.AuthApi | retrieveAuthenticatedUserDetails | GET /auth/me | Retrieve Authenticated User Details HyperstackApi.BetaAccessApi | createBetaAccessRequest | POST /auth/beta-access/requests | Create a new beta access request HyperstackApi.BetaAccessApi | getBetaAccessRequests | GET /auth/beta-access/requests/{program} | Check the status of beta access requests HyperstackApi.BetaAccessApi | getBetaAccessStatus | GET /auth/beta-access/requests | Check the status of all beta access requests HyperstackApi.BillingApi | bucketsBillingHistoryHourlyChart | GET /billing/billing/history/bucket/{bucket_id}/graph | Retrieve hourly cost datapoints of a Specific Bucket for a specific billing cycle HyperstackApi.BillingApi | getBucketBillingHistory | GET /billing/billing/history/bucket/{bucket_id} | Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle HyperstackApi.BillingApi | getClusterBillingHistory | GET /billing/billing/history/cluster/{cluster_id} | Retrieve Billing History of a Specific Cluster for a specific Billing Cycle HyperstackApi.BillingApi | getClusterBillingHistoryGraph | GET /billing/billing/history/cluster/{cluster_id}/graph | Retrieve hourly cost datapoints of a specific Cluster for a specific billing cycle HyperstackApi.BillingApi | getDataSynthesisBillingHistory | GET /billing/billing/history/data_synthesis | Retrieve Billing History of data synthesis for a specific Billing Cycle HyperstackApi.BillingApi | getDataSynthesisBillingHistoryGraph | GET /billing/billing/history/data_synthesis/{resource_id}/graph | Retrieve hourly cost datapoints of a Specific Data Synthesis for a specific HyperstackApi.BillingApi | getDataSynthesisHistoryForResource | GET /billing/billing/history/data_synthesis/{resource_id} | HyperstackApi.BillingApi | getFineTuningBillingHistory | GET /billing/billing/history/fine_tuning | Retrieve Billing History of model evaluation for a specific Billing Cycle HyperstackApi.BillingApi | getFineTuningBillingHistoryGraph | GET /billing/billing/history/fine_tuning/{resource_id}/graph | Retrieve hourly cost datapoints of a Specific Fine Tuning for a specific billing cycle HyperstackApi.BillingApi | getLastDayCost | GET /billing/billing/last-day-cost | GET: Last Day Cost HyperstackApi.BillingApi | getModelEvaluationBillingHistory | GET /billing/billing/history/model_evaluation | Retrieve Billing History of model evaluation for a specific Billing Cycle HyperstackApi.BillingApi | getModelEvaluationBillingHistoryGraph | GET /billing/billing/history/model_evaluation/{resource_id}/graph | Retrieve hourly cost datapoints of a Specific Model Evaluation for a specific HyperstackApi.BillingApi | getNotificationThreshold | PUT /billing/billing/threshold/{threshold_id} | Update: Subscribe or Unsubscribe Notification Threshold HyperstackApi.BillingApi | getResourceFineTuningBillingHistory | GET /billing/billing/history/fine_tuning/{resource_id} | Retrieve Billing History of a Specific Fine Tuning for a specific Billing Cycle HyperstackApi.BillingApi | getResourceModelEvaluationBillingHistory | GET /billing/billing/history/model_evaluation/{resource_id} | HyperstackApi.BillingApi | getServerlessInferenceBillingHistoryGraph | GET /billing/billing/history/serverless_inference/{resource_id}/graph | Retrieve hourly cost datapoints of a Specific Serverless Inference for a specific HyperstackApi.BillingApi | getServerlessInferencesBillingHistory | GET /billing/billing/history/serverless_inference/{resource_id} | HyperstackApi.BillingApi | getSnapshotBillingHistory | GET /billing/billing/history/snapshot/{snapshot_id} | Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle HyperstackApi.BillingApi | getSnapshotBillingHistoryGraph | GET /billing/billing/history/snapshot/{snapshot_id}/graph | Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle HyperstackApi.BillingApi | getUsage | GET /billing/billing/usage | GET: Billing usage HyperstackApi.BillingApi | getUserBillingHistory | GET /billing/billing/history | Retrieve Billing History for a specific Billing Cycle HyperstackApi.BillingApi | getVMBillingDetails | GET /billing/billing/history/virtual-machine/{vm_id} | Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle HyperstackApi.BillingApi | getVMBillingEvents | GET /billing/billing/virtual-machine/{vm_id}/billing-events | Retrieve VM billing events history HyperstackApi.BillingApi | getVMBillingGraph | GET /billing/billing/history/virtual-machine/{vm_id}/graph | Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle HyperstackApi.BillingApi | getVMBillingHistory | GET /billing/billing/history/virtual-machine | Retrieve Billing History of Virtual Machine for a specific Billing Cycle HyperstackApi.BillingApi | getVMSubResourceCosts | GET /billing/billing/virtual-machine/{vm_id}/sub-resource | Retrieve Total Costs and Non Discount Costs for Sub Resources HyperstackApi.BillingApi | getVMSubResourceGraph | GET /billing/billing/virtual-machine/{vm_id}/sub-resource/graph | Retrieve Sub-Resources Historical Cost datapoints of a Virtual HyperstackApi.BillingApi | getVolumeBillingDetails | GET /billing/billing/history/volume/{volume_id} | Retrieve Billing History of a Specific Volume for a specific Billing Cycle HyperstackApi.BillingApi | getVolumeBillingEvents | GET /billing/billing/volume/{volume_id}/billing-events | Retrieve Volume billing events history HyperstackApi.BillingApi | getVolumeBillingHistory | GET /billing/billing/history/volume | Retrieve Billing History of Volume for a specific Billing Cycle HyperstackApi.BillingApi | getVolumeBillingHistoryGraph | GET /billing/billing/history/volume/{volume_id}/graph | Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle HyperstackApi.BillingApi | listBillingContractHistory | GET /billing/billing/history/contract | Retrieve Billing History of Contract for a specific Billing Cycle HyperstackApi.BillingApi | listBucketBillingHistory | GET /billing/billing/history/bucket | Retrieve Billing History of a Bucket for a specific Billing Cycle HyperstackApi.BillingApi | listClustersBillingHistory | GET /billing/billing/history/cluster | Retrieve Billing History of Clusters for a specific Billing Cycle HyperstackApi.BillingApi | listOrgNotificationThresholds | GET /billing/billing/threshold | GET: All Thresholds for Organization HyperstackApi.BillingApi | listServerlessInferenceBillingHistory | GET /billing/billing/history/serverless_inference | Retrieve Billing History of serverless inference for a specific Billing Cycle HyperstackApi.BillingApi | listSnapshotBillingHistory | GET /billing/billing/history/snapshot | Retrieve Billing History of Snapshot for a specific Billing Cycle HyperstackApi.BucketsApi | deleteBucketEndpoint | DELETE /object-storage/buckets/{bucket_name} | Delete a bucket HyperstackApi.BucketsApi | listBucketsEndpoint | GET /object-storage/buckets | List buckets HyperstackApi.BucketsApi | retrieveBucketEndpoint | GET /object-storage/buckets/{bucket_name} | Retrieve a bucket HyperstackApi.CalculateApi | calculateResourceBillingRate | GET /pricebook/calculate/resource/{resource_type}/{id} | Retrieve Billing Rate for Resource HyperstackApi.CallbacksApi | attachCallbackToVM | POST /core/virtual-machines/{vm_id}/attach-callback | Attach callback to virtual machine HyperstackApi.CallbacksApi | attachCallbackToVolume | POST /core/volumes/{volume_id}/attach-callback | Attach callback to volume HyperstackApi.CallbacksApi | deleteVMCallback | DELETE /core/virtual-machines/{vm_id}/delete-callback | Delete virtual machine callback HyperstackApi.CallbacksApi | deleteVolumeCallback | DELETE /core/volumes/{volume_id}/delete-callback | Delete volume callback HyperstackApi.CallbacksApi | updateVMCallback | PUT /core/virtual-machines/{vm_id}/update-callback | Update virtual machine callback HyperstackApi.CallbacksApi | updateVolumeCallback | PUT /core/volumes/{volume_id}/update-callback | Update volume callback HyperstackApi.ClusterEventsApi | listClusterEvents | GET /core/clusters/{cluster_id}/events | Fetch all of a cluster events HyperstackApi.ClustersApi | createCluster | POST /core/clusters | Create Cluster HyperstackApi.ClustersApi | createNode | POST /core/clusters/{cluster_id}/nodes | Create Node HyperstackApi.ClustersApi | createNodeGroup | POST /core/clusters/{cluster_id}/node-groups | Create a node group in a cluster HyperstackApi.ClustersApi | deleteCluster | DELETE /core/clusters/{id} | Delete a cluster HyperstackApi.ClustersApi | deleteClusterNode | DELETE /core/clusters/{cluster_id}/nodes/{node_id} | Delete Cluster Node HyperstackApi.ClustersApi | deleteClusterNodes | POST /core/clusters/{cluster_id}/nodes/delete | Delete Multiple Cluster Nodes HyperstackApi.ClustersApi | deleteNodeGroup | DELETE /core/clusters/{cluster_id}/node-groups/{node_group_id} | Delete a node group HyperstackApi.ClustersApi | fetchClusterNameAvailability | GET /core/clusters/name-availability/{name} | Fetch cluster name availability HyperstackApi.ClustersApi | getClusterMasterFlavors | GET /core/clusters/master-flavors | Get Cluster Master Flavors HyperstackApi.ClustersApi | getClusterNodes | GET /core/clusters/{cluster_id}/nodes | Get Cluster Nodes HyperstackApi.ClustersApi | getClusterVersions | GET /core/clusters/versions | List Cluster Versions HyperstackApi.ClustersApi | getNodeGroup | GET /core/clusters/{cluster_id}/node-groups/{node_group_id} | Retrieve a node group in a cluster HyperstackApi.ClustersApi | gettingClusterDetail | GET /core/clusters/{id} | Getting Cluster Detail HyperstackApi.ClustersApi | listClusters | GET /core/clusters | List Clusters HyperstackApi.ClustersApi | listNodeGroups | GET /core/clusters/{cluster_id}/node-groups | List node groups for a cluster HyperstackApi.ClustersApi | reconcileCluster | POST /core/clusters/{cluster_id}/reconcile | Reconcile a cluster HyperstackApi.ClustersApi | updateNodeGroup | PATCH /core/clusters/{cluster_id}/node-groups/{node_group_id} | Update a node group in a cluster HyperstackApi.ComplianceApi | createCompliance | POST /core/compliance | Create compliance HyperstackApi.ComplianceApi | deleteCompliance | DELETE /core/compliance/{gpu_model} | Delete a compliance HyperstackApi.ComplianceApi | getCompliance | GET /core/compliance | Retrieve GPU compliance HyperstackApi.ComplianceApi | updateCompliance | PUT /core/compliance | Update a compliance HyperstackApi.CreditApi | getUserCredit | GET /billing/user-credit/credit | GET: View credit and threshold HyperstackApi.CustomerContractApi | getContractGPUAllocationGraph | GET /pricebook/contracts/{contract_id}/gpu_allocation_graph | Retrieve GPU Allocation Graph for Contract HyperstackApi.CustomerContractApi | listCustomerContracts | GET /pricebook/contracts | List Contracts HyperstackApi.CustomerContractApi | retrieveContract | GET /pricebook/contracts/{contract_id} | Retrieve Contract Details HyperstackApi.DashboardApi | getDashboard | GET /core/dashboard | Retrieve Dashboard HyperstackApi.DeploymentApi | deleteDeployment | DELETE /core/marketplace/deployments/{id} | Delete Deployment HyperstackApi.DeploymentApi | getDeployment | GET /core/marketplace/deployments/{id} | Details of Deployment by ID HyperstackApi.DeploymentApi | listDeployments | GET /core/marketplace/deployments | List Deployments HyperstackApi.DeploymentApi | startDeployment | POST /core/marketplace/deployments | Start Deployment HyperstackApi.EnvironmentApi | createEnvironment | POST /core/environments | Create environment HyperstackApi.EnvironmentApi | deleteEnvironment | DELETE /core/environments/{id} | Delete environment HyperstackApi.EnvironmentApi | fetchEnvironmentNameAvailability | GET /core/environments/name-availability/{name} | Fetch environment name availability HyperstackApi.EnvironmentApi | getEnvironment | GET /core/environments/{id} | Retrieve environment HyperstackApi.EnvironmentApi | getEnvironmentVMQuota | GET /core/environments/{id}/vm-quota | Get environment VM quota HyperstackApi.EnvironmentApi | listEnvironments | GET /core/environments | List environments HyperstackApi.EnvironmentApi | updateEnvironment | PUT /core/environments/{id} | Update environment HyperstackApi.FIPExclusionsApi | checkIfOrgIsExcludedFromFloatingIPDetachment | GET /core/fip-detachment-exclusions/org/{org_id} | HyperstackApi.FirewallAttachmentApi | attachFirewallToVMs | POST /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs HyperstackApi.FirewallsApi | addRuleToFirewall | POST /core/firewalls/{firewall_id}/firewall-rules | Add firewall rule to firewall HyperstackApi.FirewallsApi | createFirewall | POST /core/firewalls | Create firewall HyperstackApi.FirewallsApi | deleteExistingFirewall | DELETE /core/firewalls/{id} | Delete firewall HyperstackApi.FirewallsApi | deleteRuleFromFirewall | DELETE /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Delete firewall rules from firewall HyperstackApi.FirewallsApi | getFirewall | GET /core/firewalls/{id} | Retrieve firewall details HyperstackApi.FirewallsApi | listExistingFirewalls | GET /core/firewalls | List firewalls HyperstackApi.FlavorApi | listFlavors | GET /core/flavors | List Flavors HyperstackApi.FloatingIpApi | attachPublicIPToVM | POST /core/virtual-machines/{vm_id}/attach-floatingip | Attach public IP to virtual machine HyperstackApi.FloatingIpApi | detachPublicIPFromVM | POST /core/virtual-machines/{vm_id}/detach-floatingip | Detach public IP from virtual machine HyperstackApi.GpuApi | listGPUs | GET /core/gpus | List GPUs HyperstackApi.HealthApi | healthzEndpoint | GET /object-storage/healthz | Healthcheck HyperstackApi.ImageApi | deleteImage | DELETE /core/images/{id} | Delete an image HyperstackApi.ImageApi | fetchImageNameAvailability | GET /core/image/name-availability/{name} | Fetch name availability for Images HyperstackApi.ImageApi | getImage | GET /core/images/{id} | Get Private Image Details HyperstackApi.ImageApi | listImages | GET /core/images | List Images HyperstackApi.InviteApi | acceptInvite | GET /auth/invites/{id}/accept | Accept Invite HyperstackApi.InviteApi | deleteInvite | DELETE /auth/invites/{id} | Accept Invite HyperstackApi.InviteApi | inviteUserToOrganization | POST /auth/invites | Invite User to Organization HyperstackApi.InviteApi | listInvites | GET /auth/invites | List Invites HyperstackApi.KeypairApi | deleteKeyPair | DELETE /core/keypair/{id} | Delete key pair HyperstackApi.KeypairApi | importKeyPair | POST /core/keypairs | Import key pair HyperstackApi.KeypairApi | listKeyPairs | GET /core/keypairs | List key pairs HyperstackApi.KeypairApi | updateKeyPairName | PUT /core/keypair/{id} | Update key pair name HyperstackApi.OrganizationApi | removeOrganizationMember | POST /auth/organizations/remove-member | Remove Organization Member HyperstackApi.OrganizationApi | retrieveOrganizationInformation | GET /auth/organizations | Retrieve Organization Information HyperstackApi.OrganizationApi | updateOrganizationInformation | PUT /auth/organizations/update | Update Organization Information HyperstackApi.PartnerConfigApi | getPartnerConfig | GET /auth/partner-config | Get partner config HyperstackApi.PartnerConfigApi | getPartnerConfigByDomain | GET /auth/partner-config/docs | HyperstackApi.PaymentApi | getPaymentReceipt | GET /billing/payment/receipt/{payment_id} | Retrieve Payment Receipt HyperstackApi.PaymentApi | initiatePayment | POST /billing/payment/payment-initiate | POST: Initiate payment HyperstackApi.PaymentApi | listPaymentDetails | GET /billing/payment/payment-details | GET: View payment details HyperstackApi.PermissionApi | listPermissions | GET /auth/permissions | List Permissions HyperstackApi.PolicyApi | listPolicies | GET /auth/policies | List Policies HyperstackApi.PricebookApi | getPricebook | GET /pricebook | HyperstackApi.ProfileApi | createProfile | POST /core/profiles | Create profile HyperstackApi.ProfileApi | deleteProfile | DELETE /core/profiles/{id} | Delete profile HyperstackApi.ProfileApi | getProfile | GET /core/profiles/{id} | Retrieve profile details HyperstackApi.ProfileApi | listProfiles | GET /core/profiles | List profiles HyperstackApi.RbacRoleApi | createRBACRole | POST /auth/roles | Create RBAC Role HyperstackApi.RbacRoleApi | deleteRBACRole | DELETE /auth/roles/{id} | Delete RBAC Role HyperstackApi.RbacRoleApi | listRBACRoles | GET /auth/roles | List RBAC Roles HyperstackApi.RbacRoleApi | retrieveRBACRoleDetails | GET /auth/roles/{id} | Retrieve RBAC Role Details HyperstackApi.RbacRoleApi | updateRBACRole | PUT /auth/roles/{id} | Update RBAC Role HyperstackApi.RegionApi | listRegions | GET /core/regions | List Regions HyperstackApi.RegionsApi | listRegionsEndpoint | GET /object-storage/regions | Get a list of supported regions HyperstackApi.SecurityRulesApi | listFirewallRuleProtocols | GET /core/sg-rules-protocols | List firewall rule protocols HyperstackApi.SnapshotEventsApi | listSnapshotEvents | GET /core/snapshots/{snapshot_id}/events | Fetch all events for a snapshot HyperstackApi.SnapshotsApi | createCustomImage | POST /core/snapshots/{snapshot_id}/image | Create an image from a snapshot HyperstackApi.SnapshotsApi | deleteSnapshot | DELETE /core/snapshots/{id} | Delete snapshot HyperstackApi.SnapshotsApi | fetchSnapshotNameAvailability | GET /core/snapshots/name-availability/{name} | Fetch snapshot name availability HyperstackApi.SnapshotsApi | getSnapshot | GET /core/snapshots/{id} | Retrieve a snapshot HyperstackApi.SnapshotsApi | listSnapshots | GET /core/snapshots | Retrieve list of snapshots with pagination HyperstackApi.SnapshotsApi | restoreSnapshot | POST /core/snapshots/{id}/restore | Restore a snapshot HyperstackApi.StockApi | getGPUStock | GET /core/stocks | Retrieve GPU stocks HyperstackApi.TemplateApi | createTemplate | POST /core/marketplace/templates | Create template HyperstackApi.TemplateApi | deleteTemplate | DELETE /core/marketplace/templates/{id} | Delete template HyperstackApi.TemplateApi | getTemplate | GET /core/marketplace/templates/{id} | Retrieve template details HyperstackApi.TemplateApi | listTemplates | GET /core/marketplace/templates | List templates HyperstackApi.TemplateApi | updateTemplate | PUT /core/marketplace/templates/{id} | Update template HyperstackApi.UserApi | addUserBillingInfo | POST /billing/user/info | POST: Insert billing info HyperstackApi.UserApi | getUserBillingInfo | GET /billing/user/info | GET: Retrieve billing info HyperstackApi.UserApi | updateUserBillingInfo | PUT /billing/user/info | PUT: Update billing info HyperstackApi.UserDetailChoiceApi | listDefaultFlavorsAndImages | GET /core/user/resources/defaults | Retrieve Default Flavors and Images HyperstackApi.UserPermissionApi | listMyUserPermissions | GET /auth/users/me/permissions | List My User Permissions HyperstackApi.UserPermissionApi | listUserPermissions | GET /auth/users/{id}/permissions | List User Permissions HyperstackApi.VirtualMachineApi | addVMLabel | PUT /core/virtual-machines/{vm_id}/label | Edit virtual machine labels HyperstackApi.VirtualMachineApi | attachFirewallsToVM | POST /core/virtual-machines/{vm_id}/attach-firewalls | Attach firewalls to a virtual machine HyperstackApi.VirtualMachineApi | checkVMNameAvailability | GET /core/virtual-machines/name-availability/{name} | Fetch virtual machine name availability HyperstackApi.VirtualMachineApi | createFirewallRuleForVM | POST /core/virtual-machines/{vm_id}/sg-rules | Add firewall rule to virtual machine HyperstackApi.VirtualMachineApi | createSnapshotForVM | POST /core/virtual-machines/{vm_id}/snapshots | Create snapshot from a virtual machine HyperstackApi.VirtualMachineApi | createVMs | POST /core/virtual-machines | Create virtual machines HyperstackApi.VirtualMachineApi | deleteFirewallRuleForVM | DELETE /core/virtual-machines/{vm_id}/sg-rules/{sg_rule_id} | Delete firewall rule from virtual machine HyperstackApi.VirtualMachineApi | deleteVM | DELETE /core/virtual-machines/{vm_id} | Delete virtual machine HyperstackApi.VirtualMachineApi | getContractVMs | GET /core/virtual-machines/contract/{contract_id}/virtual-machines | Retrieve virtual machines associated with a contract HyperstackApi.VirtualMachineApi | getVM | GET /core/virtual-machines/{vm_id} | Retrieve virtual machine details HyperstackApi.VirtualMachineApi | getVMLogs | GET /core/virtual-machines/{vm_id}/logs | Get virtual machine logs HyperstackApi.VirtualMachineApi | getVMMetrics | GET /core/virtual-machines/{vm_id}/metrics | Retrieve virtual machine performance metrics HyperstackApi.VirtualMachineApi | hardRebootVM | GET /core/virtual-machines/{vm_id}/hard-reboot | Hard reboot virtual machine HyperstackApi.VirtualMachineApi | hibernateVM | GET /core/virtual-machines/{vm_id}/hibernate | Hibernate virtual machine HyperstackApi.VirtualMachineApi | listVMs | GET /core/virtual-machines | List virtual machines HyperstackApi.VirtualMachineApi | requestVMLogs | POST /core/virtual-machines/{vm_id}/logs | Request virtual machine logs HyperstackApi.VirtualMachineApi | resizeVM | POST /core/virtual-machines/{vm_id}/resize | Resize virtual machine HyperstackApi.VirtualMachineApi | restoreVMFromHibernation | GET /core/virtual-machines/{vm_id}/hibernate-restore | Restore virtual machine from hibernation HyperstackApi.VirtualMachineApi | startVM | GET /core/virtual-machines/{vm_id}/start | Start virtual machine HyperstackApi.VirtualMachineApi | stopVM | GET /core/virtual-machines/{vm_id}/stop | Stop virtual machine HyperstackApi.VirtualMachineEventsApi | listVMEvents | GET /core/virtual-machines/{vm_id}/events | List virtual machine events HyperstackApi.VncUrlApi | getVNCURL | GET /core/virtual-machines/{vm_id}/console/{job_id} | Get VNC Console Link HyperstackApi.VncUrlApi | requestVMConsole | GET /core/virtual-machines/{vm_id}/request-console | Request Instance Console HyperstackApi.VolumeApi | createVolume | POST /core/volumes | Create volume HyperstackApi.VolumeApi | deleteVolume | DELETE /core/volumes/{volume_id} | Delete volume HyperstackApi.VolumeApi | fetchVolumeNameAvailability | GET /core/volume/name-availability/{name} | Fetch volume name availability HyperstackApi.VolumeApi | getVolume | GET /core/volumes/{volume_id} | Fetch Volume Details HyperstackApi.VolumeApi | listVolumeTypes | GET /core/volume-types | List volume types HyperstackApi.VolumeApi | listVolumes | GET /core/volumes | List volumes HyperstackApi.VolumeApi | updateVolume | PATCH /core/volumes/{volume_id} | Update volume fields HyperstackApi.VolumeAttachmentApi | attachVolumesToVM | POST /core/virtual-machines/{vm_id}/attach-volumes | Attach volumes to virtual machine HyperstackApi.VolumeAttachmentApi | detachVolumesFromVM | POST /core/virtual-machines/{vm_id}/detach-volumes | Detach volumes from virtual machine HyperstackApi.VolumeAttachmentApi | updateVolumeAttachment | PATCH /core/volume-attachments/{volume_attachment_id} | Update a volume attachment HyperstackApi.VouchersApi | redeemAVoucher | POST /billing/billing/vouchers/redeem | Redeem a voucher with a voucher_code

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@nexgencloud/hyperstack-sdk-javascript

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

apiKey