https://github.com/armorblox/armorblox-python-sdk
Armorblox SDK for Python
https://github.com/armorblox/armorblox-python-sdk
email-security python sdk security
Last synced: 6 months ago
JSON representation
Armorblox SDK for Python
- Host: GitHub
- URL: https://github.com/armorblox/armorblox-python-sdk
- Owner: armorblox
- License: apache-2.0
- Created: 2021-11-02T11:03:54.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-21T12:28:18.000Z (over 3 years ago)
- Last Synced: 2025-07-20T01:10:41.415Z (12 months ago)
- Topics: email-security, python, sdk, security
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Armorblox Python SDK (Alpha)
[](https://badge.fury.io/py/armorblox-sdk)
[](https://www.apache.org/licenses/LICENSE-2.0)
This is an alpha version of the SDK with limited documentation and no support.
## Requirements
Python 3.5+
## Installation
```
pip install armorblox-sdk
```
## Usage
```
from armorblox import client
# Create an API client for your tenant
c = client.Client(api_key='your-api-key-here', instance_name='yourtenantname')
# Fetch information about an incident's analysis data
incident_analysis = c.incidents.analysis(78143)
# Fetch information about an incident's sender data
incident_senders = c.incidents.senders(78143)
# Fetch information about an object associated with an incident (usually mail).
# Get the object ID from Get Incident by Id's response, under .events[].object_id
incident_object = c.incidents.mail('d72c07bc789c30cb4d63d78ee2861f94add695f9c812e30cfb081b20d3e7e5e7')
# Updates the action to be taken for an incident's objects
update_details = c.incidents.update(78143, body = {
"policyActionType": "DELETE",
"addSenderToException": False,
"actionProfileId": ""
})
# Fetch a list of threats
threat_incidents, next_page_token, total_incident_count = c.threats.list()
# Fetch a specific threat
incident = c.threats.get(44006)
# Fetch a list of abuse incidents
abuse_incidents, next_page_token, total_incident_count = c.abuse_incidents.list()
# Fetch a specific abuse incident
abuse_incident = c.abuse_incidents.get(44200)
# Fetch a list of DLP incidents
dlp_incidents, next_page_token, total_incident_count = c.dlp_incidents.list()
# Fetch a specific DLP incident
dlp_incident = c.dlp_incidents.get(44010)
# Fetch a list of EAC incidents
eac_incidents, next_page_token, total_incident_count = c.eac_incidents.list()
# Fetch a specific EAC incident
eac_incident = c.eac_incidents.get(67)
# Fetch a list of Graymail incidents
graymail_incidents, next_page_token, total_incident_count = c.graymail_incidents.list()
# Fetch a specific EAC incident
graymail_incident = c.graymail_incidents.get(2627)
# Example to fetch all threats using next_page_token
next_page_token = None
incidents = []
while True:
threats, next_page_token, total_incident_count = c.threats.list(page_token=next_page_token)
incidents.extend(threats)
if not next_page_token:
break
```
## Contributing
* Install [Poetry](https://python-poetry.org)
* Clone the SDK repo & `cd` into it
```
git clone https://github.com/armorblox/armorblox-python-sdk
cd armorblox-python-sdk
```
* Run `poetry install` to install the dependencies
* Run `tox` to run the tests
## Publishing
#### TestPyPI
One-time setup
```
poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi
```
Publishing
```
poetry publish --build -r test-pypi
```
Use
```
pip install --index-url https://test.pypi.org/simple/ --no-deps armorblox-sdk
```
to make sure the installation works correctly.
#### PyPI
One-time setup
```
poetry config pypi-token.pypi
```
Publishing
```
poetry publish --build
```