{"_id":"@upcloud/upcloud","_rev":"34-38714a1ea604a6a0a80e2a519688d9e5","name":"@upcloud/upcloud","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@upcloud/upcloud","version":"1.0.0","keywords":["upcloud","cloud","wrapper","api","babel","es6"],"license":"MIT","_id":"@upcloud/upcloud@1.0.0","maintainers":[{"name":"ilari","email":"ilari@i28.fi"}],"homepage":"https://github.com/UpCloudLtd/upcloud-javascript-api","bugs":{"url":"https://github.com/UpCloudLtd/upcloud-javascript-api/issues"},"dist":{"shasum":"d7641ba8de6b561e523edf46bea632891f0c1baa","tarball":"https://registry.npmjs.org/@upcloud/upcloud/-/upcloud-1.0.0.tgz","integrity":"sha512-cWeHEfywK3fLPACqmydbvvd1G57Hh9bVqRdfT6VAi251UQXWgSGFR2t3WuQ4p3ZFjf7WRKJlBEMV3lwxhOtmkg==","signatures":[{"sig":"MEUCIQDCYVmDQZPSXWHStmK0sKwyUa1U+6PDNKbIvjXcq7GIJAIgSh9J+5obLcwpbZ/rfu7Wci/1s3q2bYbnuI0YXIjOwD8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"src/index.js","browser":{"fs":false},"gitHead":"0cc18b5cf85f2389667d0c2c5247e7dc2c7b07ec","scripts":{"test":"mocha --reguire babel-polyfill --require babel-register --recursive test","format":"prettier --single-quote --trailing-comma all --write \"{src,test}/**/*.js\""},"_npmUser":{"name":"ilari","email":"ilari@i28.fi"},"repository":{"url":"git+https://github.com/UpCloudLtd/upcloud-javascript-api.git","type":"git"},"_npmVersion":"5.6.0","description":"The JavaScript SDK for UpCloud's API","directories":{},"_nodeVersion":"9.4.0","dependencies":{"superagent":"3.5.2"},"devDependencies":{"mocha":"~5.0.0","sinon":"4.2.0","prettier":"^1.10.2","expect.js":"~0.3.1","babel-polyfill":"^6.26.0","babel-register":"^6.26.0","babel-preset-env":"^1.6.1","babel-preset-stage-3":"^6.24.1","mocha-parallel-tests":"^1.2.10"},"_npmOperationalInternal":{"tmp":"tmp/upcloud-1.0.0.tgz_1517397326348_0.9176927178632468","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@upcloud/upcloud","version":"1.0.2","keywords":["upcloud","cloud","wrapper","api","babel","es6"],"license":"MIT","_id":"@upcloud/upcloud@1.0.2","maintainers":[{"name":"vaykka666","email":"samir.alkurdi@upcloud.com"},{"name":"ilari","email":"ilari@i28.fi"},{"name":"mlackman","email":"mika.lackman@gmail.com"}],"homepage":"https://github.com/UpCloudLtd/upcloud-javascript-api","bugs":{"url":"https://github.com/UpCloudLtd/upcloud-javascript-api/issues"},"dist":{"shasum":"a5e551216cfb003dea61b569a66a66f23987fbda","tarball":"https://registry.npmjs.org/@upcloud/upcloud/-/upcloud-1.0.2.tgz","integrity":"sha512-HuXamGUKTkl4xHm8r526PHbh4Db0q8K44U/oUkstkPpdJv46ArMAuhW8uRgxE+9sstGMeHW2ASPUD0Co5cQZxw==","signatures":[{"sig":"MEYCIQCF723fO7IgkgJFxkud7ULPsteCPyD1HYK6TF9k+x46BwIhAN+rx2UtmEcP4Yt8MavWOXa81VZzek2MeMorTZ9rKJHI","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"src/index.js","browser":{"fs":false},"gitHead":"36aae1107f5ec09907c106895903612311a5b66c","scripts":{"test":"mocha --reguire babel-polyfill --require babel-register --recursive test","format":"prettier --single-quote --trailing-comma all --write \"{src,test}/**/*.js\""},"_npmUser":{"name":"ilari","email":"ilari@i28.fi"},"repository":{"url":"git+https://github.com/UpCloudLtd/upcloud-javascript-api.git","type":"git"},"_npmVersion":"5.6.0","description":"The JavaScript SDK for UpCloud's API","directories":{},"_nodeVersion":"9.4.0","dependencies":{"superagent":"3.7.0"},"devDependencies":{"mocha":"~5.0.0","sinon":"4.2.0","prettier":"^1.10.2","expect.js":"~0.3.1","babel-polyfill":"^6.26.0","babel-register":"^6.26.0","babel-preset-env":"^1.6.1","babel-preset-stage-3":"^6.24.1","mocha-parallel-tests":"^1.2.10"},"_npmOperationalInternal":{"tmp":"tmp/upcloud-1.0.2.tgz_1517586902301_0.5718244900926948","host":"s3://npm-registry-packages"}}},"time":{"created":"2018-01-31T11:15:26.498Z","modified":"2024-07-15T09:49:45.464Z","1.0.0":"2018-01-31T11:15:26.498Z","1.0.2":"2018-02-02T15:55:03.429Z"},"bugs":{"url":"https://github.com/UpCloudLtd/upcloud-javascript-api/issues"},"license":"MIT","homepage":"https://github.com/UpCloudLtd/upcloud-javascript-api","keywords":["upcloud","cloud","wrapper","api","babel","es6"],"repository":{"url":"git+https://github.com/UpCloudLtd/upcloud-javascript-api.git","type":"git"},"description":"The JavaScript SDK for UpCloud's API","maintainers":[{"email":"toni.ar.kangas@gmail.com","name":"kangasta"},{"email":"peknur@gmail.com","name":"peknur"},{"email":"ajk@ajk.fi","name":"darep"},{"email":"juha-pekka.jarvenpaa@upcloud.com","name":"jpjp"},{"email":"iivari.leinonen@upcloud.com","name":"iivari.leinonen"},{"email":"bachir.khiati@upcloud.com","name":"bachirkhiati-upcloud"}],"readme":"# UpCloud JavaScript API client library\n\n[![Build Status](https://travis-ci.org/UpCloudLtd/upcloud-javascript-api.svg?branch=master)](https://travis-ci.org/UpCloudLtd/upcloud-javascript-api) [![npm version](https://badge.fury.io/js/%40upcloud%2Fupcloud.svg)](https://badge.fury.io/js/%40upcloud%2Fupcloud) [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/UpCloudLtd/upcloud-javascript-api/blob/master/LICENSE)\n\nThis 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.\n\nThe 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](https://www.upcloud.com/support/server-tags-and-group-accounts/) 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.\n\n## Table of content\n* [Installation](#installation)\n* [Usage](#usage)\n* [Documentation](#documentation)\n* [Issues](#issues)\n* [License](#license)\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nInstall it via:\n\n```shell\nnpm install @upcloud/upcloud --save\n```\n\n##### Local development\n\nTo use the library locally without publishing to a remote npm registry, first install the dependencies by changing \ninto the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nFinally, switch to the directory you want to use your upcloud from, and run:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nYou should now be able to `require('upcloud')` in javascript files from the directory you ran the last \ncommand above from.\n\n#### git\n#\nInstall the library via git:\n\n```shell\n    npm install UpCloudLtd/upcloud-javascript-api --save\n```\n\n### For browser\n\nThe library also works in the browser environment via npm and [browserify](http://browserify.org/). After following\nthe above steps with Node.js and installing browserify with `npm install -g browserify`,\nperform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually \nuse this library):\n\n```shell\nbrowserify main.js > bundle.js\n```\n\nThen include *bundle.js* in the HTML pages.\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Usage\n\nPlease follow the [installation](#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):\n\n```javascript\nvar upcloud = require('upcloud');\n\nvar defaultClient = upcloud.ApiClient.instance;\n\n// Configure HTTP basic authorization: baseAuth\nvar baseAuth = defaultClient.authentications['baseAuth'];\nbaseAuth.username = 'UPCLOUD_USERNAME'\nbaseAuth.password = 'UPCLOUD_PASSWORD'\n\nvar api = new upcloud.AccountApi()\napi.getAccount().then(function(data) {\n  console.log('API called successfully. Returned data: ' + data);\n}, function(error) {\n  console.error(error);\n});\n\n\n```\n\n## Documentation\n\nAll URIs are relative to *https://api.upcloud.com/1.2*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*upcloud.AccountApi* | [**getAccount**](docs/AccountApi.md#getAccount) | **GET** /account | Account information\n*upcloud.FirewallApi* | [**createFirewallRule**](docs/FirewallApi.md#createFirewallRule) | **POST** /server/{serverId}/firewall_rule | Create firewall rule\n*upcloud.FirewallApi* | [**deleteFirewallRule**](docs/FirewallApi.md#deleteFirewallRule) | **DELETE** /server/{serverId}/firewall_rule/{firewallRuleNumber} | Remove firewall rule\n*upcloud.FirewallApi* | [**getFirewallRule**](docs/FirewallApi.md#getFirewallRule) | **GET** /server/{serverId}/firewall_rule/{firewallRuleNumber} | Get firewall rule details\n*upcloud.FirewallApi* | [**serverServerIdFirewallRuleGet**](docs/FirewallApi.md#serverServerIdFirewallRuleGet) | **GET** /server/{serverId}/firewall_rule | List firewall rules\n*upcloud.IPAddressApi* | [**addIp**](docs/IPAddressApi.md#addIp) | **POST** /ip_address | Assign IP address\n*upcloud.IPAddressApi* | [**deleteIp**](docs/IPAddressApi.md#deleteIp) | **DELETE** /ip_address/{ip} | Release IP address\n*upcloud.IPAddressApi* | [**getDetails**](docs/IPAddressApi.md#getDetails) | **GET** /ip_address/{ip} | Get IP address details\n*upcloud.IPAddressApi* | [**listIps**](docs/IPAddressApi.md#listIps) | **GET** /ip_address | List IP addresses\n*upcloud.IPAddressApi* | [**modifyIp**](docs/IPAddressApi.md#modifyIp) | **PUT** /ip_address/{ip} | Modify IP address\n*upcloud.PlanApi* | [**listPlans**](docs/PlanApi.md#listPlans) | **GET** /plan | List available plans\n*upcloud.PricesApi* | [**listPrices**](docs/PricesApi.md#listPrices) | **GET** /price | List prices\n*upcloud.ServerApi* | [**assignTag**](docs/ServerApi.md#assignTag) | **POST** /server/{serverId}/tag/{tagList} | Assign tag to a server\n*upcloud.ServerApi* | [**attachStorage**](docs/ServerApi.md#attachStorage) | **POST** /server/{serverId}/storage/attach | Attach storage\n*upcloud.ServerApi* | [**createFirewallRule**](docs/ServerApi.md#createFirewallRule) | **POST** /server/{serverId}/firewall_rule | Create firewall rule\n*upcloud.ServerApi* | [**createServer**](docs/ServerApi.md#createServer) | **POST** /server | Create server\n*upcloud.ServerApi* | [**deleteFirewallRule**](docs/ServerApi.md#deleteFirewallRule) | **DELETE** /server/{serverId}/firewall_rule/{firewallRuleNumber} | Remove firewall rule\n*upcloud.ServerApi* | [**deleteServer**](docs/ServerApi.md#deleteServer) | **DELETE** /server/{serverId} | Delete server\n*upcloud.ServerApi* | [**detachStorage**](docs/ServerApi.md#detachStorage) | **POST** /server/{serverId}/storage/detach | Detach storage\n*upcloud.ServerApi* | [**ejectCdrom**](docs/ServerApi.md#ejectCdrom) | **POST** /server/{serverId}/cdrom/eject | Eject CD-ROM\n*upcloud.ServerApi* | [**getFirewallRule**](docs/ServerApi.md#getFirewallRule) | **GET** /server/{serverId}/firewall_rule/{firewallRuleNumber} | Get firewall rule details\n*upcloud.ServerApi* | [**listServerConfigurations**](docs/ServerApi.md#listServerConfigurations) | **GET** /server_size | List server configurations\n*upcloud.ServerApi* | [**listServers**](docs/ServerApi.md#listServers) | **GET** /server | List of servers\n*upcloud.ServerApi* | [**loadCdrom**](docs/ServerApi.md#loadCdrom) | **POST** /server/{serverId}/storage/cdrom/load | Load CD-ROM\n*upcloud.ServerApi* | [**modifyServer**](docs/ServerApi.md#modifyServer) | **PUT** /server/{serverId} | Modify server\n*upcloud.ServerApi* | [**restartServer**](docs/ServerApi.md#restartServer) | **POST** /server/{serverId}/restart | Restart server\n*upcloud.ServerApi* | [**serverDetails**](docs/ServerApi.md#serverDetails) | **GET** /server/{serverId} | Get server details\n*upcloud.ServerApi* | [**serverServerIdFirewallRuleGet**](docs/ServerApi.md#serverServerIdFirewallRuleGet) | **GET** /server/{serverId}/firewall_rule | List firewall rules\n*upcloud.ServerApi* | [**startServer**](docs/ServerApi.md#startServer) | **POST** /server/{serverId}/start | Start server\n*upcloud.ServerApi* | [**stopServer**](docs/ServerApi.md#stopServer) | **POST** /server/{serverId}/stop | Stop server\n*upcloud.ServerApi* | [**untag**](docs/ServerApi.md#untag) | **POST** /server/{serverId}/untag/{tagName} | Remove tag from server\n*upcloud.StorageApi* | [**attachStorage**](docs/StorageApi.md#attachStorage) | **POST** /server/{serverId}/storage/attach | Attach storage\n*upcloud.StorageApi* | [**backupStorage**](docs/StorageApi.md#backupStorage) | **POST** /storage/{storageId}/backup | Create backup\n*upcloud.StorageApi* | [**cancelOperation**](docs/StorageApi.md#cancelOperation) | **POST** /storage/{storageId}/cancel | Cancel storage operation\n*upcloud.StorageApi* | [**cloneStorage**](docs/StorageApi.md#cloneStorage) | **POST** /storage/{storageId}/clone | Clone storage\n*upcloud.StorageApi* | [**createStorage**](docs/StorageApi.md#createStorage) | **POST** /storage | Create storage\n*upcloud.StorageApi* | [**deleteStorage**](docs/StorageApi.md#deleteStorage) | **DELETE** /storage/{storageId} | Delete storage\n*upcloud.StorageApi* | [**detachStorage**](docs/StorageApi.md#detachStorage) | **POST** /server/{serverId}/storage/detach | Detach storage\n*upcloud.StorageApi* | [**ejectCdrom**](docs/StorageApi.md#ejectCdrom) | **POST** /server/{serverId}/cdrom/eject | Eject CD-ROM\n*upcloud.StorageApi* | [**favoriteStorage**](docs/StorageApi.md#favoriteStorage) | **POST** /storage/{storageId}/favorite | Add storage to favorites\n*upcloud.StorageApi* | [**getStorageDetails**](docs/StorageApi.md#getStorageDetails) | **GET** /storage/{storageId} | Get storage details\n*upcloud.StorageApi* | [**listStorageTypes**](docs/StorageApi.md#listStorageTypes) | **GET** /storage/{type}/ | List of storages by type\n*upcloud.StorageApi* | [**listStorages**](docs/StorageApi.md#listStorages) | **GET** /storage | List of storages\n*upcloud.StorageApi* | [**loadCdrom**](docs/StorageApi.md#loadCdrom) | **POST** /server/{serverId}/storage/cdrom/load | Load CD-ROM\n*upcloud.StorageApi* | [**modifyStorage**](docs/StorageApi.md#modifyStorage) | **PUT** /storage/{storageId} | Modify storage\n*upcloud.StorageApi* | [**restoreStorage**](docs/StorageApi.md#restoreStorage) | **POST** /storage/{storageId}/restore | Restore backup\n*upcloud.StorageApi* | [**templatizeStorage**](docs/StorageApi.md#templatizeStorage) | **POST** /storage/{storageId}/templatize | Templatize storage\n*upcloud.StorageApi* | [**unfavoriteStorage**](docs/StorageApi.md#unfavoriteStorage) | **DELETE** /storage/{storageId}/favorite | Remove storage from favorites\n*upcloud.TagApi* | [**assignTag**](docs/TagApi.md#assignTag) | **POST** /server/{serverId}/tag/{tagList} | Assign tag to a server\n*upcloud.TagApi* | [**createTag**](docs/TagApi.md#createTag) | **POST** /tag | Create a new tag\n*upcloud.TagApi* | [**deleteTag**](docs/TagApi.md#deleteTag) | **DELETE** /tag/{tagName} | Delete tag\n*upcloud.TagApi* | [**listTags**](docs/TagApi.md#listTags) | **GET** /tag | List existing tags\n*upcloud.TagApi* | [**modifyTag**](docs/TagApi.md#modifyTag) | **PUT** /tag/{tagName} | Modify existing tag\n*upcloud.TagApi* | [**untag**](docs/TagApi.md#untag) | **POST** /server/{serverId}/untag/{tagName} | Remove tag from server\n*upcloud.TimezoneApi* | [**listTimezones**](docs/TimezoneApi.md#listTimezones) | **GET** /timezone | List timezones\n*upcloud.ZoneApi* | [**listZones**](docs/ZoneApi.md#listZones) | **GET** /zone | List available zones\n\n\n## Documentation of the models\n\n - [upcloud.Account](docs/Account.md)\n - [upcloud.AccountResponse](docs/AccountResponse.md)\n - [upcloud.AddIpRequest](docs/AddIpRequest.md)\n - [upcloud.AddressFamily](docs/AddressFamily.md)\n - [upcloud.AssignIpResponse](docs/AssignIpResponse.md)\n - [upcloud.AttachStorageDeviceRequest](docs/AttachStorageDeviceRequest.md)\n - [upcloud.AvailablePlanListResponse](docs/AvailablePlanListResponse.md)\n - [upcloud.AvailablePlanListResponsePlans](docs/AvailablePlanListResponsePlans.md)\n - [upcloud.BackupRule](docs/BackupRule.md)\n - [upcloud.CloneStorageRequest](docs/CloneStorageRequest.md)\n - [upcloud.ConfigurationListResponse](docs/ConfigurationListResponse.md)\n - [upcloud.ConfigurationListResponseServerSizes](docs/ConfigurationListResponseServerSizes.md)\n - [upcloud.CreateBackupStorageRequest](docs/CreateBackupStorageRequest.md)\n - [upcloud.CreateNewTagResponse](docs/CreateNewTagResponse.md)\n - [upcloud.CreateServerRequest](docs/CreateServerRequest.md)\n - [upcloud.CreateServerResponse](docs/CreateServerResponse.md)\n - [upcloud.CreateStorageRequest](docs/CreateStorageRequest.md)\n - [upcloud.CreateStorageResponse](docs/CreateStorageResponse.md)\n - [upcloud.Error](docs/Error.md)\n - [upcloud.ErrorCode](docs/ErrorCode.md)\n - [upcloud.ErrorError](docs/ErrorError.md)\n - [upcloud.ErrorStatus](docs/ErrorStatus.md)\n - [upcloud.FirewallRule](docs/FirewallRule.md)\n - [upcloud.FirewallRuleCreateResponse](docs/FirewallRuleCreateResponse.md)\n - [upcloud.FirewallRuleListResponse](docs/FirewallRuleListResponse.md)\n - [upcloud.FirewallRuleListResponseFirewallRules](docs/FirewallRuleListResponseFirewallRules.md)\n - [upcloud.FirewallRuleRequest](docs/FirewallRuleRequest.md)\n - [upcloud.IpAddress](docs/IpAddress.md)\n - [upcloud.IpAddressListResponse](docs/IpAddressListResponse.md)\n - [upcloud.IpAddresses](docs/IpAddresses.md)\n - [upcloud.ModifyIpRequest](docs/ModifyIpRequest.md)\n - [upcloud.ModifyStorageRequest](docs/ModifyStorageRequest.md)\n - [upcloud.ModifyTagRequest](docs/ModifyTagRequest.md)\n - [upcloud.Plan](docs/Plan.md)\n - [upcloud.Price](docs/Price.md)\n - [upcloud.PriceListResponse](docs/PriceListResponse.md)\n - [upcloud.PriceListResponsePrices](docs/PriceListResponsePrices.md)\n - [upcloud.PriceZone](docs/PriceZone.md)\n - [upcloud.RestartServer](docs/RestartServer.md)\n - [upcloud.Server](docs/Server.md)\n - [upcloud.ServerListResponse](docs/ServerListResponse.md)\n - [upcloud.ServerListResponseServers](docs/ServerListResponseServers.md)\n - [upcloud.ServerSize](docs/ServerSize.md)\n - [upcloud.ServerState](docs/ServerState.md)\n - [upcloud.ServerStorageDevices](docs/ServerStorageDevices.md)\n - [upcloud.ServerTags](docs/ServerTags.md)\n - [upcloud.StopServer](docs/StopServer.md)\n - [upcloud.StopServerRequest](docs/StopServerRequest.md)\n - [upcloud.Storage](docs/Storage.md)\n - [upcloud.StorageAccessType](docs/StorageAccessType.md)\n - [upcloud.StorageBackups](docs/StorageBackups.md)\n - [upcloud.StorageDevice](docs/StorageDevice.md)\n - [upcloud.StorageDeviceDetachRequest](docs/StorageDeviceDetachRequest.md)\n - [upcloud.StorageDeviceLoadRequest](docs/StorageDeviceLoadRequest.md)\n - [upcloud.StorageServers](docs/StorageServers.md)\n - [upcloud.StorageState](docs/StorageState.md)\n - [upcloud.StorageTier](docs/StorageTier.md)\n - [upcloud.StorageType](docs/StorageType.md)\n - [upcloud.SuccessStoragesResponse](docs/SuccessStoragesResponse.md)\n - [upcloud.SuccessStoragesResponseStorages](docs/SuccessStoragesResponseStorages.md)\n - [upcloud.Tag](docs/Tag.md)\n - [upcloud.TagCreateRequest](docs/TagCreateRequest.md)\n - [upcloud.TagListResponse](docs/TagListResponse.md)\n - [upcloud.TagListResponseTags](docs/TagListResponseTags.md)\n - [upcloud.TagServers](docs/TagServers.md)\n - [upcloud.TemplitizeStorageRequest](docs/TemplitizeStorageRequest.md)\n - [upcloud.Timezone](docs/Timezone.md)\n - [upcloud.TimezoneListResponse](docs/TimezoneListResponse.md)\n - [upcloud.TimezoneListResponseTimezones](docs/TimezoneListResponseTimezones.md)\n - [upcloud.Zone](docs/Zone.md)\n - [upcloud.ZoneListResponse](docs/ZoneListResponse.md)\n - [upcloud.ZoneListResponseZones](docs/ZoneListResponseZones.md)\n\n\n## Documentation for authorization\n\nTake care if storing usernames or passwords in files while developing API applications to avoid accidentally publishing your account credentials.\n\n### baseAuth\n\n- **Type**: HTTP basic authentication\n- **Username**: Your UpCloud API username\n- **Password**: Your UpCloud API user's password\n\n\n## Issues\n\nFound a bug, have a problem using the client, or anything else about the library you would want to mention? [Open a new issue here](https://github.com/UpCloudLtd/upcloud-javascript-api/issues/new) to get in contact.\n\n\n## License\n\nThis project is distributed under the [MIT License](https://opensource.org/licenses/MIT), see LICENSE.txt for more information.\n","readmeFilename":"README.md"}