upcloud-api
Version:
A JavaScript Client for the UpCloud API
513 lines (459 loc) • 12.7 kB
JavaScript
/*
upcloud-api: A Node JS module providing a client for th UpCloud API.
Version: 1.0.5
Author: @likeablegeek (https://likeablegeek.com/)
Distributed by: FlightSim Ninja (http://flightim.ninja)
Copyright 2021.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/*****
* Import required modules
*/
const request = require("request");
/****
* Define upcloud-api object
*/
let uc = {
/*****
* Global variables
*/
user: "",
pass: "",
host: "api.upcloud.com",
ver: "1.3",
/*****
* Module name
*/
name: "upcloud-api", // Module name
/*****
* API manifest
*/
manifest: {
// Server Commands
listServerConfs: {
type: "GET",
path: "server_size"
},
listServers: {
type: "GET",
path: "server"
},
serverDetails: {
type: "GET",
path: "server/[serveruuid]"
},
createServer: {
type: "POST",
path: "server"
},
modifyServer: {
type: "PUT",
path: "server/[serveruuid]"
},
startServer: {
type: "POST",
path: "server/[serveruuid]/start"
},
stopServer: {
type: "POST",
path: "server/[serveruuid]/stop"
},
restartServer: {
type: "POST",
path: "server/[serveruuid]/restart"
},
cancelServerOperation: {
type: "POST",
path: "server/[serveruuid]/cancel"
},
deleteServer: {
type: "DELETE",
path: "server/[serveruuid]?storages=[storageaction]&backups=[backupaction]"
},
// Storage Commands
storageDetails: {
type: "GET",
path: "storage/[storageuuid]"
},
listTemplates: {
type: "GET",
path: "storage/template"
},
listStorages: {
type: "GET",
path: "storage"
},
listStoragesByType: {
type: "GET",
path: "storage/[storagetype]"
},
listCDROMs: {
type: "GET",
path: "storage/cdrom"
},
createStorage: {
type: "POST",
path: "storage"
},
modifyStorage: {
type: "PUT",
path: "storage/[storageuuid]"
},
cloneStorage: {
type: "POST",
path: "storage/[storageuuid]/clone"
},
attachStorage: {
type: "POST",
path: "server/[serveruuid]/storage/attach"
},
detachStorage: {
type: "POST",
path: "server/[serveruuid]/storage/detach"
},
loadCDROM: {
type: "POST",
path: "server/[serveruuid]/cdrom/load"
},
ejectCDROM: {
type: "POST",
path: "server/[serveruuid]/cdrom/eject"
},
createStorageImport: {
type: "POST",
path: "storage/[storageuuid]/import"
},
storageImportDetails: {
type: "GET",
path: "storage/[storageuuid]/import"
},
cancelStorageImport: {
type: "POST",
path: "storage/[storageuuid]/import/cancel"
},
cancelStorageOperation: {
type: "POST",
path: "storage/[storageuuid]/cancel"
},
createStorageTemplate: {
type: "POST",
path: "storage/[storageuuid]/templatize"
},
createStorageBackup: {
type: "POST",
path: "storage/[storageuuid]/backup"
},
restoreStorageFromBackup: {
type: "POST",
path: "storage/[storageuuid]/restore"
},
addStorageToFavorites: {
type: "POST",
path: "storage/[storageuuid]/favorite"
},
removeStorageFromFavorites: {
type: "DELETE",
path: "storage/[storageuuid]/favorite"
},
deleteStorage: {
type: "DELETE",
path: "storage/[storageuuid]?&backups=[backupaction]"
},
// Plan Commands
listPlans: {
type: "GET",
path: "plan"
},
// Zone Commands
listZones: {
type: "GET",
path: "zone"
},
// Price Commands
listPrices: {
type: "GET",
path: "price"
},
// Account Commands
accountInfo: {
type: "GET",
path: "account"
},
listAccounts: {
type: "GET",
path: "account/list"
},
accountDetails: {
type: "GET",
path: "account/details/[username]"
},
modifyAccount: {
type: "PUT",
path: "account/details/[username]"
},
createSubaccount: {
type: "POST",
path: "account/sub"
},
deleteSubaccount: {
type: "DELETE",
path: "account/sub/[username]"
},
billingSummary: {
type: "GET",
path: "account/billing_summary/[yyyy]-[mm]"
},
billingDetails: {
type: "GET",
path: "account/billing_summary/[yyyy]-[mm]/detailed"
},
billingResource: {
type: "GET",
path: "account/resource_billing_summary/[resourceuuid]/[yyyy]-[mm]"
},
networkUsage: {
type: "GET",
path: "account/network_usage/?from=[from]&to=[to]&accumulate=[duration]"
},
resourceNetworkUsage: {
type: "GET",
path: "account/resource_network_usage/?from=[from]&to=[to]&accumulate=[duration]&resource_id=[resourceuuid]"
},
currentNetworkUsage: {
type: "GET",
path: "account/current_network_usage"
},
// IP Address Commands
listAddresses: {
type: "GET",
path: "ip_address"
},
addressDetails: {
type: "GET",
path: "ip_address/[address]"
},
assignAddress: {
type: "POST",
path: "ip_address"
},
modifyAddress: {
type: "PATCH",
path: "ip_address/[address]"
},
releaseAddress: {
type: "DELETE",
path: "ip_address/[address]"
},
// Firewall Commands
listRules: {
type: "GET",
path: "server/[serveruuid]/firewall_rule"
},
ruleDetails: {
type: "GET",
path: "server/[serveruuid]/firewall_rule/[index]"
},
createRule: {
type: "POST",
path: "server/[serveruuid]/firewall_rule"
},
createRules: {
type: "PUT",
path: "server/[serveruuid]/firewall_rule"
},
removeRule: {
type: "DELETE",
path: "server/[serveruuid]/firewall_rule/[index]"
},
// Tag Comands
listTags: {
type: "GET",
path: "tag"
},
createTag: {
type: "POST",
path: "tag"
},
modifyTag: {
type: "PUT",
path: "tag/[tag]"
},
deleteTag: {
type: "PUT",
path: "tag/[tag]"
},
assignTags: {
type: "POST",
path: "server/[serveruuid]/tag/[tags]"
},
removeTags: {
type: "POST",
path: "server/[serveruuid]/untag/[tags]"
},
// Host Commands
listHosts: {
type: "GET",
path: "host"
},
hostDetails: {
type: "GET",
path: "host/[hostid]"
},
modifyHost: {
type: "PATCH",
path: "host/[hostid]"
},
// Network Commands
listNetworks: {
type: "GET",
path: "network"
},
listNetworksByZone: {
type: "GET",
path: "network/?zone=[zone]"
},
listNetworksByServer: {
type: "GET",
path: "server/[serveruuid]/networking"
},
networkDetails: {
type: "GET",
path: "network/[networkuuid]"
},
modifyNetwork: {
type: "POST",
path: "network/[networkuuid]"
},
createPrivateNetwork: {
type: "POST",
path: "network"
},
deleteNetwork: {
type: "DELETE",
path: "network/[networkuuid]"
},
createInterface: {
type: "POST",
path: "server/[serveruuid]/networking/interface"
},
modifyInterace: {
type: "PUT",
path: "server/[serveruuid]/networking/interface/[interface]"
},
deleteInterface: {
type: "DELETE",
path: "server/[serveruuid]/networking/interface/[interface]"
},
listRouters: {
type: "GET",
path: "router"
},
routerDetails: {
type: "GET",
path: "router/[routeruuid]"
},
createRouter: {
type: "POST",
path: "router"
},
modifyRouter: {
type: "PATCH",
path: "router/[routeruuid]"
},
deleteRouter: {
type: "DELETE",
path: "router/[routeruuid]"
},
// Object Storage Commands
listObjectStorages: {
type: "GET",
path: "object-storage"
},
objectStorageDetails: {
type: "GET",
path: "object-storage/[objectuuid]"
},
createObjectStorage: {
type: "POST",
path: "object-storage"
},
modifyObjectStorage: {
type: "PATCH",
path: "object-storage/[objectuuid]"
},
deleteObjectStorage: {
type: "DELETE",
path: "object-storage/[objectuuid]"
},
objectStorageNetworkUsage: {
type: "GET",
path: "object-storage/[objectuuid]/stats/network/?from=[from]&to=[to]"
},
},
/*****
* Utility function for issuing API calls
*/
call: (cmd, params = {}, data = {}, callback = () => {}) => {
let fn = request.get; // GET is default requesst type
switch(uc.manifest[cmd].type) {
case "GET":
fn = request.get;
break;
case "POST":
fn = request.post;
break;
case "PUT":
fn = request.put;
break;
case "PATCH":
fn = request.patch;
break;
case "DELETE":
fn = request.del;
break;
}
let path = uc.manifest[cmd].path;
for (param in params) {
path = path.replace("[" + param + "]", params[param]);
}
let options = {
url: "https://" + uc.host + "/" + uc.ver + "/" + path,
auth: {
username: uc.user,
password: uc.pass
}
};
if (uc.manifest[cmd].type == "POST" || uc.manifest[cmd].type == "PUT" || uc.manifest[cmd].type == "PATCH") {
options.json = true;
options.body = data;
}
fn(options, (err, res, body) => {
// Convert to string, parse as JSON
if (typeof(body) == "string" && body.length > 0) {
data = JSON.parse(body);
} else {
data = body;
}
// Call callback and pass data
callback(data);
});
},
/*****
* Initialise API
*/
init: (user, pass, ver = uc.ver, host = uc.host) => {
uc.user = user;
uc.pass = pass;
uc.ver = ver;
uc.host = host;
},
}
module.exports = uc;