# Python API client for DETERRERS
This library makes it easy to interact with the DETERRERS perimeter firewall
portal to automate registration, and configuration of IP addresses and firewall
profiles.
## Installation
Use pip to install the latest version:
```
pip install deterrers-api
```
## Example
```python
import deterrersapi
deterrers = deterrersapi.Deterrers('https://deterrers.example.com', '<api-token>')
# get information about ip address
deterrers.get('192.0.0.1')
# delete ip address
deterrers.delete('192.0.0.1')
# add a new ip address with `virtUOS` as admin
deterrers.add('192.0.0.1', ['virtUOS'])
# update ip with firewall profile `Multipurpose`
deterrers.update('192.0.0.1', 'Multipurpose', '')
# activate firewall profile
deterrers.action('192.0.0.1', 'register')
```
Raw data
{
"_id": null,
"home_page": "https://github.com/virtUOS/deterrers-api",
"name": "deterrers-api",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Lars Kiesow",
"author_email": "lkiesow@uos.de",
"download_url": "https://files.pythonhosted.org/packages/b6/6b/e7828b6ab538bab5b6324f648a87cbc730aa4ead899c97a2ac3737a75fc5/deterrers-api-0.5.tar.gz",
"platform": null,
"description": "# Python API client for DETERRERS\n\nThis library makes it easy to interact with the DETERRERS perimeter firewall\nportal to automate registration, and configuration of IP addresses and firewall\nprofiles.\n\n## Installation\n\nUse pip to install the latest version:\n\n```\npip install deterrers-api\n```\n\n## Example\n\n```python\nimport deterrersapi\n\n\ndeterrers = deterrersapi.Deterrers('https://deterrers.example.com', '<api-token>')\n\n# get information about ip address\ndeterrers.get('192.0.0.1')\n\n# delete ip address\ndeterrers.delete('192.0.0.1')\n\n# add a new ip address with `virtUOS` as admin\ndeterrers.add('192.0.0.1', ['virtUOS'])\n\n# update ip with firewall profile `Multipurpose`\ndeterrers.update('192.0.0.1', 'Multipurpose', '')\n\n# activate firewall profile\ndeterrers.action('192.0.0.1', 'register')\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python API client for DETERRERS",
"version": "0.5",
"project_urls": {
"Homepage": "https://github.com/virtUOS/deterrers-api"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b66be7828b6ab538bab5b6324f648a87cbc730aa4ead899c97a2ac3737a75fc5",
"md5": "00b626ce4adc2a15efbf2cd7498bace8",
"sha256": "86b0d069f527951b70ad0d1ab69eee7e6216e673dc8cc57926d14fc7a2bf3e4b"
},
"downloads": -1,
"filename": "deterrers-api-0.5.tar.gz",
"has_sig": false,
"md5_digest": "00b626ce4adc2a15efbf2cd7498bace8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3985,
"upload_time": "2023-11-30T09:48:50",
"upload_time_iso_8601": "2023-11-30T09:48:50.605762Z",
"url": "https://files.pythonhosted.org/packages/b6/6b/e7828b6ab538bab5b6324f648a87cbc730aa4ead899c97a2ac3737a75fc5/deterrers-api-0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-30 09:48:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "virtUOS",
"github_project": "deterrers-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "deterrers-api"
}
JSON
