{"id":18298262,"url":"https://github.com/s3rgeym/cpanel-api","last_synced_at":"2025-04-05T13:33:14.138Z","repository":{"id":41296717,"uuid":"285722062","full_name":"s3rgeym/cpanel-api","owner":"s3rgeym","description":"CPanel API Client for Python","archived":false,"fork":false,"pushed_at":"2022-08-26T23:55:26.000Z","size":38,"stargazers_count":9,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-06T12:37:33.792Z","etag":null,"topics":["api","client","cpanel","uapi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/s3rgeym.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-07T02:52:00.000Z","updated_at":"2024-08-06T12:32:11.000Z","dependencies_parsed_at":"2022-09-11T11:10:58.185Z","dependency_job_id":null,"html_url":"https://github.com/s3rgeym/cpanel-api","commit_stats":null,"previous_names":["tz4678/cpanel-api"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rgeym%2Fcpanel-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rgeym%2Fcpanel-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rgeym%2Fcpanel-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/s3rgeym%2Fcpanel-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/s3rgeym","download_url":"https://codeload.github.com/s3rgeym/cpanel-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223192692,"owners_count":17103564,"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","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":["api","client","cpanel","uapi"],"created_at":"2024-11-05T15:05:37.896Z","updated_at":"2024-11-05T15:05:38.645Z","avatar_url":"https://github.com/s3rgeym.png","language":"Python","readme":"# CPanel API Client for Python\n\n[![Downloads](https://pepy.tech/badge/cpanelapi)](https://pepy.tech/project/cpanelapi)\n[![Downloads](https://pepy.tech/badge/cpanelapi/month)](https://pepy.tech/project/cpanelapi)\n[![Downloads](https://pepy.tech/badge/cpanelapi/week)](https://pepy.tech/project/cpanelapi)\n\nSupports cPanel API 2 and UAPI.\n\n## Install\n\n```zsh\n$ pip install cpanel-api\n```\n\n## Examples\n\nBasic usage:\n\n```python\n#!/usr/bin/env python\n# -*- coding: utf-8 -*-\nimport logging\nimport sys\n\nfrom pprint import pprint\n\nfrom cpanel_api import CPanelApi\n\nlogging.basicConfig(level=logging.WARNING, stream=sys.stderr)\n\nhostname = 'HOSTNAME_OR_IPADRESS'\nusername = 'USERNAME'\npassword = 'PASSWORD'\n\nclient = CPanelApi(hostname, username, password)\n\n# Alternatively, to authenticate using a UAPI or cPanel API 2 token, use:\n# client = CPanelApi(hostname, username, '\u003cTOKEN\u003e', auth_type = 'utoken')\n\n# {'warnings': None, 'errors': None, 'data': {'port': '1243'}, 'metadata': {}, 'status': 1, 'messages': None}\nr = client.uapi.SSH.get_port()\nprint('SSH port:', r.data.port)\n# get all public ssh keys\n# {'cpanelresult': {'postevent': {'result': 1}, 'apiversion': 2, 'data': [...], 'func': 'listkeys', 'event': {'result': 1}, 'module': 'SSH', 'preevent': {'result': 1}}}\nr = client.cpanel2.SSH.listkeys()\npprint(r.cpanelresult.data)\n# retrieve key\nr = client.cpanel2.SSH.fetchkey(name='id_rsa')\n# {\"name\": \"id_rsa\", \"key\": \"ssh-rsa XXX\"}\nprint(r.cpanelresult.data[0].key)\nr = client.cpanel2.SSH.importkey(name='new_rsa.pub', key='*data*')\npprint(r)\n# ...\nr = client.cpanel2.DomainLookup.getdocroot(domain='site.info')\nprint(r.cpanelresult.data[0].reldocroot)  # public_html\n```\n\nFunction call syntax:\n\n```python\nclient.api_version.ModuleName.function_name({'param': 'value'})\nclient.api_version.ModuleName.function_name(param='value')\nclient.api_version.ModuleName.function_name({'param': 'value'}, param='value')\nclient.api_cal('api_version', 'ModuleName', 'function_name', {'param': 'value'}, param='value')\n```\n\nWhere `api_version` is `cpanel2` or `uapi`.\n\n## Links:\n\n- [Official documentation](https://documentation.cpanel.net/display/DD/Developer+Documentation+Home).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs3rgeym%2Fcpanel-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fs3rgeym%2Fcpanel-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fs3rgeym%2Fcpanel-api/lists"}