@vultr/vultr-node
v2.8.0
Published
Node module to communicate with the Vultr API
Downloads
913
Readme
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.getAccountInfo().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 Vultr API V2. For documentation on all endpoints, please visit https://www.vultr.com/api/. To use Vultr API V1, please use the version of the library on the V1 branch, or any version of this library before 2.0.0.
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.