vultr-promise

vultr-promise

A promise based vultr api wrapper

BEWARE: This module is experimental and may change in the future, use at your own risk!

• Example
• Methods
• License

Example

const vultr = require('vultr-promise')

const API_KEY = 'YOUR_API_KEY_HERE'

vultr.createServer(API_KEY, {
  DCID: 9, // Frankfurt, Germany
  VPSPLANID: 201, // $5 VC2 - 1024 MB, 25 GB SSD
  OSID: 215, // Ubuntu 16.04 x64
  enable_ipv6: 'yes',
  hostname: 'myvps',
  SSHKEYID: '577fb3487211e'
}).then(function (response) {
  console.log('Created VPS with SUBID', response.SUBID)
}).catch(console.error)

Methods

Official Vultr API documentaion

• Account /v1/account/
  • getAccountInfo
• Application /v1/app/
  • getAppList
• API Key /v1/auth/
  • getAuthInfo
• Backup /v1/backup/
  • getBackupList
• Block Storage /v1/block/
  • attachBlock
  • createBlock
  • deleteBlock
  • detachBlock
  • getBlockList
  • resizeBlock
• DNS /v1/dns/
  • createDnsDomain
  • createDnsRecord
  • deleteDnsDomain
  • deleteDnsRecord
  • getDnsDomainList
  • getDnsRecordList
  • updateDnsRecord
• Firewall /v1/firewall/
  • createFirewallGroup
  • deleteFireallGroup
  • getFirewallGroupList
  • getFirewallGroupDescription
  • createFirewallRule
  • deleteFirewallRule
  • getFirewallRuleList
• ISO Image /v1/iso/
  • createImageFromUrl
  • getImageList
• Operating System /v1/os/
  • getOSList
• Plans /v1/plans/
  • getPlanList
  • getPlanListVC2
  • getPlanListVCDC2
• Regions /v1/regions/
  • getRegionAvailability
  • getRegionList
• Reserved IP /v1/reservedip/
  • attachReservedIP
  • convertReservedIP
  • createReservedIP
  • destroyReservedIP
  • detachReservedIP
  • getReservedIPList
• Server /v1/server/
  • changeServerApp
  • getAppChangeList
  • disableServerBackup
  • enableServerBackup
  • getServerBackupSchedule
  • getServerBandwidth
  • createServer
  • createServerIPv4
  • destroyServer
  • destroyServerIPv4
  • setServerFirewallGroup
  • getServerAppInfo
  • getServerUserData
  • haltServer
  • enableServerIPv6
  • attachServerISO
  • detachServerISO
  • getServerISOInfo
  • setServerLabel
  • getServerList
  • getServerIPv4Info
  • getServerIPv6Info
  • getServerNeighbours
  • changeServerOS
  • getServerOSList
  • rebootServer
  • reinstallServer
  • restoreServerBackup
  • restoreServerSnapshot
  • setDefaultReverseDnsEntryIPv4
  • setDefaultReverseDnsEntryIPv6
  • getReverseDnsEntryIPv6
  • setReverseDnsEntryIPv4
  • setReverseDnsEntryIPv6
  • setServerUserData
  • startServer
  • upgradeServerPlan
  • getServerUpgradePlanList
• Snapshot /v1/snapshot/
  • createSnapshot
  • destroySnapshot
  • getSnapshotList
• SSH Key /v1/sshkey/
  • createSSHKey
  • destroySSHKey
  • getSSHKeyList
  • updateSSHKey
• Startup Script /v1/startupscript/
  • createStartupScript
  • destroyStartupScript
  • getStartupScriptList
  • updateStartupScript
• User Management /v1/user
  • createUser
  • deleteUser
  • getUserList
  • updateUser

Any method that requires an API key needs to have the API key as the first argument.

License

MIT