@octaspace/api.js

Octaspace API Client Package

$3

Installation

npm install @octaspace/api.js

Usage

$3

import { Octa, KeyError, UUIDError, ApiError } from '@octaspace/api.js';

$3

const octa = new Octa('your-api-key');

Fetch this from Settings of Cube portal.

$3

Pass type ("wg" or "openvpn") and nodeid (number) as parameter.

const createdVPN = await octa.createVPN('type', 1);

Returns UUID

$3

const vpnDetails = await octa.getVPN('uuid');

$3

await octa.stopVPN('uuid');

$3

const vpnNodes = await octa.getVPNNodes();

$3

Pass image (string), disk size(number), env(optional), and nodeid (number) as parameter.

const createdMR = await octa.createMR('image', 1, nodeid, {"env1":"value","env2":"value"});

$3

const mrDetails = await octa.getMR('uuid');

$3

await octa.stopMR('uuid');

$3

const mrNodes = await octa.getMRNodes();

$3

const accountDetails = await octa.getAccountInfo();

$3

const accountBalance = await octa.getAccountBalance();

Note: checkout lib/src/types.ts for detail information about what they return.

$3

- KeyError: Thrown for issues with the API key. Ex: Wrong API Key
- UUIDError: Thrown for issues with the UUID.
- ApiError: Generic API error. Ex: Due to Network Error
- InvalidParameterError: Invalid Parameter.

License

MIT License - see LICENSE file for details.