1.0.0 • Published 5 years ago

delorean-up-api v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

delorean-up-api

DeloreanUp Api - JavaScript client for deloreanUp backend

DeloreanUp backend server is used to generate volume's backup using doc-nodes and send of this backups on a predefined persistent system (eg. NFS, SWIFT, ...)

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

Install it via:

npm install delorean-up-api --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var DeloreanUpApi = require('delorean_up_api');

var api = new DeloreanUpApi.NodesApi()

var nodeId = "nodeId_example"; // {String} ID of the node

var containerId = "containerId_example"; // {String} ID of the container to return


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.containerBackupPOST(nodeId, containerId, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:3000/api/v1.0.0

ClassMethodHTTP requestDescription
DeloreanUpApi.NodesApicontainerBackupPOSTPOST /nodes/{nodeId}/containers/{containerId}/backupCreate backup of the container passed by Id.
DeloreanUpApi.NodesApicontainerMountsGETGET /nodes/{nodeId}/containers/{containerId}/mountsReturns an array of mounts object.
DeloreanUpApi.NodesApinodeContainerByIdGETGET /nodes/{nodeId}/containers/{containerId}Returns a container object.
DeloreanUpApi.NodesApinodeContainersGETGET /nodes/{nodeId}/containersReturns a list of active container in a node.
DeloreanUpApi.NodesApinodesGETGET /nodes/Returns a list of nodes.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.0.0

5 years ago