@upcloud/upcloud v1.0.2

UpCloud JavaScript API client library

This is a Javascript API client library that provides integration with the UpCloud API. It allows cloud resource management on UpCloud's IaaS with easy to use functions. The API client follows the RESTful web service principles wherever possible.

The base URL for all API operations is https://api.upcloud.com/ and require basic authentication using UpCloud username and password. We recommend creating a subaccount dedicated for the API communication for security purposes. This allows you to restrict API access by servers, storages, and tags ensuring you will never accidentally affect critical systems.

Table of content

• Installation
• Usage
• Documentation
• Issues
• License

Installation

For Node.js

npm

Install it via:

npm install @upcloud/upcloud --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 upcloud from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

git

Install the library via git:

    npm install UpCloudLtd/upcloud-javascript-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
      }
    }
  ]
}

Usage

Please follow the installation instruction and execute the following JS code (NOTE: In real production applications you should use for example ENV variables instead of inserting credentials directly to code and to version control):

var upcloud = require('upcloud');

var defaultClient = upcloud.ApiClient.instance;

// Configure HTTP basic authorization: baseAuth
var baseAuth = defaultClient.authentications['baseAuth'];
baseAuth.username = 'UPCLOUD_USERNAME'
baseAuth.password = 'UPCLOUD_PASSWORD'

var api = new upcloud.AccountApi()
api.getAccount().then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation

All URIs are relative to https://api.upcloud.com/1.2

Documentation of the models

• upcloud.Account
• upcloud.AccountResponse
• upcloud.AddIpRequest
• upcloud.AddressFamily
• upcloud.AssignIpResponse
• upcloud.AttachStorageDeviceRequest
• upcloud.AvailablePlanListResponse
• upcloud.AvailablePlanListResponsePlans
• upcloud.BackupRule
• upcloud.CloneStorageRequest
• upcloud.ConfigurationListResponse
• upcloud.ConfigurationListResponseServerSizes
• upcloud.CreateBackupStorageRequest
• upcloud.CreateNewTagResponse
• upcloud.CreateServerRequest
• upcloud.CreateServerResponse
• upcloud.CreateStorageRequest
• upcloud.CreateStorageResponse
• upcloud.Error
• upcloud.ErrorCode
• upcloud.ErrorError
• upcloud.ErrorStatus
• upcloud.FirewallRule
• upcloud.FirewallRuleCreateResponse
• upcloud.FirewallRuleListResponse
• upcloud.FirewallRuleListResponseFirewallRules
• upcloud.FirewallRuleRequest
• upcloud.IpAddress
• upcloud.IpAddressListResponse
• upcloud.IpAddresses
• upcloud.ModifyIpRequest
• upcloud.ModifyStorageRequest
• upcloud.ModifyTagRequest
• upcloud.Plan
• upcloud.Price
• upcloud.PriceListResponse
• upcloud.PriceListResponsePrices
• upcloud.PriceZone
• upcloud.RestartServer
• upcloud.Server
• upcloud.ServerListResponse
• upcloud.ServerListResponseServers
• upcloud.ServerSize
• upcloud.ServerState
• upcloud.ServerStorageDevices
• upcloud.ServerTags
• upcloud.StopServer
• upcloud.StopServerRequest
• upcloud.Storage
• upcloud.StorageAccessType
• upcloud.StorageBackups
• upcloud.StorageDevice
• upcloud.StorageDeviceDetachRequest
• upcloud.StorageDeviceLoadRequest
• upcloud.StorageServers
• upcloud.StorageState
• upcloud.StorageTier
• upcloud.StorageType
• upcloud.SuccessStoragesResponse
• upcloud.SuccessStoragesResponseStorages
• upcloud.Tag
• upcloud.TagCreateRequest
• upcloud.TagListResponse
• upcloud.TagListResponseTags
• upcloud.TagServers
• upcloud.TemplitizeStorageRequest
• upcloud.Timezone
• upcloud.TimezoneListResponse
• upcloud.TimezoneListResponseTimezones
• upcloud.Zone
• upcloud.ZoneListResponse
• upcloud.ZoneListResponseZones

Documentation for authorization

Take care if storing usernames or passwords in files while developing API applications to avoid accidentally publishing your account credentials.

baseAuth

• Type: HTTP basic authentication
• Username: Your UpCloud API username
• Password: Your UpCloud API user's password

Issues

Found a bug, have a problem using the client, or anything else about the library you would want to mention? Open a new issue here to get in contact.

License

This project is distributed under the MIT License, see LICENSE.txt for more information.