vultr/vultr-node

Vultr Node API client

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.

Authors

• Spencer Kordecki
• Fady Farid
• Glenn Dobson

vultr-node's Issues

Get Account Info

Gets account information based on your API Key

https://www.vultr.com/api/#account_info

Resize Block Storage

Resize a BS Instance

https://www.vultr.com/api/#block_resize

Detach ReservedIP

https://www.vultr.com/api/#reservedip_detach

Get Auth Info

Returns back information about your API Key

• email
• name
• array of access control list

https://www.vultr.com/api/#auth_info

List Snapshots

https://www.vultr.com/api/#snapshot_snapshot_list

Create Network

https://www.vultr.com/api/#network_create

Create SSH Key

Create SSH Key

https://www.vultr.com/api/#sshkey_create

Create from URL Snapshot

https://www.vultr.com/api/#snapshot_create_from_url

Delete SSH Key

Delete SSH key

https://www.vultr.com/api/#sshkey_destroy

List Network

https://www.vultr.com/api/#network_network_list

Set Label for Block Storage

Set the label for BS

https://www.vultr.com/api/#block_label_set

List BM Plans

https://www.vultr.com/api/#plans_plan_list_baremetal

Detach Block Storage

Detach a BS from VPS

https://www.vultr.com/api/#block_detach

Get user

There is no end point for this - We will need to loop through and find the one we want from the List endpoint

List VDC2 Plans

https://www.vultr.com/api/#plans_plan_list_vdc2

Availability BM Region

https://www.vultr.com/api/#regions_region_availability_baremetal

Get Application Info

Gets a list of available applications that can be used when launching a VPS

https://www.vultr.com/api/#app_app_list

Availability Regions

https://www.vultr.com/api/#regions_region_availability

Create Startup Script

Create startup script

https://www.vultr.com/api/#startupscript_create

List ReservedIP

https://www.vultr.com/api/#reservedip_ip_list

List Block Storages

List all block storages

https://www.vultr.com/api/#block_block_list

Availability VDC2 Region

https://www.vultr.com/api/#regions_region_availability_vdc2

Update User

Update a user

https://www.vultr.com/api/#user_update

Update a Startup script

Update a startup script

https://www.vultr.com/api/#startupscript_update

List all Startup Scripts

Lists all startup scripts

https://www.vultr.com/api/#startupscript_startupscript_list

Get Backup List

Gets a list of all current backups on your account

https://www.vultr.com/api/#backup_backup_list

Create User

Create a user

https://www.vultr.com/api/#user_create

List OS

https://www.vultr.com/api/#os_os_list

Delete Block Storage

Deletes a BS instance

https://www.vultr.com/api/#block_delete

Get Startup Script

There is no endpoint for this. We need to grab the list and loop through and pull out the one we want

Convert ReservedIP

https://www.vultr.com/api/#reservedip_convert

Delete User

Delete a user

https://www.vultr.com/api/#user_delete

Create Snapshot

https://www.vultr.com/api/#snapshot_create

Create Block Storage

Create a block storage instance

https://www.vultr.com/api/#block_create

Update SSH Key

ssh update
https://www.vultr.com/api/#sshkey_update

List Plans

https://www.vultr.com/api/#plans_plan_list

Create ReservedIP

https://www.vultr.com/api/#reservedip_create

Destroy ReservedIP

https://www.vultr.com/api/#reservedip_destroy

Attach Block Storage

Attach a BS to a VPS

https://www.vultr.com/api/#block_attach

Availability VC2 Region

https://www.vultr.com/api/#regions_region_availability_vc2

Destroy Snapshot

https://www.vultr.com/api/#snapshot_destroy

List Users

List all Users

https://www.vultr.com/api/#user_user_list

List Regions

https://www.vultr.com/api/#regions_region_list

Destroy Network

https://www.vultr.com/api/#network_destroy

List ssh key

list ssh keys

https://www.vultr.com/api/#sshkey_sshkey_list

Delete startup script

Deletes a startup script

https://www.vultr.com/api/#startupscript_destroy

Create from url ISO

https://www.vultr.com/api/#iso_create_from_url

List VC2 Plans

https://www.vultr.com/api/#plans_plan_list_vc2

Attach ReservedIP

https://www.vultr.com/api/#reservedip_attach

Get single Block Storage

There is no end point for this - we will have to grab the list and sort until we find the one we are looking for