npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

upcloud-api

v0.0.7

Published

A JavaScript Client for the UpCloud API

Downloads

18

Readme

upcloud-api

A Javascript client for the UpCloud API

Table of Contents

Installing upcloud-api

upcloud-api is available as a Node module on npmjs.com and can simply be installed with:

npm install upcloud-api

Including upcloud-api in your scripts/applications

To use upcloud-api you need to include it in your scripts:

const uc = require("upcloud-api");

Or, if you aren't installing with npm, you can simply clone this repository and directly reference upcloud-api.js:

const uc = require("/path/to/upcloud-api.js");

Initialisation

To initialise upcloud-api you need an UpCloud username and password for an account or subaccount with permission to access the UpCloud API. You can learn more about creating accounts with API permission in Upcloud's documentation.

Once you have the appropriate username and password you can initialise upcloud-api with:

uc.init(USERNAME_GOES_HERE,PASSWORD_GOES_HERE);

Scope and Roadmap

This is an early pre-release of upcloud-api with some limitations:

  1. There is no error handling yet in upcloud-api so if you fail to authenticate, fail to connect to the UpCloud API or there is an error in the data passed to the API, upcloud-api may fail without any error handling and your script will terminate with an error.

This version currently uses version 1.3 of the UpCloud API.

Invoking the API

All interaction with the API through upcloud-api is done through the call method of upcloud-api. The syntax for the call method is:

uc.call(COMMAND_NAME, PARAMETERS, POST_DATA, CALLBACK_FUNCTION);

The four arguments are:

  • COMMAND_NAME: The name of an upcloud-api command as discussed below.
  • PARAMETERS: An object containing one or more parameters required by the command being invoked.
  • DATA: An object containing data to be sent as JSON in a POST request to the UpCloud API for commands which require POST requests with JSON data in the body of the request. To determine what data to send in a POST request, refer to the UpCloud API documentation.
  • CALLBACK_FUNCTION: A function to invoke when the UpCloud API responds to the command. Three arguments will be sent to a single function containing the JSON object returned by the UpCloud API.

For instance, to retrieve a list of servers you could use:

uc.call("listServers", {}, {}, (res) => {
  console.log(res);
});

Or, to retrieve a server's specific details:

uc.call("serverDetails", { serveruuid: SERVER_UUID_HERE }, {}, (res) => {
  console.log(res);
});

Or, to attach storage to a server:

uc.call("createServer", { serveruuid: SERVER_UUID_HERE }, {
  storage_device": {
    type: "disk",
    address: "virtio",
    storage: "STORAGE_RESOURCE_UUID_HERE",
    boot_disk: 0
  }
}, (res) => {
  console.log(res);
});

Commands

Server Commands

listServerConfs

Description: Request a list of available server configurations

UpCloud API Endpoint: https://api.upcloud.com/1.3/server_size

Request Type: GET

Parameters: None

listServers

Description: Requests a list of servers

UpCloud API Endpoint: https://api.upcloud.com/1.3/server

Request Type: GET

Parameters: None

serverDetails

Description: Request details of a specific server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server

Request Type: GET

Parameters:

  • serveruuid: UUID for the server

createServer

Description: Create a new server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

modifyServer

Description: Modify configuration of an existing server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server

Request Type: PUT

Parameters:

  • serveruuid: UUID for the server

PUT Data: See the UpCloud API documentation

startServer

Description: Start a stopped server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/start

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

stopServer

Description: Stop a running server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/stop

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

restartServer

Description: Restart a running server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/restart

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

cancelServerOperation

Description: Cancel a running operation on a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/cancel

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: None

deleteServer

Description: Delete a stopped server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]?storages=[storageaction]&backups=[backupaction]

Request Type: DELETE

Parameters:

  • serveruuid: UUID for the server
  • storageaction: Indicates whether to delete attached storage resources -- possible values are:
    • 0 or false: Don't delete attached storage resources
    • 1 or true: Delete attached storage resources
  • backupaction: Indicates whether to keep backups of deleted storage resources -- possible values are:
    • keep: Keep all backups
    • keep_latest: Keep latest backup
    • delete: Delete backups

Storage Commands

storageDetails

Description: Request details of a specific storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage

Request Type: GET

Parameters:

  • storageuuid: UUID for the storage resource

listTemplates

Description: Requests a list of storage templates

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/template

Request Type: GET

Parameters: None

listStorages

Description: Requests a list of active storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage

Request Type: GET

Parameters: None

listStoragesByType

Description: Requests a list of active storage resources by type

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[TYPE]

Request Type: GET

Parameters:

  • storagetype: The type of storage resources to return in the list -- possible values are:
    • public
    • private
    • normal
    • backups
    • cdrom
    • template
    • favorite

listCDROMs

Description: Requests a list of available CDROM images

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/cdrom

Request Type: GET

Parameters: None

createStorage

Description: Create a new storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

modifyStorage

Description: Change configuration of a storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]

Request Type: PUT

Parameters:

  • storageuuid: UUID for the storage resource

PUT Data: See the UpCloud API documentation

cloneStorage

Description: Clone a storage template to a new storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/clone

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

attachStorage

Description: Attach a storage resource to a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/storage/attach

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

detachStorage

Description: Detach a storage resource from a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/storage/detach

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

loadCDROM

Description: Load a CDROM onto a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/cdrom/load

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

ejectCDROM

Description: Eject a CDROM from a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/cdrom/eject

Request Type: POST

Parameters:

  • serveruuid: UUID for the server

POST Data: See the UpCloud API documentation

createStorageImport

Description: Import data into an existing storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/import

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

storageImportDetails

Description: Get details of an ongoing or completed storage import task

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/import

Request Type: GET

Parameters:

  • storageuuid: UUID for the storage resource

cancelStorageImport

Description: Cancel a running storage import task

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/import/cancel

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

cancelStorageOperation

Description: Cancel a running storage cloning operation

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/cancel

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

createStorageTemplate

Description: Create a template from a storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/templatize

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

createStorageBackup

Description: Create a point-in-time backup of a storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/backup

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

restoreStorageFromBackup

Description: Restores a storage resource from its backup

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/restore

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

addStorageToFavorites

Description: Add a storage resource to the favorites list

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/favorite

Request Type: POST

Parameters:

  • storageuuid: UUID for the storage resource

POST Data: See the UpCloud API documentation

removeStorageFromFavorites

Description: Remove a storage resource from the favorites list

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]/favorite

Request Type: DELETE

Parameters:

  • storageuuid: UUID for the storage resource

deleteStorage

Description: Delete a storage resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/storage/[UUID]?backups=[backupaction]

Request Type: DELETE

Parameters:

  • storageuuid: UUID for the storage resource
  • backupaction: Indicates whether to keep backups of deleted storage resources -- possible values are:
    • keep: Keep all backups
    • keep_latest: Keep latest backup
    • delete: Delete backups

Plan Commands

listPlans

Description: Retrieve a list of simple server plans

UpCloud API Endpoint: https://api.upcloud.com/1.3/plan

Request Type: GET

Parameters: None

Zone Commands

listZones

Description: Retrieve a list of available zones

UpCloud API Endpoint: https://api.upcloud.com/1.3/zone

Request Type: GET

Parameters: None

Price Commands

listPrices

Description: Retrieve a list of resource prices

UpCloud API Endpoint: https://api.upcloud.com/1.3/price

Request Type: GET

Parameters: None

Account Commands

accountInfo

Description: Retrieve basic information forthe current user's account or subaccount

UpCloud API Endpoint: https://api.upcloud.com/1.3/account

Request Type: GET

Parameters: None

listAccounts

Description: Retrieve list of accounts and subaccounts for current organisation

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/list

Request Type: GET

Parameters: None

accountDetails

Description: Retrieve details of a named account or subaccount

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/details/[USERNAME]

Request Type: GET

Parameters:

  • username: The username of the account or subaccount

modifyAccount

Description: Modify details of a named account or subaccount

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/details/[USERNAME]

Request Type: PUT

Parameters:

  • username: The username of the account or subaccount

PUT Data: See the UpCloud API documentation

createSubaccount

Description: Create a subaccount

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/sub

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

deleteSubaccount

Description: Delete a named subaccount

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/sub/[USERNAME]

Request Type: DELETE

Parameters:

  • username: The username of the subaccount

billingSummary

Description: Get a billing summary for a specified month

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/billing_summary/[YYYY]-[MM]

Request Type: GET

Parameters:

  • yyyy: The four-digit year for the month being requested
  • mm: The two-digit month (including leading zero if needed) for the month being requested

billngDetails

Description: Get a detailed billing report for a specified month

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/billing_summary/[YYYY]-[MM]/detailed

Request Type: GET

Parameters:

  • yyyy: The four-digit year for the month being requested
  • mm: The two-digit month (including leading zero if needed) for the month being requested

billingResource

Description: Get a resource billing summary for a specified month for a specific resource

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/resource_billing_summary/[UUID]/[YYYY]-[MM]

Request Type: GET

Parameters:

  • resourceuuid: The UUID of the resource
  • yyyy: The four-digit year for the month being requested
  • mm: The two-digit month (including leading zero if needed) for the month being requested

networkUsage

Description: Get network usage for a period of time

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/network_usage/?from=[FROM]&to=[TO]&accumulate=[DURATION]

Request Type: GET

Parameters:

  • from: Timestamp for start of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)
  • to: Timestamp for end of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)
  • duration: Specifies time block for accumulating usage in the report -- possible values are:
    • day
    • hour

resourceNetworkUsage

Description: Get network usage for a specified resource for a period of time

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/resource_network_usage/?from=[FROM]&to=[TO]&accumulate=[DURATION]&resource_id=[UUID]

Request Type: GET

Parameters:

  • from: Timestamp for start of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)
  • to: Timestamp for end of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)
  • resourceuuid: UUID for the resource
  • duration: Specifies time block for accumulating usage in the report -- possible values are:
    • day
    • hour

currentNetworkUsage

Description: Get latest network transfer pool usage report

UpCloud API Endpoint: https://api.upcloud.com/1.3/account/current_network_usage

Request Type: GET

Parameters: None

IP Address Commands

listAddresss

Description: Get list of IP addresses assigned to servers in the account

UpCloud API Endpoint: https://api.upcloud.com/1.3/ip_address

Request Type: GET

Parameters: None

addressDetails

Description: Get detailed information about a specific IP address

UpCloud API Endpoint: https://api.upcloud.com/1.3/ip_address/[ADDRESS]

Request Type: GET

Parameters:

  • address: IP address such as 127.0.0.1

assignAddress

Description: Assign a new IP address to a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/ip_address

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

modifyAddress

Description: Modify an IP address

UpCloud API Endpoint: https://api.upcloud.com/1.3/ip_address/[ADDRESS]

Request Type: PATCH

Parameters:

  • address: IP address such as 127.0.0.1

PATCH Data: See the UpCloud API documentation

releaseAddress

Description: Release an IP address from a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/ip_address/[ADDRESS]

Request Type: DELETE

Parameters:

  • address: IP address such as 127.0.0.1

Firewall Commands

listRules

Description: Get list of firewall rules for a specified server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/firewall_rule

Request Type: GET

Parameters:

  • serveruuid: UUID of the server

ruleDetails

Description: Get details of a specific firewall rule for a specified rules

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/firewall_rule/[INDEX]

Request Type: GET

Parameters:

  • serveruuid: UUID of the server
  • index: Index of the rule in the list of firewall rules for the server (first entry is index 1)

createRule

Description: Create a firewall rule for a specified server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/firewall_rule

Request Type: POST

Parameters:

  • serveruuid: UUID of the server

POST Data: See the UpCloud API documentation

createRules

Description: Create multiple firewall rules for a specified server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/firewall_rule

Request Type: PUT

Parameters:

  • serveruuid: UUID of the server

PUT Data: See the UpCloud API documentation

removeRule

Description: Remove a specific firewall rule from a specified rules

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/firewall_rule/[INDEX]

Request Type: DELETE

Parameters:

  • serveruuid: UUID of the server
  • index: Index of the rule in the list of firewall rules for the server (first entry is index 1)

Tag Commands

listTags

Description: Get list of tags

UpCloud API Endpoint: https://api.upcloud.com/1.3/tag

Request Type: GET

Parameters: None

createTag

Description: Create a tag

UpCloud API Endpoint: https://api.upcloud.com/1.3/tag

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

createTag

Description: Modify a tag

UpCloud API Endpoint: https://api.upcloud.com/1.3/tag/[TAG]

Request Type: PUT

Parameters:

  • tag: Name of tag to modify

PUT Data: See the UpCloud API documentation

deleteTag

Description: Delete a tag

UpCloud API Endpoint: https://api.upcloud.com/1.3/tag/[TAG]

Request Type: DELETE

Parameters:

  • tag: Name of tag to modify

assignTags

Description: Assign one or more tags to a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/tag/[TAGS]

Request Type: POST

Parameters:

  • serveruuid: UUID of server
  • tags: Comma-separated list of tags to assign to server

POST Data: See the UpCloud API documentation

removeTags

Description: Remove one or more tags from a server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/untag/[TAGS]

Request Type: POST

Parameters:

  • serveruuid: UUID of server
  • tags: Comma-separated list of tags to assign to server

POST Data: See the UpCloud API documentation

Host Commands

listHosts

Description: Get list of available hosts

UpCloud API Endpoint: https://api.upcloud.com/1.3/host

Request Type: GET

Parameters: None

hostDetails

Description: Get details of a specified host

UpCloud API Endpoint: https://api.upcloud.com/1.3/host/[ID]

Request Type: GET

Parameters:

  • hostid: ID of host

modifyHost

Description: Modify description of a specified host

UpCloud API Endpoint: https://api.upcloud.com/1.3/host/[ID]

Request Type: PATCH

Parameters:

  • hostid: ID of host

PATCH Data: See the UpCloud API documentation

Network Commands

listNetworks

Description: Get list of networks

UpCloud API Endpoint: https://api.upcloud.com/1.3/network

Request Type: GET

Parameters: None

listNetworksByZone

Description: Get list of networks in a specific zone

UpCloud API Endpoint: https://api.upcloud.com/1.3/network/?zone=[ZONE]

Request Type: GET

Parameters:

  • zone: Zone name

listNetworksByServer

Description: Get list of networks a specific server is connected to

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/networking]

Request Type: GET

Parameters:

  • serveruuid: UUID of server

networkDetails

Description: Get details of a specific network

UpCloud API Endpoint: https://api.upcloud.com/1.3/network/[UUID]

Request Type: GET

Parameters:

  • networkuuid: UUID of network

modifyNetwork

Description: Modify details of a specific network

UpCloud API Endpoint: https://api.upcloud.com/1.3/network/[UUID]

Request Type: POST

Parameters:

  • networkuuid: UUID of network

POST Data: See the UpCloud API documentation

createPrivateNetwork

Description: Creates new SDN private network

UpCloud API Endpoint: https://api.upcloud.com/1.3/network

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

deleteNetwork

Description: Delete a specific network

UpCloud API Endpoint: https://api.upcloud.com/1.3/network/[UUID]

Request Type: DELETE

Parameters:

  • networkuuid: UUID of network

createInterface

Description: Creates new network interface on a specified server and connect it to an SDN private network

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/networking/interface

Request Type: POST

Parameters:

  • serveruuid: UUID of server

POST Data: See the UpCloud API documentation

modifyInterface

Description: Modifies details of a network interface on a specified server

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/networking/interface/[INDEX]

Request Type: PUT

Parameters:

  • serveruuid: UUID of server
  • interface: Index of the network interface from the server

PUT Data: See the UpCloud API documentation

deleteInterface

Description: Deletes a network interface on a specified server and disconencts from an SDN private network

UpCloud API Endpoint: https://api.upcloud.com/1.3/server/[UUID]/networking/interface/[INDEX]

Request Type: DELETE

Parameters:

  • serveruuid: UUID of server
  • interface: Index of the network interface from the server

listRouters

Description: Get list of routers

UpCloud API Endpoint: https://api.upcloud.com/1.3/route

Request Type: GET

Parameters: None

routerDetails

Description: Get details of a specified router

UpCloud API Endpoint: https://api.upcloud.com/1.3/route/[UUID]

Request Type: GET

Parameters:

  • routeruuid: UUID of router

createRouter

Description: Create a router

UpCloud API Endpoint: https://api.upcloud.com/1.3/route

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

modifyRouter

Description: Modify a router

UpCloud API Endpoint: https://api.upcloud.com/1.3/route/[UUID]

Request Type: PATCH

Parameters:

  • routeruuid: UUID of router

PATCH Data: See the UpCloud API documentation

deleteRouter

Description: Delete a router

UpCloud API Endpoint: https://api.upcloud.com/1.3/route/[UUID]

Request Type: DELETE

Parameters:

  • routeruuid: UUID of router

Object Storage Commands

ListObjectStorages

Description: Get list of object storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage

Request Type: GET

Parameters: None

objectStorageDetails

Description: Get details of an object storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage/[UUID]

Request Type: GET

Parameters:

  • objectuuid: UUID of object storage resources

createObjectStorage

Description: Create a new object storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage

Request Type: POST

Parameters: None

POST Data: See the UpCloud API documentation

modifyObjectStorage

Description: Modify an object storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage/[UUID]

Request Type: PATCH

Parameters:

  • objectuuid: UUID of object storage resources

PATCH Data: See the UpCloud API documentation

deleteObjectStorage

Description: Delete an object storage resources

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage/[UUID]

Request Type: DELETE

Parameters:

  • objectuuid: UUID of object storage resources

objectStorageNetworkUsage

Description: Get network usage of an object storage resource for a time range

UpCloud API Endpoint: https://api.upcloud.com/1.3/object-storage/[UUID]/stats/network/?from=[FROM]&to=[TO]

Request Type: GET

Parameters:

  • objectuuid: UUID of object storage resource
  • from: Timestamp for start of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)
  • to: Timestamp for end of time period in RFC 3339 format (YYYY-MM-DDTHH:MM:SSZ)

Dependencies

upcloud-api depends on the following npm/Node packages:

  • request - Simplified HTTP client for connecting to the UpCloud endpoints

Copyright and License

This version is upcloud-api Copyright 2021, @likeablegeek. Distributed by FlightSim Ninja.

You may not use this work/module/file except in compliance with the License. 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.