Source: iso.js

  1. /**
  2.  * Methods for interacting with the ISO endpoints<br>
  3.  * {@link https://www.vultr.com/api/#tag/iso}
  4.  * @namespace iso
  5.  */
  7. /**
  8.  * List all ISOs in the account.<br>
  9.  * {@link https://www.vultr.com/api/#operation/list-isos}
  10.  * @function listIsos
  11.  * @memberof iso
  12.  * @instance
  13.  */
  14. exports.listIsos = {
  15.   url: '/iso',
  16.   requestType: 'GET',
  17.   apiKeyRequired: true,
  18.   parameters: {
  19.     per_page: { type: 'string' },
  20.     cursor: { type: 'string' }
  21.   }
  22. }
  24. /**
  25.  * Create a new ISO in the account from a URL.<br>
  26.  * {@link https://www.vultr.com/api/#operation/create-iso}
  27.  * @function createIso
  28.  * @memberof iso
  29.  * @instance
  30.  */
  31. exports.createIso = {
  32.   url: '/iso',
  33.   requestType: 'POST',
  34.   apiKeyRequired: true,
  35.   parameters: {
  36.     url: {
  37.       type: 'string',
  38.       required: true
  39.     }
  40.   }
  41. }
  43. /**
  44.  * Get information about the specified ISO.<br>
  45.  * {@link https://www.vultr.com/api/#operation/iso-get}
  46.  * @function getIso
  47.  * @memberof iso
  48.  * @instance
  49.  */
  50. exports.getIso = {
  51.   url: '/iso/{iso-id}',
  52.   requestType: 'POST',
  53.   apiKeyRequired: true,
  54.   parameters: {
  55.     'iso-id': {
  56.       type: 'string',
  57.       path: true,
  58.       required: true
  59.     }
  60.   }
  61. }
  63. /**
  64.  * Delete the specified ISO from the account.<br>
  65.  * {@link https://www.vultr.com/api/#operation/delete-iso}
  66.  * @function deleteIso
  67.  * @memberof iso
  68.  * @instance
  69.  */
  70. exports.deleteIso = {
  71.   url: '/iso/{iso-id}',
  72.   requestType: 'DELETE',
  73.   apiKeyRequired: true,
  74.   parameters: {
  75.     'iso-id': {
  76.       type: 'string',
  77.       path: true,
  78.       required: true
  79.     }
  80.   }
  81. }
  83. /**
  84.  * List all Vultr public ISOs.<br>
  85.  * {@link https://www.vultr.com/api/#operation/list-public-isos}
  86.  * @function listPublicIsos
  87.  * @memberof iso
  88.  * @instance
  89.  */
  90. exports.listPublicIsos = {
  91.   url: '/iso-public',
  92.   requestType: 'GET'
  93. }