doc-node-api

Doc-Node Api - JavaScript client for doc-node Deamon used to periodically generate volume's backup 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

Install it via:

npm install doc_node_api --save

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var DocNodeApi = require('doc_node_api');

var api = new DocNodeApi.ContainerApi()

var id = "id_example"; // {String} Id of the container in which perform the volumes backup


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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DocNodeApi.ContainerApi	containerBackupPOST	POST /containers/{id}/backup	Create backup of the container passed by Id.
DocNodeApi.ContainerApi	containerByIdGET	GET /containers/{id}	Returns a container object.
DocNodeApi.ContainerApi	containerMountsGET	GET /containers/{id}/mounts	Returns an array of mounts object.
DocNodeApi.ContainerApi	containersGET	GET /containers/	Returns a list of active containers.
DocNodeApi.VolumeApi	volumesListGET	GET /volumes/list	Returns a list of all volumes

Documentation for Models

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

Documentation for Authorization

All endpoints do not require authorization.