1.0.0 • Published 6 months ago

fastpanel v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Fastpanel SDK

Fastpanel SDK for interacting with the Fastpanel API at fastpanel.direct.

Features

  • Easy authentication
  • User management
  • Role-based access control
  • TypeScript support

Installation

You can install the Fastpanel SDK via npm:

npm install fastpanel

Usage

To use the Fastpanel SDK, you need to create an instance of the FClient class with your Fastpanel URL, username, and password.

Example

import { FClient } from 'fastpanel';

const Api = new FClient('my.domain.com', 'fastuser', 'ExamplePassword');

async function main() {
    const users = await api.users();
    console.log('All users:', users);
}
main().catch(console.error);

Creating new user

const newUser = await api.createUser(
        'username', // Username (min. length 4)
        'userpassword', // User password (min. length 6)
        'user', // User role ('user' or 'reseller')
        2048); // Storage quota in MB
console.log(newUser);

To get a specific user

const getUser = await api.getUser(3); // User id
console.log(newUser);

License

This project is licensed under the MIT License. See the LICENSE file for details.