Source: plans.js

  1. /**
  2.  * Methods for interacting with the plan endpoints<br>
  3.  * {@link https://www.vultr.com/api/#tag/plans}
  4.  * @namespace plans
  5.  */
  7. /**
  8.  * Get a list of allavailable Vultr instance plans.<br>
  9.  * {@link https://www.vultr.com/api/#operation/list-plans}
  10.  * @function listPlans
  11.  * @memberof plans
  12.  * @instance
  13.  */
  14. exports.listPlans = {
  15.   url: '/plans',
  16.   requestType: 'GET',
  17.   parameters: {
  18.     type: { type: 'string' },
  19.     os: { type: 'string' },
  20.     per_page: { type: 'string' },
  21.     cursor: { type: 'string' }
  22.   }
  23. }
  24. /**
  25.  * Get a list of all available Vultr bare metal plans.<br>
  26.  * {@link https://www.vultr.com/api/#operation/list-metal-plans}
  27.  * @function listBareMetalPlans
  28.  * @memberof plans
  29.  * @instance
  30.  */
  31. exports.listBareMetalPlans = {
  32.   url: '/plans-metal',
  33.   requestType: 'GET',
  34.   parameters: {
  35.     per_page: { type: 'string' },
  36.     cursor: { type: 'string' }
  37.   }
  38. }