# HivelocityApi.DeviceApi

All URIs are relative to *https://localhost/api/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getAllDeviceTagOrderResource**](DeviceApi.md#getAllDeviceTagOrderResource) | **GET** /device/tags-order/all | Get all device tags order
[**getClientDeviceTagOrderResource**](DeviceApi.md#getClientDeviceTagOrderResource) | **GET** /device/tags-order | Get device tags order for current user
[**getClientDeviceTagResource**](DeviceApi.md#getClientDeviceTagResource) | **GET** /device/tags | Get all device tags for current client
[**getDeviceIdEventResource**](DeviceApi.md#getDeviceIdEventResource) | **GET** /device/{deviceId}/events | Returns all Events found for a single device
[**getDeviceIdResource**](DeviceApi.md#getDeviceIdResource) | **GET** /device/{deviceId} | Returns detailed information for a Single Device
[**getDeviceIpminatRuleResource**](DeviceApi.md#getDeviceIpminatRuleResource) | **GET** /device/{deviceId}/ipmi/nat | Clear NAT rules based on the device client id
[**getDeviceResource**](DeviceApi.md#getDeviceResource) | **GET** /device/ | Return Active Devices and basic MetaData
[**getDeviceTagIdResource**](DeviceApi.md#getDeviceTagIdResource) | **GET** /device/{deviceId}/tags | Get device tags
[**getInitialCredsIdResource**](DeviceApi.md#getInitialCredsIdResource) | **GET** /device/{deviceId}/initial-creds | Returns initial password for the device
[**getInitialPasswordIdResource**](DeviceApi.md#getInitialPasswordIdResource) | **GET** /device/{deviceId}/initial-password | Returns initial password for the device
[**getIpmiInfoIdResource**](DeviceApi.md#getIpmiInfoIdResource) | **GET** /device/{deviceId}/ipmi | Returns IPMI info data
[**getIpmiInfoLoginDataResource**](DeviceApi.md#getIpmiInfoLoginDataResource) | **GET** /device/{deviceId}/ipmi/login-data | Returns IPMI login credentials
[**getIpmiThresholdsIdResource**](DeviceApi.md#getIpmiThresholdsIdResource) | **GET** /device/{deviceId}/ipmi/thresholds | Returns IPMI thresholds data
[**getIpmiValidLoginIdResource**](DeviceApi.md#getIpmiValidLoginIdResource) | **GET** /device/{deviceId}/ipmi/valid-login | Returns if device have valid credentials for IPMI login
[**getNetworkInterfaceResource**](DeviceApi.md#getNetworkInterfaceResource) | **GET** /device/{deviceId}/interfaces | Returns a list of all Network Interfaces bound to a Device
[**getPowerResource**](DeviceApi.md#getPowerResource) | **GET** /device/{deviceId}/power | Get device's current power status
[**postDeviceIpmiWhitelistResource**](DeviceApi.md#postDeviceIpmiWhitelistResource) | **POST** /device/{deviceId}/ipmi/whitelist/ | Add a public IP on IPMI whitelist
[**postDeviceReloadResource**](DeviceApi.md#postDeviceReloadResource) | **POST** /device/{deviceId}/reload | Reload any SPS Device with any available OS
[**postPowerResource**](DeviceApi.md#postPowerResource) | **POST** /device/{deviceId}/power | Apply action to device power
[**putClientDeviceTagOrderResource**](DeviceApi.md#putClientDeviceTagOrderResource) | **PUT** /device/tags-order | Update device tags order for current user
[**putDeviceIdResource**](DeviceApi.md#putDeviceIdResource) | **PUT** /device/{deviceId} | Updates Device MetaData for a Single Device
[**putDeviceTagIdResource**](DeviceApi.md#putDeviceTagIdResource) | **PUT** /device/{deviceId}/tags | Update device tags
[**putIpmiDevicesThresholdsIdResource**](DeviceApi.md#putIpmiDevicesThresholdsIdResource) | **PUT** /device/ipmi/thresholds | Updates IPMI thresholds for device list
[**putIpmiThresholdsIdResource**](DeviceApi.md#putIpmiThresholdsIdResource) | **PUT** /device/{deviceId}/ipmi/thresholds | Updates IPMI thresholds data


<a name="getAllDeviceTagOrderResource"></a>
# **getAllDeviceTagOrderResource**
> DeviceTag getAllDeviceTagOrderResource(opts)

Get all device tags order

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAllDeviceTagOrderResource(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getClientDeviceTagOrderResource"></a>
# **getClientDeviceTagOrderResource**
> DeviceTag getClientDeviceTagOrderResource(opts)

Get device tags order for current user

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getClientDeviceTagOrderResource(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getClientDeviceTagResource"></a>
# **getClientDeviceTagResource**
> DeviceTag getClientDeviceTagResource(opts)

Get all device tags for current client

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getClientDeviceTagResource(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getDeviceIdEventResource"></a>
# **getDeviceIdEventResource**
> [DeviceEvent] getDeviceIdEventResource(deviceId, opts)

Returns all Events found for a single device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = "deviceId_example"; // String | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDeviceIdEventResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**[DeviceEvent]**](DeviceEvent.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getDeviceIdResource"></a>
# **getDeviceIdResource**
> Device getDeviceIdResource(deviceId, , opts)

Returns detailed information for a Single Device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDeviceIdResource(deviceId, , opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**Device**](Device.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getDeviceIpminatRuleResource"></a>
# **getDeviceIpminatRuleResource**
> getDeviceIpminatRuleResource(deviceId)

Clear NAT rules based on the device client id

Returns success or error

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of a client Device


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getDeviceIpminatRuleResource(deviceId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of a client Device | 

### Return type

null (empty response body)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getDeviceResource"></a>
# **getDeviceResource**
> [Device] getDeviceResource(opts)

Return Active Devices and basic MetaData

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDeviceResource(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**[Device]**](Device.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getDeviceTagIdResource"></a>
# **getDeviceTagIdResource**
> DeviceTag getDeviceTagIdResource(deviceId, , opts)

Get device tags

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getDeviceTagIdResource(deviceId, , opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getInitialCredsIdResource"></a>
# **getInitialCredsIdResource**
> DeviceInitialCreds getInitialCredsIdResource(deviceId, opts)

Returns initial password for the device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to retrieve initial authentication credentials for

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getInitialCredsIdResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to retrieve initial authentication credentials for | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceInitialCreds**](DeviceInitialCreds.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getInitialPasswordIdResource"></a>
# **getInitialPasswordIdResource**
> DevicePassword getInitialPasswordIdResource(deviceId, opts)

Returns initial password for the device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to retrieve initial password

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getInitialPasswordIdResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to retrieve initial password | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DevicePassword**](DevicePassword.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getIpmiInfoIdResource"></a>
# **getIpmiInfoIdResource**
> DeviceIPMIInfo getIpmiInfoIdResource(deviceId, opts)

Returns IPMI info data

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to retrieve IPMI info.

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getIpmiInfoIdResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to retrieve IPMI info. | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceIPMIInfo**](DeviceIPMIInfo.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getIpmiInfoLoginDataResource"></a>
# **getIpmiInfoLoginDataResource**
> IPMILoginData getIpmiInfoLoginDataResource(deviceId, opts)

Returns IPMI login credentials

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to retrieve IPMI Login data.

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getIpmiInfoLoginDataResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to retrieve IPMI Login data. | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**IPMILoginData**](IPMILoginData.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getIpmiThresholdsIdResource"></a>
# **getIpmiThresholdsIdResource**
> DeviceIPMIThresholds getIpmiThresholdsIdResource(deviceId, , opts)

Returns IPMI thresholds data

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getIpmiThresholdsIdResource(deviceId, , opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceIPMIThresholds**](DeviceIPMIThresholds.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getIpmiValidLoginIdResource"></a>
# **getIpmiValidLoginIdResource**
> IPMIValidLogin getIpmiValidLoginIdResource(deviceId, opts)

Returns if device have valid credentials for IPMI login

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to check IPMI credentials

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getIpmiValidLoginIdResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to check IPMI credentials | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**IPMIValidLogin**](IPMIValidLogin.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getNetworkInterfaceResource"></a>
# **getNetworkInterfaceResource**
> [DeviceInterface] getNetworkInterfaceResource(deviceId, opts)

Returns a list of all Network Interfaces bound to a Device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to view Network Interfaces.

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getNetworkInterfaceResource(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to view Network Interfaces. | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**[DeviceInterface]**](DeviceInterface.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="getPowerResource"></a>
# **getPowerResource**
> DevicePower getPowerResource(deviceId, , opts)

Get device's current power status

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getPowerResource(deviceId, , opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DevicePower**](DevicePower.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="postDeviceIpmiWhitelistResource"></a>
# **postDeviceIpmiWhitelistResource**
> postDeviceIpmiWhitelistResource(deviceId, payload)

Add a public IP on IPMI whitelist

Returns IPMI public IP

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of the Device to put IP in Whitelist

var payload = new HivelocityApi.DeviceIPMIWhitelistIP(); // DeviceIPMIWhitelistIP | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.postDeviceIpmiWhitelistResource(deviceId, payload, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of the Device to put IP in Whitelist | 
 **payload** | [**DeviceIPMIWhitelistIP**](DeviceIPMIWhitelistIP.md)|  | 

### Return type

null (empty response body)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="postDeviceReloadResource"></a>
# **postDeviceReloadResource**
> ServiceOption postDeviceReloadResource(deviceId, payload, opts)

Reload any SPS Device with any available OS

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | 

var payload = new HivelocityApi.DeviceReload(); // DeviceReload | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postDeviceReloadResource(deviceId, payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**|  | 
 **payload** | [**DeviceReload**](DeviceReload.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**ServiceOption**](ServiceOption.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="postPowerResource"></a>
# **postPowerResource**
> DevicePower postPowerResource(deviceId, action, opts)

Apply action to device power

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var action = "action_example"; // String | Must be one of boot|reboot|shutdown

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postPowerResource(deviceId, action, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **action** | **String**| Must be one of boot|reboot|shutdown | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DevicePower**](DevicePower.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="putClientDeviceTagOrderResource"></a>
# **putClientDeviceTagOrderResource**
> DeviceTag putClientDeviceTagOrderResource(payload, opts)

Update device tags order for current user

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var payload = new HivelocityApi.DeviceTag(); // DeviceTag | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putClientDeviceTagOrderResource(payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **payload** | [**DeviceTag**](DeviceTag.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="putDeviceIdResource"></a>
# **putDeviceIdResource**
> Device putDeviceIdResource(deviceId, payload, opts)

Updates Device MetaData for a Single Device

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var payload = new HivelocityApi.DeviceUpdate(); // DeviceUpdate | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putDeviceIdResource(deviceId, payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **payload** | [**DeviceUpdate**](DeviceUpdate.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**Device**](Device.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="putDeviceTagIdResource"></a>
# **putDeviceTagIdResource**
> DeviceTag putDeviceTagIdResource(deviceId, payload, opts)

Update device tags

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View / Update

var payload = new HivelocityApi.DeviceTag(); // DeviceTag | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putDeviceTagIdResource(deviceId, payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View / Update | 
 **payload** | [**DeviceTag**](DeviceTag.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceTag**](DeviceTag.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="putIpmiDevicesThresholdsIdResource"></a>
# **putIpmiDevicesThresholdsIdResource**
> DevicesIPMIThresholds putIpmiDevicesThresholdsIdResource(payload, opts)

Updates IPMI thresholds for device list

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var payload = new HivelocityApi.UpdateDevicesIPMIThresholds(); // UpdateDevicesIPMIThresholds | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putIpmiDevicesThresholdsIdResource(payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **payload** | [**UpdateDevicesIPMIThresholds**](UpdateDevicesIPMIThresholds.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DevicesIPMIThresholds**](DevicesIPMIThresholds.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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

<a name="putIpmiThresholdsIdResource"></a>
# **putIpmiThresholdsIdResource**
> DeviceIPMIThresholds putIpmiThresholdsIdResource(deviceId, payload, opts)

Updates IPMI thresholds data

### Example
```javascript
var HivelocityApi = require('hivelocity_api');
var defaultClient = HivelocityApi.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 = 'Token';

var apiInstance = new HivelocityApi.DeviceApi();

var deviceId = 56; // Number | ID of Device to View

var payload = new HivelocityApi.DeviceIPMIThresholds(); // DeviceIPMIThresholds | 

var opts = { 
  'xFields': "xFields_example" // String | An optional fields mask
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.putIpmiThresholdsIdResource(deviceId, payload, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **Number**| ID of Device to View | 
 **payload** | [**DeviceIPMIThresholds**](DeviceIPMIThresholds.md)|  | 
 **xFields** | **String**| An optional fields mask | [optional] 

### Return type

[**DeviceIPMIThresholds**](DeviceIPMIThresholds.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

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