Source: object-storage.js

  1. /**
  2.  * Methods for interacting with the object storage endpoints<br>
  3.  * {@link https://www.vultr.com/api/#tag/s3}
  4.  * @namespace objectStorage
  5.  */
  7. /**
  8.  * List all object storage volumes on the account.<br>
  9.  * {@link https://www.vultr.com/api/#operation/list-object-storages}
  10.  * @function listObjectStorages
  11.  * @memberof objectStorage
  12.  * @instance
  13.  */
  14. exports.listObjectStorages = {
  15.   url: '/object-storage',
  16.   requestType: 'GET',
  17.   apiKeyRequired: true,
  18.   parameters: {
  19.     per_page: { type: 'string' },
  20.     cursor: { type: 'string' }
  21.   }
  22. }
  24. /**
  25.  * Create an object storage volume.<br>
  26.  * {@link https://www.vultr.com/api/#operation/create-object-storage}
  27.  * @function
  28.  * @memberof objectStorage
  29.  * @instance
  30.  */
  31. exports.createObjectStorage = {
  32.   url: '/object-storage',
  33.   requestType: 'POST',
  34.   apiKeyRequired: true,
  35.   parameters: {
  36.     cluster_id: {
  37.       type: 'string',
  38.       required: true
  39.     },
  40.     label: { type: 'string' }
  41.   }
  42. }
  44. /**
  45.  * Get information about the specified object sotrage volume.<br>
  46.  * {@link https://www.vultr.com/api/#operation/get-object-storage}
  47.  * @function getObjectStorage
  48.  * @memberof objectStorage
  49.  * @instance
  50.  */
  51. exports.getObjectStorage = {
  52.   url: '/object-storage/{object-storage-id}',
  53.   requestType: 'GET',
  54.   apiKeyRequired: true,
  55.   parameters: {
  56.     'object-storage-id': {
  57.       type: 'string',
  58.       path: true,
  59.       required: true
  60.     }
  61.   }
  62. }
  64. /**
  65.  * Delete an object storage volume.<br>
  66.  * {@link https://www.vultr.com/api/#operation/delete-object-storage}
  67.  * @function deleteObjectStorage
  68.  * @memberof objectStorage
  69.  * @instance
  70.  */
  71. exports.deleteObjectStorage = {
  72.   url: '/object-storage/{object-storage-id}',
  73.   requestType: 'DELETE',
  74.   apiKeyRequired: true,
  75.   parameters: {
  76.     'object-storage-id': {
  77.       type: 'string',
  78.       path: true,
  79.       required: true
  80.     }
  81.   }
  82. }
  84. /**
  85.  * Update information for the specified object storage volume.<br>
  86.  * {@link https://www.vultr.com/api/#operation/update-object-storage}
  87.  * @function updateObjectStorage
  88.  * @memberof objectStorage
  89.  * @instance
  90.  */
  91. exports.updateObjectStorage = {
  92.   url: '/object-storage/{object-storage-id}',
  93.   requestType: 'PUT',
  94.   apiKeyRequired: true,
  95.   parameters: {
  96.     'object-storage-id': {
  97.       type: 'string',
  98.       path: true,
  99.       required: true
  100.     },
  101.     label: {
  102.       type: 'string',
  103.       required: true
  104.     }
  105.   }
  106. }
  108. /**
  109.  * Regenerate keys for the specified object storage volume.<br>
  110.  * {@link https://www.vultr.com/api/#operation/regenerate-object-storage-keys}
  111.  * @function regenerateObjectStorageKeys
  112.  * @memberof objectStorage
  113.  * @instance
  114.  */
  115. exports.regenerateObjectStorageKeys = {
  116.   url: '/object-storage/{object-storage-id}/regenerate-keys',
  117.   requestType: 'POST',
  118.   apiKeyRequired: true,
  119.   parameters: {
  120.     'object-storage-id': {
  121.       type: 'string',
  122.       path: true,
  123.       required: true
  124.     }
  125.   }
  126. }
  128. /**
  129.  * Get a list of all object storage clusters.<br>
  130.  * {@link https://www.vultr.com/api/#operation/list-object-storage-clusters}
  131.  * @function getAllClusters
  132.  * @memberof objectStorage
  133.  * @instance
  134.  */
  135. exports.getAllClusters = {
  136.   url: '/object-storage/clusters',
  137.   requestType: 'GET',
  138.   apiKeyRequired: true,
  139.   parameters: {
  140.     per_page: { type: 'string' },
  141.     cursor: { type: 'string' }
  142.   }
  143. }