# HivelocityApi.NetworkApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**getNetworkTaskClientResource**](NetworkApi.md#getNetworkTaskClientResource) | **GET** /network/status/ | Returns the Last Status for a long running Network Task, such as modifying a VLAN
[**getNetworkTaskDeviceResource**](NetworkApi.md#getNetworkTaskDeviceResource) | **GET** /network/status/{deviceId} | Returns the Last Status for a long running Network Task, such as modifying a VLAN
[**getNullRouteResource**](NetworkApi.md#getNullRouteResource) | **GET** /network/null/{ip} | Null route an IP
[**getRemoveNullRouteResource**](NetworkApi.md#getRemoveNullRouteResource) | **GET** /network/unnull/{ip} | Remove null route from an IP
[**postDetailedNullRouteResource**](NetworkApi.md#postDetailedNullRouteResource) | **POST** /network/null | Null route an IP (with custom comments)


<a name="getNetworkTaskClientResource"></a>
# **getNetworkTaskClientResource**
> [NetworkTask] getNetworkTaskClientResource(opts)

Returns the Last Status for a long running Network Task, such as modifying a VLAN

### 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.NetworkApi();

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.getNetworkTaskClientResource(opts, callback);
```

### Parameters

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

### Return type

[**[NetworkTask]**](NetworkTask.md)

### Authorization

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

### HTTP request headers

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

<a name="getNetworkTaskDeviceResource"></a>
# **getNetworkTaskDeviceResource**
> NetworkTask getNetworkTaskDeviceResource(deviceId, opts)

Returns the Last Status for a long running Network Task, such as modifying a VLAN

### 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.NetworkApi();

var deviceId = 56; // Number | 

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.getNetworkTaskDeviceResource(deviceId, opts, callback);
```

### Parameters

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

### Return type

[**NetworkTask**](NetworkTask.md)

### Authorization

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

### HTTP request headers

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

<a name="getNullRouteResource"></a>
# **getNullRouteResource**
> getNullRouteResource(ip)

Null route an 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.NetworkApi();

var ip = "ip_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ip** | **String**|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="getRemoveNullRouteResource"></a>
# **getRemoveNullRouteResource**
> getRemoveNullRouteResource(ip)

Remove null route from an 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.NetworkApi();

var ip = "ip_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ip** | **String**|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="postDetailedNullRouteResource"></a>
# **postDetailedNullRouteResource**
> postDetailedNullRouteResource(payload)

Null route an IP (with custom comments)

### 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.NetworkApi();

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **payload** | [**DetailedNullIP**](DetailedNullIP.md)|  | 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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