# Syneto API
Syneto Client API library: authentication, storage, virtualization and protection
# Installation
```
$ pip install syneto-api
```
# Basic Usage
```
from syneto_api import Authentication, Virtualization, Storage, Protection
auth_api = Authentication(url_base="https://syneto-instance-ip-address/api/auth", insecure_ssl=True)
response = auth_api.login(username="admin", password="admin")
jwt = response['jwt']
virt_api = Virtualization(url_base="https://syneto-instance-ip-address/api/virtualization", insecure_ssl=True)
virt_api.set_auth_jwt(jwt)
print(virt_api.get_vms())
storage_api = Storage(url_base="https://syneto-instance-ip-address/api/storage", insecure_ssl=True)
storage_api.set_auth_jwt(jwt)
print(storage_api.get_pools())
```
# Environment Variables
For conveninence, the base urls for the api endpoints are also accepted as environment variables, please see below.
```
AUTH_SERVICE=https://syneto-instance-ip-address/api/auth
VIRTUALIZATION_SERVICE=https://syneto-instance-ip-address/api/virtualization
STORAGE_SERVICE=https://syneto-instance-ip-address/api/storage
PROTECTION_SERVICE=https://syneto-instance-ip-address/api/protection
```
If you are using self-signed SSL certificates, set the following env. so that the http request library does not perform ssl verification.
```
ALLOW_INSECURE_SSL=True
```
Raw data
{
"_id": null,
"home_page": "https://github.com/SynetoNet/syneto-api",
"name": "syneto-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.2,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/a8/29/107e77fabce48c2372d80a5d65a8097aa2bbb86810a2d3e9b6c5ae1812f5/syneto_api-0.2.51.tar.gz",
"platform": null,
"description": "# Syneto API\n\nSyneto Client API library: authentication, storage, virtualization and protection\n\n# Installation\n\n```\n$ pip install syneto-api\n```\n\n# Basic Usage\n\n```\nfrom syneto_api import Authentication, Virtualization, Storage, Protection\n\nauth_api = Authentication(url_base=\"https://syneto-instance-ip-address/api/auth\", insecure_ssl=True)\nresponse = auth_api.login(username=\"admin\", password=\"admin\")\njwt = response['jwt']\n\nvirt_api = Virtualization(url_base=\"https://syneto-instance-ip-address/api/virtualization\", insecure_ssl=True)\nvirt_api.set_auth_jwt(jwt)\nprint(virt_api.get_vms())\n\nstorage_api = Storage(url_base=\"https://syneto-instance-ip-address/api/storage\", insecure_ssl=True)\nstorage_api.set_auth_jwt(jwt)\nprint(storage_api.get_pools())\n```\n\n# Environment Variables\n\nFor conveninence, the base urls for the api endpoints are also accepted as environment variables, please see below.\n\n```\nAUTH_SERVICE=https://syneto-instance-ip-address/api/auth\nVIRTUALIZATION_SERVICE=https://syneto-instance-ip-address/api/virtualization\nSTORAGE_SERVICE=https://syneto-instance-ip-address/api/storage\nPROTECTION_SERVICE=https://syneto-instance-ip-address/api/protection\n```\n\nIf you are using self-signed SSL certificates, set the following env. so that the http request library does not perform ssl verification. \n\n```\nALLOW_INSECURE_SSL=True\n```\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Syneto Client API library",
"version": "0.2.51",
"project_urls": {
"Homepage": "https://github.com/SynetoNet/syneto-api",
"Repository": "https://github.com/SynetoNet/syneto-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fe49be65ee75cf078ee679f3dceafed4f97e5643ea7dbfee0c0cb192dee5c785",
"md5": "012849f17cab4fa798532ed115fe32c9",
"sha256": "654da4ce27cc90fc0ac6265ee53d24bec834c437d2d37a0e3eee906e1d3a456b"
},
"downloads": -1,
"filename": "syneto_api-0.2.51-py3-none-any.whl",
"has_sig": false,
"md5_digest": "012849f17cab4fa798532ed115fe32c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.2,<4.0.0",
"size": 12995,
"upload_time": "2023-06-23T08:36:43",
"upload_time_iso_8601": "2023-06-23T08:36:43.016038Z",
"url": "https://files.pythonhosted.org/packages/fe/49/be65ee75cf078ee679f3dceafed4f97e5643ea7dbfee0c0cb192dee5c785/syneto_api-0.2.51-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a829107e77fabce48c2372d80a5d65a8097aa2bbb86810a2d3e9b6c5ae1812f5",
"md5": "874966a96e38f70b7b3e1ce893978006",
"sha256": "d981cdf195ac90d33e5425d77c8cfbe248dd260338ab861d513b920504e489ef"
},
"downloads": -1,
"filename": "syneto_api-0.2.51.tar.gz",
"has_sig": false,
"md5_digest": "874966a96e38f70b7b3e1ce893978006",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.2,<4.0.0",
"size": 10129,
"upload_time": "2023-06-23T08:36:45",
"upload_time_iso_8601": "2023-06-23T08:36:45.274969Z",
"url": "https://files.pythonhosted.org/packages/a8/29/107e77fabce48c2372d80a5d65a8097aa2bbb86810a2d3e9b6c5ae1812f5/syneto_api-0.2.51.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-23 08:36:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SynetoNet",
"github_project": "syneto-api",
"github_not_found": true,
"lcname": "syneto-api"
}
JSON
