hivelocity_api v2.0.0

hivelocity_api

HivelocityApi - JavaScript client for hivelocity_api Interact with Hivelocity This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.0
• Package version: 2.0
• Build package: io.swagger.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 hivelocity_api --save

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

Finally, switch to the directory you want to use your hivelocity_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('hivelocity_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/hivelocity_api then install it via:

    npm install YOUR_USERNAME/hivelocity_api --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, that's to say your javascript file where you actually use this library):

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 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['X-API-KEY'] = "Token"

var api = new HivelocityApi.BandwidthApi()

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

var period = "day"; // {String} Preconfigured Time Periods for Graph Data

var _interface = "eth0"; // {String} Network Interface to use for Graph Data

var opts = { 
  'start': 0, // {Number} Start Time of Custom Time Period. (Unix Epoch Time)
  'end': 1635778021, // {Number} End Time of Custom Time Period (Unix Epoch Time)
  '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);
  }
};
api.postDeviceIdBandwidthImageResource(deviceId, period, _interface, opts, callback);

Documentation for API Endpoints

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

Documentation for Models

• HivelocityApi.AAAARecordCreate
• HivelocityApi.AAAARecordReturn
• HivelocityApi.AAAARecordUpdate
• HivelocityApi.ARecordCreate
• HivelocityApi.ARecordReturn
• HivelocityApi.ARecordUpdate
• HivelocityApi.Bandwidth
• HivelocityApi.BandwidthImage
• HivelocityApi.BareMetalDevice
• HivelocityApi.BareMetalDeviceCreate
• HivelocityApi.BareMetalDeviceUpdate
• HivelocityApi.BasicProfile
• HivelocityApi.BillingInfo
• HivelocityApi.BillingInfoVerification
• HivelocityApi.Cancellation
• HivelocityApi.CancellationCreate
• HivelocityApi.CityStateCountry
• HivelocityApi.Client
• HivelocityApi.ContactCreate
• HivelocityApi.ContactDump
• HivelocityApi.ContactUpdate
• HivelocityApi.CreateCredit
• HivelocityApi.Credit
• HivelocityApi.Deployment
• HivelocityApi.DeploymentCustomization
• HivelocityApi.DeploymentStart
• HivelocityApi.DetailedNullIP
• HivelocityApi.Device
• HivelocityApi.DeviceEvent
• HivelocityApi.DeviceIPMIInfo
• HivelocityApi.DeviceIPMIThresholds
• HivelocityApi.DeviceIPMIWhitelistIP
• HivelocityApi.DeviceInitialCreds
• HivelocityApi.DeviceInterface
• HivelocityApi.DevicePassword
• HivelocityApi.DevicePower
• HivelocityApi.DeviceReload
• HivelocityApi.DeviceTag
• HivelocityApi.DeviceUpdate
• HivelocityApi.DevicesIPMIThresholds
• HivelocityApi.DomainCreate
• HivelocityApi.DomainReturn
• HivelocityApi.Hardware
• HivelocityApi.IPMIInfo
• HivelocityApi.IPMILoginData
• HivelocityApi.IPMISensor
• HivelocityApi.IPMIValidLogin
• HivelocityApi.Inventory
• HivelocityApi.Invoice
• HivelocityApi.InvoiceDetails
• HivelocityApi.InvoiceDetailsServiceItems
• HivelocityApi.InvoicePDF
• HivelocityApi.InvoiceSeachResult
• HivelocityApi.InvoiceUnpaid
• HivelocityApi.Location
• HivelocityApi.MXRecordCreate
• HivelocityApi.MXRecordReturn
• HivelocityApi.MXRecordUpdate
• HivelocityApi.NetworkTask
• HivelocityApi.Option
• HivelocityApi.Options
• HivelocityApi.OrderDump
• HivelocityApi.PTRRecordReturn
• HivelocityApi.PTRRecordUpdate
• HivelocityApi.Password
• HivelocityApi.PasswordRequest
• HivelocityApi.PasswordResponse
• HivelocityApi.Permission
• HivelocityApi.PermissionReturn
• HivelocityApi.ProductInfo
• HivelocityApi.ProductMatch
• HivelocityApi.ProductOption
• HivelocityApi.Profile
• HivelocityApi.ProfileUpdate
• HivelocityApi.PublicApiTokenDump
• HivelocityApi.PublicApiTokenLoad
• HivelocityApi.ServiceDump
• HivelocityApi.ServiceOption
• HivelocityApi.SshKey
• HivelocityApi.SshKeyResponse
• HivelocityApi.SshKeyUpdate
• HivelocityApi.Stock
• HivelocityApi.Ticket
• HivelocityApi.TicketAttach
• HivelocityApi.TicketCreate
• HivelocityApi.TicketCreateReply
• HivelocityApi.TicketPost
• HivelocityApi.TicketPut
• HivelocityApi.TicketSeachResult
• HivelocityApi.TotalActiveCredit
• HivelocityApi.UpdateDevicesIPMIThresholds
• HivelocityApi.Vlan
• HivelocityApi.VlanCreate
• HivelocityApi.Webhook
• HivelocityApi.WebhookCreate
• HivelocityApi.WebhookEvent
• HivelocityApi.WebhookUpdate

Documentation for Authorization

apiKey

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header