Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.52 KB

README.md

File metadata and controls

40 lines (28 loc) · 1.52 KB

node-directadmin

Node.js module for DirectAdmin

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

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 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.