This OpenAPI Specification allows anyone to build new API clients against the UpCloud API using Swagger.
You can use either one of these two dependency management tools, Yarn or npm, to install all necessary packages.
To install Yarn itself, follow the instructions applicable to your operating system.
Then run the command below to download and install the required dependencies.
$ yarn
npm is distributed together with Node.js which you can download from their web site.
With npm ready to go, use the following command to resolve the dependencies.
$ npm install
Init swagger codegen after cloning the project with the following commands.
$ git submodule init
$ git submodule update
$ cd swagger-codegen
$ mvn clean package
Ideally the base URL for all API operations should be 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.
$ yarn dev
or
$ npm run dev
$ yarn start
or
$ npm start
Swagger provides documentation on the OpenAPI Specification.
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.
This project is distributed under the MIT License, see LICENSE.txt for more information.