# 360 Monitoring CLI
This repository contains a CLI script for 360 Monitoring that allows you to connect to your 360 Monitoring (https://360monitoring.com) account and list monitoring data, add, update or remove server or website monitors.
## Documentation
You can find the full documentation including the feature complete REST API at [docs.360monitoring.com](https://docs.360monitoring.com/docs) and [docs.360monitoring.com/docs/api](https://docs.360monitoring.com/docs/api).
## Preconditions
* Make sure to have an account at https://360monitoring.com or https://platform360.io
* 360 Monitoring CLI requires a Python version of 3.* or above
## Install 360 Monitoring CLI as ready-to-use package
$ pip install 360monitoringcli
## Configure your account
First you need to connect your CLI to your existing 360 Monitoring account via your API KEY. If you don't have a 360 Monitoring account yet, please register for free at https://360monitoring.com. To create an API KEY you'll need to upgrade at least to a Pro plan to be able to create your API KEY.
$ 360monitoring config save --api-key KEY configure API KEY to connect to 360 Monitoring account
## Test 360 Monitoring CLI locally
### Test 360 Monitoring CLI with pre-configured Docker image
You can easily test and run 360 Monitoring CLI for production by running the pre-configured docker image
$ docker build -t 360monitoringcli .
$ docker run -it --rm 360monitoringcli /bin/bash
### Test 360 Monitoring CLI for specific staging version
To test a package from staging you can simply deploy a docker container:
$ docker run -it --rm ubuntu /bin/bash
$ apt-get update && apt-get install -y python3 && apt-get install -y pip
$ pip install -i https://test.pypi.org/simple/ --force-reinstall -v "360monitoringcli==1.0.19"
### For developement, install required Python modules
To test the code locally, install the Python modules "requests", "configparser", "argparse" and "prettytable".
Use "pip install -e ." to use "360monitoring" command with latest dev build locally based on local code.
$ pip install requests
$ pip install configparser
$ pip install argparse
$ pip install prettytable
$ pip install -e .
#### Run tests to check each function works
Test the code:
$ ./test_cli.sh
## Usage
$ 360monitoring --help display general help
$ 360monitoring signup open the sign up page to get your 360 Monitoring account
$ 360monitoring config save --api-key KEY configure API KEY to connect to 360 Monitoring account (only for paid plans)
$ 360monitoring statistics display all assets of your account
$ 360monitoring servers list display all monitored servers
$ 360monitoring servers list --issues display monitored servers with issues only
$ 360monitoring servers list --tag cpanel display only servers with tag "cpanel"
$ 360monitoring sites list display all monitored sites
$ 360monitoring sites list --issues display monitored sites with issues only
$ 360monitoring sites list --sort 6 --limit 5 display worst 5 monitored sites by uptime
$ 360monitoring contacts list display all contacts
$ 360monitoring usertokens list display user tokens
$ 360monitoring config print display your current settings and where those are stored
$ 360monitoring recommendations display upgrade recommendations for servers that exceed their limits
$ 360monitoring magiclinks create and open a readonly dashboard for a single server only via magic link
$ 360monitoring wptoolkit display statistics of WP Toolkit if installed
$ 360monitoring sites add --url domain.tld start monitoring a new website
$ 360monitoring servers update --name cpanel123.hoster.com --tag production tag a specific server
$ 360monitoring contacts --help display specific help for a sub command
$ 360monitoring dashboard open 360 Monitoring in your Web Browser
## Updating 360 Monitoring CLI package
You can update the 360monitoringcli package to the latest version using the following command:
$ pip install 360monitoringcli --upgrade
Raw data
{
"_id": null,
"home_page": "https://github.com/plesk/360monitoring-cli",
"name": "360monitoringcli",
"maintainer": "Jan Loeffler",
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": "jan.loeffler@webpros.com",
"keywords": "360 system monitoring cli",
"author": "Jan Loeffler",
"author_email": "jan.loeffler@webpros.com",
"download_url": "https://files.pythonhosted.org/packages/0a/20/73b476f95330268b179608ba97d92ce53f2e128dfa40f1b875a79cce6950/360monitoringcli-1.0.19.tar.gz",
"platform": null,
"description": "# 360 Monitoring CLI\n\nThis repository contains a CLI script for 360 Monitoring that allows you to connect to your 360 Monitoring (https://360monitoring.com) account and list monitoring data, add, update or remove server or website monitors.\n\n## Documentation\n\nYou can find the full documentation including the feature complete REST API at [docs.360monitoring.com](https://docs.360monitoring.com/docs) and [docs.360monitoring.com/docs/api](https://docs.360monitoring.com/docs/api).\n\n## Preconditions\n\n * Make sure to have an account at https://360monitoring.com or https://platform360.io\n * 360 Monitoring CLI requires a Python version of 3.* or above\n\n## Install 360 Monitoring CLI as ready-to-use package\n\n $ pip install 360monitoringcli\n\n## Configure your account\n\nFirst you need to connect your CLI to your existing 360 Monitoring account via your API KEY. If you don't have a 360 Monitoring account yet, please register for free at https://360monitoring.com. To create an API KEY you'll need to upgrade at least to a Pro plan to be able to create your API KEY.\n\n $ 360monitoring config save --api-key KEY configure API KEY to connect to 360 Monitoring account\n\n## Test 360 Monitoring CLI locally\n\n### Test 360 Monitoring CLI with pre-configured Docker image\n\nYou can easily test and run 360 Monitoring CLI for production by running the pre-configured docker image\n\n $ docker build -t 360monitoringcli .\n $ docker run -it --rm 360monitoringcli /bin/bash\n\n### Test 360 Monitoring CLI for specific staging version\n\n To test a package from staging you can simply deploy a docker container:\n\n $ docker run -it --rm ubuntu /bin/bash\n $ apt-get update && apt-get install -y python3 && apt-get install -y pip\n $ pip install -i https://test.pypi.org/simple/ --force-reinstall -v \"360monitoringcli==1.0.19\"\n\n### For developement, install required Python modules\n\n To test the code locally, install the Python modules \"requests\", \"configparser\", \"argparse\" and \"prettytable\".\n Use \"pip install -e .\" to use \"360monitoring\" command with latest dev build locally based on local code.\n\n $ pip install requests\n $ pip install configparser\n $ pip install argparse\n $ pip install prettytable\n $ pip install -e .\n\n#### Run tests to check each function works\n\nTest the code:\n\n $ ./test_cli.sh\n\n## Usage\n\n $ 360monitoring --help display general help\n $ 360monitoring signup open the sign up page to get your 360 Monitoring account\n $ 360monitoring config save --api-key KEY configure API KEY to connect to 360 Monitoring account (only for paid plans)\n $ 360monitoring statistics display all assets of your account\n $ 360monitoring servers list display all monitored servers\n $ 360monitoring servers list --issues display monitored servers with issues only\n $ 360monitoring servers list --tag cpanel display only servers with tag \"cpanel\"\n $ 360monitoring sites list display all monitored sites\n $ 360monitoring sites list --issues display monitored sites with issues only\n $ 360monitoring sites list --sort 6 --limit 5 display worst 5 monitored sites by uptime\n $ 360monitoring contacts list display all contacts\n $ 360monitoring usertokens list display user tokens\n $ 360monitoring config print display your current settings and where those are stored\n $ 360monitoring recommendations display upgrade recommendations for servers that exceed their limits\n $ 360monitoring magiclinks create and open a readonly dashboard for a single server only via magic link\n $ 360monitoring wptoolkit display statistics of WP Toolkit if installed\n\n $ 360monitoring sites add --url domain.tld start monitoring a new website\n $ 360monitoring servers update --name cpanel123.hoster.com --tag production tag a specific server\n\n $ 360monitoring contacts --help display specific help for a sub command\n $ 360monitoring dashboard open 360 Monitoring in your Web Browser\n\n## Updating 360 Monitoring CLI package\nYou can update the 360monitoringcli package to the latest version using the following command:\n\n $ pip install 360monitoringcli --upgrade\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "360 Monitoring CLI",
"version": "1.0.19",
"project_urls": {
"Homepage": "https://github.com/plesk/360monitoring-cli"
},
"split_keywords": [
"360",
"system",
"monitoring",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee532a6e69bb322bf3a291210a030cb7ba1caaa9b4a2efb97b26d4ad337235e3",
"md5": "bd478cf9bddc026c0e1b5dd83a0209d3",
"sha256": "2eebbeeab329383d1df53acd3d0ce61a9bbe9ca25c6a772f6661418b98257971"
},
"downloads": -1,
"filename": "360monitoringcli-1.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bd478cf9bddc026c0e1b5dd83a0209d3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 39959,
"upload_time": "2023-05-02T21:52:50",
"upload_time_iso_8601": "2023-05-02T21:52:50.272925Z",
"url": "https://files.pythonhosted.org/packages/ee/53/2a6e69bb322bf3a291210a030cb7ba1caaa9b4a2efb97b26d4ad337235e3/360monitoringcli-1.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a2073b476f95330268b179608ba97d92ce53f2e128dfa40f1b875a79cce6950",
"md5": "16d2e049681eb531218b952ac08c2b2d",
"sha256": "4b29c25fcd414f80273f0daf6780454e45e0b2efb22a2f54a420b51387e64eab"
},
"downloads": -1,
"filename": "360monitoringcli-1.0.19.tar.gz",
"has_sig": false,
"md5_digest": "16d2e049681eb531218b952ac08c2b2d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 24532,
"upload_time": "2023-05-02T21:52:51",
"upload_time_iso_8601": "2023-05-02T21:52:51.993580Z",
"url": "https://files.pythonhosted.org/packages/0a/20/73b476f95330268b179608ba97d92ce53f2e128dfa40f1b875a79cce6950/360monitoringcli-1.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-02 21:52:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plesk",
"github_project": "360monitoring-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "360monitoringcli"
}
JSON
