README.md

glesys-api

A Node.js wrapper for the GleSYS API.

Installation

Note: Node 10.13.0 (LTS) or later is required.

npm install glesys-api

Usage

const GleSYSAPI = require('glesys-api');

const glesys = new GleSYSAPI({
    apiKey: 'key',
    apiUser: 'user',
});

(async () => {
    try {
        const { body } = await glesys.api.serviceInfo();

        console.log(body)
    } catch (e) {
        console.error(e);
    }

    glesys.email.createAccount({
        emailaccount: '[email protected]',
        password: 'password',
    });
})();

Available methods

account

• GleSYSAPI.account.info()

api

• GleSYSAPI.api.listFunctions()
• GleSYSAPI.api.maintenance()
• GleSYSAPI.api.serviceInfo()

archive

• GleSYSAPI.archive.allowedArguments()
• GleSYSAPI.archive.changeDescription()
• GleSYSAPI.archive.changePassword()
• GleSYSAPI.archive.create()
• GleSYSAPI.archive.delete()
• GleSYSAPI.archive.details()
• GleSYSAPI.archive.list()
• GleSYSAPI.archive.resize()

country

• GleSYSAPI.country.list()

customer

• GleSYSAPI.customer.createProject()
• GleSYSAPI.customer.editCollaborator()
• GleSYSAPI.customer.listCollaborators()
• GleSYSAPI.customer.listProjects()
• GleSYSAPI.customer.removeCollaborator()
• GleSYSAPI.customer.settings()

domain

• GleSYSAPI.domain.add()
• GleSYSAPI.domain.addRecord()
• GleSYSAPI.domain.available()
• GleSYSAPI.domain.changeNameServers()
• GleSYSAPI.domain.delete()
• GleSYSAPI.domain.deleteRecord()
• GleSYSAPI.domain.details()
• GleSYSAPI.domain.edit()
• GleSYSAPI.domain.legacyWebHosting()
• GleSYSAPI.domain.list()
• GleSYSAPI.domain.listRecords()
• GleSYSAPI.domain.priceList()
• GleSYSAPI.domain.register()
• GleSYSAPI.domain.renew()
• GleSYSAPI.domain.setAutoRenew()
• GleSYSAPI.domain.transfer()
• GleSYSAPI.domain.updateRecord()

email

• GleSYSAPI.email.costs()
• GleSYSAPI.email.createAccount()
• GleSYSAPI.email.createAlias()
• GleSYSAPI.email.delete()
• GleSYSAPI.email.editAccount()
• GleSYSAPI.email.editAlias()
• GleSYSAPI.email.globalQuota()
• GleSYSAPI.email.list()
• GleSYSAPI.email.overview()
• GleSYSAPI.email.quota()

fileStorage

• GleSYSAPI.fileStorage.createVolume()
• GleSYSAPI.fileStorage.editVolume()
• GleSYSAPI.fileStorage.deleteVolume()
• GleSYSAPI.fileStorage.listPlans()
• GleSYSAPI.fileStorage.listVolumes()
• GleSYSAPI.fileStorage.resourceUsage()
• GleSYSAPI.fileStorage.volumeDetails()

invoice

• GleSYSAPI.invoice.billingPeriod()
• GleSYSAPI.invoice.list()
• GleSYSAPI.invoice.next()
• GleSYSAPI.invoice.payByPaypal()

ip

• GleSYSAPI.ip.add()
• GleSYSAPI.ip.details()
• GleSYSAPI.ip.listFree()
• GleSYSAPI.ip.listOwn()
• GleSYSAPI.ip.release()
• GleSYSAPI.ip.remove()
• GleSYSAPI.ip.resetPTR()
• GleSYSAPI.ip.setPTR()
• GleSYSAPI.ip.take()

loadBalancer

• GleSYSAPI.loadBalancer.addBackEnd()
• GleSYSAPI.loadBalancer.addCertificate()
• GleSYSAPI.loadBalancer.addFrontEnd()
• GleSYSAPI.loadBalancer.addTarget()
• GleSYSAPI.loadBalancer.addToBlacklist()
• GleSYSAPI.loadBalancer.create()
• GleSYSAPI.loadBalancer.destroy()
• GleSYSAPI.loadBalancer.details()
• GleSYSAPI.loadBalancer.disableTarget()
• GleSYSAPI.loadBalancer.edit()
• GleSYSAPI.loadBalancer.editBackEnd()
• GleSYSAPI.loadBalancer.editFrontEnd()
• GleSYSAPI.loadBalancer.editTarget()
• GleSYSAPI.loadBalancer.enableTarget()
• GleSYSAPI.loadBalancer.errors()
• GleSYSAPI.loadBalancer.list()
• GleSYSAPI.loadBalancer.listCertificate()
• GleSYSAPI.loadBalancer.removeBackEnd()
• GleSYSAPI.loadBalancer.removeCertificate()
• GleSYSAPI.loadBalancer.removeFromBlacklist()
• GleSYSAPI.loadBalancer.removeFrontEnd()
• GleSYSAPI.loadBalancer.removeTarget()

network

• GleSYSAPI.network.create()
• GleSYSAPI.network.delete()
• GleSYSAPI.network.details()
• GleSYSAPI.network.edit()
• GleSYSAPI.network.list()

networkAdapter

• GleSYSAPI.networkAdapter.create()
• GleSYSAPI.networkAdapter.delete()
• GleSYSAPI.networkAdapter.details()
• GleSYSAPI.networkAdapter.edit()

paymentCard

• GleSYSAPI.paymentCard.add()
• GleSYSAPI.paymentCard.delete()
• GleSYSAPI.paymentCard.list()
• GleSYSAPI.paymentCard.payInvoices()

project

• GleSYSAPI.project.delete()
• GleSYSAPI.project.rename()

server

• GleSYSAPI.server.addISO()
• GleSYSAPI.server.allowedArguments()
• GleSYSAPI.server.backup()
• GleSYSAPI.server.clone()
• GleSYSAPI.server.console()
• GleSYSAPI.server.costs()
• GleSYSAPI.server.create()
• GleSYSAPI.server.destroy()
• GleSYSAPI.server.details()
• GleSYSAPI.server.edit()
• GleSYSAPI.server.estimatedCost()
• GleSYSAPI.server.limits()
• GleSYSAPI.server.list()
• GleSYSAPI.server.listISO()
• GleSYSAPI.server.mountISO()
• GleSYSAPI.server.networkAdapters()
• GleSYSAPI.server.reboot()
• GleSYSAPI.server.resetLimit()
• GleSYSAPI.server.resetPassword()
• GleSYSAPI.server.resourceUsage()
• GleSYSAPI.server.start()
• GleSYSAPI.server.status()
• GleSYSAPI.server.stop()
• GleSYSAPI.server.templates()

sshKey

• GleSYSAPI.sshKey.add()
• GleSYSAPI.sshKey.list()
• GleSYSAPI.sshKey.remove()

transaction

• GleSYSAPI.transaction.acknowledge()
• GleSYSAPI.transaction.cancel()
• GleSYSAPI.transaction.list()
• GleSYSAPI.transaction.start()

user

• GleSYSAPI.user.changePassword()
• GleSYSAPI.user.confirm()
• GleSYSAPI.user.createOrganization()
• GleSYSAPI.user.details()
• GleSYSAPI.user.disableTwoFactor()
• GleSYSAPI.user.edit()
• GleSYSAPI.user.enableTwoFactor()
• GleSYSAPI.user.listOrganizations()
• GleSYSAPI.user.login()
• GleSYSAPI.user.logout()
• GleSYSAPI.user.searchData()
• GleSYSAPI.user.signUp()

vpn

• GleSYSAPI.vpn.createUser()
• GleSYSAPI.vpn.deleteUser()
• GleSYSAPI.vpn.editUser()
• GleSYSAPI.vpn.listUsers()

For more information about the GleSYS API, available arguments etc., please see the GleSYS API documentation.