Source: backups.js

  1. /**
  2.  * Methods for interacting with the backup endpoints<br>
  3.  * {@link https://www.vultr.com/api/#tag/backup}
  4.  * @namespace backup
  5.  */
  7. /**
  8.  * Get information about backups in your account.<br>
  9.  * {@link https://www.vultr.com/api/#operation/list-backups}
  10.  * @function list
  11.  * @memberof backup
  12.  * @instance
  13.  */
  14. exports.listBackups = {
  15.   url: '/backups',
  16.   requestType: 'GET',
  17.   apiKeyRequired: true,
  18.   parameters: {
  19.     instance_id: { type: 'string' },
  20.     per_page: { type: 'number' },
  21.     cursor: { type: 'string' }
  22.   }
  23. }
  25. /**
  26.  * Get information for the specified backup.<br>
  27.  * {@link https://www.vultr.com/api/#operation/get-backup}
  28.  * @function get
  29.  * @memberof backup
  30.  * @instance
  31.  */
  32. exports.getBackup = {
  33.   url: '/backups/{backup-id}',
  34.   requestType: 'GET',
  35.   apiKeyRequired: true,
  36.   parameters: {
  37.     'backup-id': {
  38.       type: 'string',
  39.       path: true,
  40.       required: true
  41.     }
  42.   }
  43. }