eip-solidserver-apiv2 v8.1.1

eip-solidserver-apiv2

SoliDserverApi - JavaScript client for eip-solidserver-apiv2 OpenAPI 3.0.2 API definition for SOLIDserver service from EfficientIP.All product specifications and information provided in this document are subject to change or update without notice and should not be construed as a commitment by EfficientIP. EfficientIP assumes no responsibility or liability for any mistakes, inaccuracies or omissions that may appear in this document. All statements and recommendations in this document are believed to be accurate at the time they are drafted but are presented without any representation or warranty of any kind, either express or implied, regarding their accuracy, completeness, performance, up-to-dateness or suitability for any particular use or purpose, or with respect to the infringement of any right. In particular, EfficientIP makes no representation or warranty that the results that may be obtained from your use of our products will be effective, accurate or reliable or that the quality of the products will meet your expectations. Users must take full responsibility for their application of any product. This document aims at detailing EfficientIP proprietary solutions. As our solutions rely on several third-party products, created by other companies or organizations, it may redirect readers to third-party websites and documentation for further information. EfficientIP cannot be liable for or expected to provide said information regarding products maintained or created by third parties.In no event shall EfficientIP be liable for any special, punitive, indirect, incidental or consequential damages of any kind including, but not limited to, loss of present or prospective profits or business, loss of data, business interruption, damages to reputation or image, whether in an action of contract, negligence, or other action, arising out of or in connection with the use, reliance upon or performance of the products provided by EfficientIP or any information contained herein.All EfficientIP products and documentation are subject to separate licensing terms which users must agree to and comply with in order to use such products and documentation. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0
• Package version: 2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.efficientip.com/services/support/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install eip-solidserver-apiv2 --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your eip-solidserver-apiv2 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

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 SoliDserverApi = require('eip-solidserver-apiv2');

// no TLS verification of certificate -- only if needed
process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = 0;

let defaultClient = new SoliDserverApi.ApiClient(basePath = 'https://{you-sds}/api/v2.0');

// Configure HTTP basic authorization: BasicAuth
let BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'apiuser';
BasicAuth.password = 'apipasswd';

let apiInstance = new SoliDserverApi.IpamApi(defaultClient);
let opts = {
    //   'where': "where_example",
    //   'tags': "tags_example"
};

_r = apiInstance.ipamSpaceCount(opts, (error, data, response) => {
    if (error) {
        console.error(error);
    } else {
        console.log(data.data[0].count);
    }
});

Documentation for API Endpoints

All URIs are relative to https://sds-ip-or-name:443/api/v2.0

Documentation for Authorization

BasicAuth

• Type: HTTP basic authentication

HttpHeaderLoginKey

• Type: API key
• API key parameter name: X-IPM-Username
• Location: HTTP header

HttpHeaderPasswordKey

• Type: API key
• API key parameter name: X-IPM-Password
• Location: HTTP header