{"id":21829708,"url":"https://github.com/0xtlt/cpanel-node","last_synced_at":"2025-08-28T12:22:31.777Z","repository":{"id":57210209,"uuid":"143761127","full_name":"0xtlt/cpanel-node","owner":"0xtlt","description":"Node.js library using cpanel api","archived":false,"fork":false,"pushed_at":"2019-04-12T10:33:49.000Z","size":23,"stargazers_count":11,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-21T00:59:01.109Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xtlt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-06T17:28:34.000Z","updated_at":"2025-02-26T16:41:01.000Z","dependencies_parsed_at":"2022-09-01T08:10:33.874Z","dependency_job_id":null,"html_url":"https://github.com/0xtlt/cpanel-node","commit_stats":null,"previous_names":["thomast404/cpanel-node"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/0xtlt/cpanel-node","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xtlt%2Fcpanel-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xtlt%2Fcpanel-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xtlt%2Fcpanel-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xtlt%2Fcpanel-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xtlt","download_url":"https://codeload.github.com/0xtlt/cpanel-node/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xtlt%2Fcpanel-node/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272498295,"owners_count":24944819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-28T02:00:10.768Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-27T18:28:51.517Z","updated_at":"2025-08-28T12:22:31.752Z","avatar_url":"https://github.com/0xtlt.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cpanel-node 🌌\nCpanel-node is designed to be simplest way possible to make api request to Cpanel.\n\n## Installation 🚀\n\t$ npm install cpanel-node\n\n## Usage 💬\n```javascript\nconst cpanelAPI = require('cpanel-node');\nconst options = {\n    host: 'whm.example.com',\n    user: 'CPANEL_USERNAME',\n    pass: 'CPANEL_PASSWORD',\n    https: true, //https is advisable\n    port: \"2083\" //default port of cpanel\n};\n\nlet myCpanel = new cpanelAPI(options);\n```\n\n## API 🔨\nCreate email address\n```javascript\nmyCpanel.emailAddpop({\n    domain: 'example.com',\n    email: \"thebest\",\n    password: \"*******\",\n    quota: 150 //Mo\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nRemove email address\n```javascript\nmyCpanel.emailDelpop({\n    domain: 'example.com',\n    email: 'thebest'\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj).header);\n});\n```\n\nChange email password\n```javascript\nmyCpanel.emailPasswdpop({\n    domain: 'example.com',\n    email: \"thebest\",\n    password: \"*******\"\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nChange email quota\n```javascript\nmyCpanel.emailEditpopQuota({\n    domain: 'example.com',\n    email: \"thebest\",\n    quota: 50//Mo\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nRetrieve a zone file\n```javascript\nmyCpanel.zoneFetchZone({\n    domain: 'example.com',\n    name: \"world\",\n    type: \"type\"\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nGet all of the account's zone files\n```javascript\nmyCpanel.zoneFetchZones().then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nList addon Domains\n```javascript\nmyCpanel.zoneAddDomain({\n    regex: 'my regex', \n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nAdd a line to the zone file (that is, a domain record)\n```javascript\nmyCpanel.zoneAddDomain({\n    domain: 'example.com', // The zone file to work with\n    name: \"world\",\n    type: \"type\",\n    address: \"127.0.0.1\",\n    ttl: 7200 // optional\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```\n\nChange _name_, _address_, _type_ and/or _ttl_ for a specific line in a zone file (that is, a domain record)\n```javascript\nmyCpanel.zoneEditDomain({\n    domain: 'example.com', // The zone file to work with\n    line: 42, // The line (in the zone) to change\n    name: \"world\", // optional\n    address: \"127.0.0.1\", // optional\n    type: \"type\", // optional\n    ttl: 7200 // optional\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n\n```\nRemove a specific line in a zone file (that is, a domain record)\n```javascript\nmyCpanel.zoneRemoveDomain({\n    domain: 'example.com', // The zone file to work with\n    line: 42, // The line (in the zone) to remove\n}).then(obj =\u003e {\n    console.log(obj.response);\n    console.log(obj.header);\n});\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xtlt%2Fcpanel-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xtlt%2Fcpanel-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xtlt%2Fcpanel-node/lists"}