delorean-up-api

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

Class	Method	HTTP request	Description
DeloreanUpApi.NodesApi	containerBackupPOST	POST /nodes/{nodeId}/containers/{containerId}/backup	Create backup of the container passed by Id.
DeloreanUpApi.NodesApi	containerMountsGET	GET /nodes/{nodeId}/containers/{containerId}/mounts	Returns an array of mounts object.
DeloreanUpApi.NodesApi	nodeContainerByIdGET	GET /nodes/{nodeId}/containers/{containerId}	Returns a container object.
DeloreanUpApi.NodesApi	nodeContainersGET	GET /nodes/{nodeId}/containers	Returns a list of active container in a node.
DeloreanUpApi.NodesApi	nodesGET	GET /nodes/	Returns a list of nodes.

Documentation for Models

• DeloreanUpApi.Backup
• DeloreanUpApi.Container
• DeloreanUpApi.ContainerHostConfig
• DeloreanUpApi.ContainerNetworkSettings
• DeloreanUpApi.EndpointIPAMConfig
• DeloreanUpApi.EndpointSettings
• DeloreanUpApi.Error
• DeloreanUpApi.InlineResponse200
• DeloreanUpApi.InlineResponse2001
• DeloreanUpApi.InlineResponse2002
• DeloreanUpApi.InlineResponse2003
• DeloreanUpApi.Mount
• DeloreanUpApi.MountBindOptions
• DeloreanUpApi.MountTmpfsOptions
• DeloreanUpApi.MountVolumeOptions
• DeloreanUpApi.MountVolumeOptionsDriverConfig
• DeloreanUpApi.Node
• DeloreanUpApi.Port
• DeloreanUpApi.Volume
• DeloreanUpApi.VolumeUsageData

Documentation for Authorization

All endpoints do not require authorization.