Skip to content
Vultr Node API client
JavaScript
Branch: master
Clone or download
Latest commit 3c3c975 Oct 18, 2019

README.md

Build Status codecov npm version license

vultr-node

Official Vultr client node module.

Installation

npm install @vultr/vultr-node

Usage

Vultr uses a PAT (Personal Access token) to interact/authenticate with the APIs. An API Key can be generated and acquired from the API menu in settings.

Initialize

const VultrNode = require('@vultr/vultr-node')

// Initialize the instance with your configuration
const vultr = VultrNode.initialize({
  apiKey: 'your-api-key-here',
  baseUrl: 'https://example.com', // Optional
  rateLimit: 600 // Optional
})

Calling Endpoints

// Call endpoints using Promises
vultr.account.getInfo().then(response => {
  console.log(response)
})

Versioning

This project follows SemVer for versioning. For the versions available, see the tags on this repository

Documentation

This implements the V1 Vultr API. For documentation on all endpoints, please visit https://www.vultr.com/api/

For documentation specific to this client please visit https://vultr.github.io/vultr-node

Contributing

Feel free to send pull requests our way! Please see the contributing guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

You can’t perform that action at this time.