# solusvm

> SolusVM Admin API client.

Latest version **1.1.0** (published 2019-07-09) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install solusvm
pnpm add solusvm
yarn add solusvm
bun add solusvm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2019-07-09 |
| First published | 2017-09-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Unpacked size | 25.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Alex Seymour |
| Maintainers | axeal |

## Links

- npm: https://www.npmjs.com/package/solusvm
- Repository: https://github.com/axeal/solusvm
- Homepage: https://github.com/axeal/solusvm#readme
- Issues: https://github.com/axeal/solusvm/issues
- npm.io page: https://npm.io/package/solusvm

## Dependencies (6)

- [snyk](https://npm.io/package/snyk.md) ^1.192.4
- [util](https://npm.io/package/util.md) ^0.10.3
- [debug](https://npm.io/package/debug.md) ^2.6.8
- [request](https://npm.io/package/request.md) ^2.81.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.0
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.1

## Recent versions

- 1.1.0 (latest) — 2019-07-09
- 1.0.2 — 2017-09-06
- 1.0.1 — 2017-09-06
- 1.0.0 — 2017-09-06

## README

# SolusVM

[![Build Status](https://travis-ci.org/axeal/solusvm.svg?branch=master)](https://travis-ci.org/axeal/solusvm)
[![Coverage Status](https://coveralls.io/repos/github/axeal/solusvm/badge.svg?branch=master)](https://coveralls.io/github/axeal/solusvm?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/github/axeal/solusvm/badge.svg)](https://snyk.io/test/github/axeal/solusvm)

A SolusVM Admin API Wrapper

## Installation 
This module can be install via npm:
```text
$ npm install --save solusvm
```

## Usage

The `solusvm.call()` method accepts three arguments:
1. The name of the SolusVM API action to call
2. An object with the variables for the API call
3. An optional callback function

If no callback function is passed to the call then a promise is returned. To use a callback instead, pass a callback function as the third argument.

```javascript
var solusvm = require('solusvm');

//Configrure the API client with the URL, API ID and API KEY of the SolusVM Master Instance
solusvm.configure('url', 'apiId', 'apiKey');

//Example of a promise-based call to the client
solusvm.call('node-idlist', {
    type: 'openvz'
  })
  .then(function(data) {
    console.log(data);
  })
  .catch(function(err) {
    console.log(err);
  });

//Example of a callback-based call to the client
solusvm.call('node-idlist', {
    type: 'openvz'
  }, function(err, data) {
    if (err) {
      console.log(err);
    } else {
      console.log(data);
    }
  });
 ```

---
_Source: https://npm.io/package/solusvm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._