Package Exports
- @vultr/vultr-node
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@vultr/vultr-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
NodeVultr
Official Vultr client node module.
Installation
npm install 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-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.info().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/
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.