HyperstackApi.VirtualMachineApi

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

Method	HTTP request	Description
addVMLabel	PUT /core/virtual-machines/{vm_id}/label	Edit virtual machine labels
attachFirewallsToVM	POST /core/virtual-machines/{vm_id}/attach-firewalls	Attach firewalls to a virtual machine
checkVMNameAvailability	GET /core/virtual-machines/name-availability/{name}	Fetch virtual machine name availability
createFirewallRuleForVM	POST /core/virtual-machines/{vm_id}/sg-rules	Add firewall rule to virtual machine
createSnapshotForVM	POST /core/virtual-machines/{vm_id}/snapshots	Create snapshot from a virtual machine
createVMs	POST /core/virtual-machines	Create virtual machines
deleteFirewallRuleForVM	DELETE /core/virtual-machines/{vm_id}/sg-rules/{sg_rule_id}	Delete firewall rule from virtual machine
deleteVM	DELETE /core/virtual-machines/{vm_id}	Delete virtual machine
getContractVMs	GET /core/virtual-machines/contract/{contract_id}/virtual-machines	Retrieve virtual machines associated with a contract
getVM	GET /core/virtual-machines/{vm_id}	Retrieve virtual machine details
getVMLogs	GET /core/virtual-machines/{vm_id}/logs	Get virtual machine logs
getVMMetrics	GET /core/virtual-machines/{vm_id}/metrics	Retrieve virtual machine performance metrics
hardRebootVM	GET /core/virtual-machines/{vm_id}/hard-reboot	Hard reboot virtual machine
hibernateVM	GET /core/virtual-machines/{vm_id}/hibernate	Hibernate virtual machine
listVMs	GET /core/virtual-machines	List virtual machines
requestVMLogs	POST /core/virtual-machines/{vm_id}/logs	Request virtual machine logs
resizeVM	POST /core/virtual-machines/{vm_id}/resize	Resize virtual machine
restoreVMFromHibernation	GET /core/virtual-machines/{vm_id}/hibernate-restore	Restore virtual machine from hibernation
startVM	GET /core/virtual-machines/{vm_id}/start	Start virtual machine
stopVM	GET /core/virtual-machines/{vm_id}/stop	Stop virtual machine

addVMLabel

ResponseModel addVMLabel(vmId, payload)

Edit virtual machine labels

Adds one or more labels to an existing virtual machine. Provide the virtual machine ID in the path to add labels to the specified VM. For multiple labels, add a space between each label in the request body.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.EditLabelOfAnExistingVMPayload(); // EditLabelOfAnExistingVMPayload | 
apiInstance.addVMLabel(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	EditLabelOfAnExistingVMPayload

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

attachFirewallsToVM

ResponseModel attachFirewallsToVM(vmId, payload)

Attach firewalls to a virtual machine

Attach firewalls to a virtual machine by providing the virtual machine ID in the path and the IDs of the firewalls in the request body; any firewalls not included will be detached.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.AttachFirewallsToVMPayload(); // AttachFirewallsToVMPayload | 
apiInstance.attachFirewallsToVM(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	AttachFirewallsToVMPayload

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

checkVMNameAvailability

NameAvailableModel checkVMNameAvailability(name, opts)

Fetch virtual machine name availability

Check if a Virtual Machine name is available

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let name = "name_example"; // String | 
let opts = {
  'count': "count_example" // String | Nr of instances to handle (optional, default: 1)
};
apiInstance.checkVMNameAvailability(name, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
name	String
count	String	Nr of instances to handle (optional, default: 1)	[optional]

Return type

NameAvailableModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

createFirewallRuleForVM

SecurityGroupRule createFirewallRuleForVM(vmId, payload)

Add firewall rule to virtual machine

Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, click here.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.CreateSecurityRulePayload(); // CreateSecurityRulePayload | 
apiInstance.createFirewallRuleForVM(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	CreateSecurityRulePayload

Return type

SecurityGroupRule

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

createSnapshotForVM

CreateSnapshotResponse createSnapshotForVM(vmId, payload)

Create snapshot from a virtual machine

Create snapshots of a virtual machine by providing the virtual machine ID in the path

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.CreateSnapshotPayload(); // CreateSnapshotPayload | 
apiInstance.createSnapshotForVM(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	CreateSnapshotPayload

Return type

CreateSnapshotResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

createVMs

CreateInstancesResponse createVMs(payload)

Create virtual machines

Creates one or more virtual machines with the specified custom configuration and features provided in the request body. For more information about the virtual machine features offered by Infrahub, click here.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let payload = new HyperstackApi.CreateInstancesPayload(); // CreateInstancesPayload | 
apiInstance.createVMs(payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
payload	CreateInstancesPayload

Return type

CreateInstancesResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

deleteFirewallRuleForVM

ResponseModel deleteFirewallRuleForVM(vmId, sgRuleId)

Delete firewall rule from virtual machine

Deletes a firewall rule associated with a virtual machine. Provide the virtual machine ID and the firewall rule ID in the path to remove the specified rule from the specified virtual machine.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let sgRuleId = 56; // Number | 
apiInstance.deleteFirewallRuleForVM(vmId, sgRuleId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
sgRuleId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

deleteVM

ResponseModel deleteVM(vmId)

Delete virtual machine

Permanently deletes a virtual machine. Provide the virtual machine ID in the path to delete the specified virtual machine.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.deleteVM(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getContractVMs

ContractInstancesResponse getContractVMs(contractId, opts)

Retrieve virtual machines associated with a contract

Retrieves a list of virtual machines associated with a contract, providing details such as virtual machine name, timestamp, flavor name, and other relevant information. Please provide the ID of the relevant contract in the path.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let contractId = 56; // Number | 
let opts = {
  'page': "page_example", // String | Page Number
  'pageSize': "pageSize_example", // String | Data Per Page
  'search': "search_example" // String | Search By Instance ID or Name
};
apiInstance.getContractVMs(contractId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
contractId	Number
page	String	Page Number	[optional]
pageSize	String	Data Per Page	[optional]
search	String	Search By Instance ID or Name	[optional]

Return type

ContractInstancesResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVM

Instance getVM(vmId)

Retrieve virtual machine details

Retrieves the details of an existing virtual machine. Provide the virtual machine ID in the path, and Infrahub will return information about the corresponding VM.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.getVM(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

Instance

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMLogs

GetInstanceLogsResponse getVMLogs(vmId, requestId)

Get virtual machine logs

Retrieve console logs for a virtual machine

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let requestId = 56; // Number | 
apiInstance.getVMLogs(vmId, requestId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
requestId	Number

Return type

GetInstanceLogsResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

getVMMetrics

MetricsFields getVMMetrics(vmId, opts)

Retrieve virtual machine performance metrics

Retrieves performance metrics data for a virtual machine. Provide the virtual machine ID in the path to retrieve the following data for the specified virtual machine: CPU usage, memory usage (RAM), `network.in`, `network.out`, `disk.read`, and `disk.write`. The optional `duration` parameter can be used to specify the period for retrieving performance metrics; the default value will retrieve all available data. To learn more about virtual machine performance metrics, click here.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let opts = {
  'duration': "duration_example" // String | 
};
apiInstance.getVMMetrics(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
duration	String		[optional]

Return type

MetricsFields

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

hardRebootVM

ResponseModel hardRebootVM(vmId)

Hard reboot virtual machine

Initiates a hard reboot for a virtual machine, simulating the process of unplugging and rebooting a physical machine. Provide the virtual machine ID in the path to execute a hard reboot for the specified virtual machine.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.hardRebootVM(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

hibernateVM

ResponseModel hibernateVM(vmId, opts)

Hibernate virtual machine

Initiates the hibernation of a virtual machine, saving its current state to disk before powering off. Provide the virtual machine ID in the path to specify the virtual machine to be hibernated.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let opts = {
  'retainIp': "retainIp_example" // String | false
};
apiInstance.hibernateVM(vmId, opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
retainIp	String	false	[optional]

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

listVMs

Instances listVMs(opts)

List virtual machines

Returns a list of your existing virtual machines, providing configuration details for each. The list is sorted by creation date, with the oldest virtual machines displayed first.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let opts = {
  'page': 56, // Number | 
  'pageSize': 56, // Number | 
  'search': "search_example", // String | 
  'environment': "environment_example", // String | 
  'excludeFirewalls': [null], // [Number] | Comma-separated list of Security Group IDs to ignore instances attached
  'exactEnvironmentMatch': false // Boolean | Flag to filter environment by exact match instead of partial match
};
apiInstance.listVMs(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
page	Number		[optional]
pageSize	Number		[optional]
search	String		[optional]
environment	String		[optional]
excludeFirewalls	[Number]	Comma-separated list of Security Group IDs to ignore instances attached	[optional]
exactEnvironmentMatch	Boolean	Flag to filter environment by exact match instead of partial match	[optional] [default to false]

Return type

Instances

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

requestVMLogs

RequestInstanceLogsResponse requestVMLogs(vmId, payload)

Request virtual machine logs

Request console logs for a virtual machine

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.RequestInstanceLogsPayload(); // RequestInstanceLogsPayload | 
apiInstance.requestVMLogs(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	RequestInstanceLogsPayload

Return type

RequestInstanceLogsResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

resizeVM

ResponseModel resizeVM(vmId, payload)

Resize virtual machine

Updates the hardware configuration for an existing virtual machine. Include the virtual machine ID in the path and provide the new configuration, referred to as a `flavor`, in the body of the request. For additional information resizing, click here.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
let payload = new HyperstackApi.InstanceResizePayload(); // InstanceResizePayload | 
apiInstance.resizeVM(vmId, payload).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number
payload	InstanceResizePayload

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

restoreVMFromHibernation

ResponseModel restoreVMFromHibernation(vmId)

Restore virtual machine from hibernation

Resumes a virtual machine from hibernation, bringing it back to an active state. Provide the virtual machine ID that you want to restore from hibernation.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.restoreVMFromHibernation(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

startVM

ResponseModel startVM(vmId)

Start virtual machine

Initiates the startup of a virtual machine. Provide the virtual machine ID in the path to initiate the starting of the specified virtual machine.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.startVM(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

stopVM

ResponseModel stopVM(vmId)

Stop virtual machine

Shuts down a virtual machine. Provide the virtual machine ID in the path to initiate the shutdown process for the specified virtual machine.

Example

import HyperstackApi from '@nexgencloud/hyperstack-sdk-javascript';
let defaultClient = HyperstackApi.ApiClient.instance;
// Configure API key authorization: apiKey
let 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 = 'Token';

let apiInstance = new HyperstackApi.VirtualMachineApi();
let vmId = 56; // Number | 
apiInstance.stopVM(vmId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
vmId	Number

Return type

ResponseModel

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

VirtualMachineApi.md

Latest commit

History

VirtualMachineApi.md

File metadata and controls

HyperstackApi.VirtualMachineApi

addVMLabel

Example

Parameters

Return type

Authorization

HTTP request headers

attachFirewallsToVM

Example

Parameters

Return type

Authorization

HTTP request headers

checkVMNameAvailability

Example

Parameters

Return type

Authorization

HTTP request headers

createFirewallRuleForVM

Example

Parameters

Return type

Authorization

HTTP request headers

createSnapshotForVM

Example

Parameters

Return type

Authorization

HTTP request headers

createVMs

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFirewallRuleForVM

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVM

Example

Parameters

Return type

Authorization

HTTP request headers

getContractVMs

Example

Parameters

Return type

Authorization

HTTP request headers

getVM

Example

Parameters

Return type

Authorization

HTTP request headers

getVMLogs

Example

Parameters

Return type

Authorization

HTTP request headers

getVMMetrics

Example

Parameters

Return type

Authorization

HTTP request headers

hardRebootVM