| Name | pyfsr JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | Python implementation of the FortiSOAR REST API |
| upload_time | 2024-12-25 21:52:05 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
api
fortinet
fortisoar
rest
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyfsr
[Documentation](https://ftnt-dspille.github.io/pyfsr/) | [Installation](#installation) | [Quick Start](#quick-start)
**PyFSR** is a Python client library for the FortiSOAR REST API, allowing you to interact with FortiSOAR
programmatically.
## Installation
```bash
pip install pyfsr
```
## Quick Start
```python
from pyfsr import FortiSOAR
# Initialize the client
client = FortiSOAR('your-server', 'your-token')
# or
# client = FortiSOAR('your-server', ('your-username', 'your-password'))
# Generic get call to Alerts endpoint
response = client.get('/api/v3/alerts')
# Create an alert
alert_data = {
"name": "Test Alert",
"description": "This is a test alert",
"severity": "High"
}
alert_record = client.alerts.create(**alert_data)
# List all alerts
alerts = client.alerts.list()
# Get a specific alert
alert = client.alerts.get("alert-id")
```
## Features
- Simple API interface
- Support for all FortiSOAR API endpoints using a generic `get`, `post`, `put`, `delete` methods
- Authentication handling
- Type hints for better IDE support
## Roadmap
- Add support for more API endpoints
- Add support for more complex API calls
- Filtering
- Pagination
- Starting Playbooks
- HMAC Authentication
- Better Unit Testing
## Important Notes
This library is a work in progress and is not yet ready for production use.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyfsr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "api, fortinet, fortisoar, rest",
"author": null,
"author_email": "Dylan Spille <dspille@fortinet.com>",
"download_url": "https://files.pythonhosted.org/packages/a2/9f/861910f8f5af28d31cdcd1fa815810a402989e781e793c51607a9df63caf/pyfsr-0.2.2.tar.gz",
"platform": null,
"description": "# pyfsr\n\n[Documentation](https://ftnt-dspille.github.io/pyfsr/) | [Installation](#installation) | [Quick Start](#quick-start)\n\n**PyFSR** is a Python client library for the FortiSOAR REST API, allowing you to interact with FortiSOAR\nprogrammatically.\n\n## Installation\n\n```bash\npip install pyfsr\n```\n\n## Quick Start\n\n```python\nfrom pyfsr import FortiSOAR\n\n# Initialize the client\nclient = FortiSOAR('your-server', 'your-token')\n# or\n# client = FortiSOAR('your-server', ('your-username', 'your-password'))\n\n# Generic get call to Alerts endpoint\nresponse = client.get('/api/v3/alerts')\n\n# Create an alert\nalert_data = {\n \"name\": \"Test Alert\",\n \"description\": \"This is a test alert\",\n \"severity\": \"High\"\n}\nalert_record = client.alerts.create(**alert_data)\n\n# List all alerts\nalerts = client.alerts.list()\n\n# Get a specific alert\nalert = client.alerts.get(\"alert-id\")\n```\n\n## Features\n\n- Simple API interface\n- Support for all FortiSOAR API endpoints using a generic `get`, `post`, `put`, `delete` methods\n- Authentication handling\n- Type hints for better IDE support\n\n## Roadmap\n\n- Add support for more API endpoints\n- Add support for more complex API calls\n - Filtering\n - Pagination\n - Starting Playbooks\n- HMAC Authentication\n- Better Unit Testing\n\n## Important Notes\n\nThis library is a work in progress and is not yet ready for production use.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python implementation of the FortiSOAR REST API",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/ftnt-dspille/pyfsr/issues",
"Docmentation": "https://ftnt-dspille.github.io/pyfsr/",
"Homepage": "https://github.com/ftnt-dspille/pyfsr"
},
"split_keywords": [
"api",
" fortinet",
" fortisoar",
" rest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94210c9123dd74ed1c9e61e567ab8f4c55b7eb6615c18206ee3ddb7cd97819b2",
"md5": "e1e4136b6b5a46003b7b9eedc78922b3",
"sha256": "f7b47fbb580133e9f3362c726abb4e5c0855e986c8eaaf515f82b56fa000814b"
},
"downloads": -1,
"filename": "pyfsr-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e1e4136b6b5a46003b7b9eedc78922b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15101,
"upload_time": "2024-12-25T21:52:03",
"upload_time_iso_8601": "2024-12-25T21:52:03.814109Z",
"url": "https://files.pythonhosted.org/packages/94/21/0c9123dd74ed1c9e61e567ab8f4c55b7eb6615c18206ee3ddb7cd97819b2/pyfsr-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a29f861910f8f5af28d31cdcd1fa815810a402989e781e793c51607a9df63caf",
"md5": "7ba139c5fe21d3c1076d90dc5ba90464",
"sha256": "da1eecc63d6b9eae6058c17b433977ddb7d0653c438ad2153e8ef453fd8f1168"
},
"downloads": -1,
"filename": "pyfsr-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "7ba139c5fe21d3c1076d90dc5ba90464",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 50264,
"upload_time": "2024-12-25T21:52:05",
"upload_time_iso_8601": "2024-12-25T21:52:05.286833Z",
"url": "https://files.pythonhosted.org/packages/a2/9f/861910f8f5af28d31cdcd1fa815810a402989e781e793c51607a9df63caf/pyfsr-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-25 21:52:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ftnt-dspille",
"github_project": "pyfsr",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyfsr"
}
