# node-directadmin

> Node.js module for DirectAdmin panel

Latest version **1.2.9** (published 2024-10-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-directadmin
pnpm add node-directadmin
yarn add node-directadmin
bun add node-directadmin
```

## Health

**Score 35/100 (D)** — status: stable.

Positive: no vulnerabilities.

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

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.2.9 |
| Published | 2024-10-17 |
| First published | 2023-09-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 64 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Nuno Cardoso |
| Maintainers | johndc7 |
| Keywords | directadmin, hosting |

## Links

- npm: https://www.npmjs.com/package/node-directadmin
- Repository: https://github.com/johndc7/node-directadmin
- Issues: https://github.com/johndc7/node-directadmin/issues
- npm.io page: https://npm.io/package/node-directadmin

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.5.0

## Recent versions

- 1.2.9 (latest) — 2024-10-17
- 1.2.8 — 2023-11-29
- 1.2.7 — 2023-09-02
- 1.2.6 — 2023-09-02

## README

# node-directadmin

Node.js module for [DirectAdmin](https://www.directadmin.com/)

## Installation

`npm install node-directadmin`

## Options
- `forceJsonRequests` - This forces `json=yes` on all API calls. This will change the format returned by some functions. This is recommended on **new projects** (or existing ones if you feel like possibly introducing some bugs). This only defaults to `false` for backwards compatibility.

_Self explanatory_
- `username`
- `password`
- `serverUrl`
- `port`

## Examples
```js
let DirectAdmin = require('directadmin');
let da = new DirectAdmin({
    username: 'admin',
    password: 'password',
    serverUrl: 'https://example.com',
    port: '2222',
    forceJsonRequests: true
})
```

Check the examples folder for more specific use cases examples.

See the [DirectAdmin documentation](https://www.directadmin.com/api.html) more info. Keep in mind that lots of functionality is not documented by DirectAdmin. Chrome dev tools are a good way to find undocumented API calls.

## License

Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:

    http://www.apache.org/licenses/LICENSE-2.0.html

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.

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