An API Client to use Firemon RESTful API.
Project description
FiremonAPIClient
An API Client for Firemon to be able to easily use the API in a more standard way.
How to install
$ pip install FiremonAPIClient
Usage
the argument "method" must be specify everytime. Look at authentication validation for an example.
Default arguments and attributes
import FiremonAPIClient
client = FiremonAPIClient.Client(verify=False, warnings=False, api_version='v1')
client.get(url=None, method='', data=None, auth = None)
# client.headers
# client.url_base
# client.token
Import and instantiate the class
import FiremonAPIClient
client = FiremonAPIClient.Client()
Connect, Validate authentication and Disconnect
import FiremonAPIClient
import json
client = FiremonAPIClient.Client()
client.connect(url='https://firemon-server.local', username='admin', password='Admin123')
response = client.post(method='/authentication/validate', data={'username': 'admin', 'password': 'Admin123'})
print(json.dumps(response.json(), indent=4), response.status_code, response.reason)
client.disconnect()
How to get an object
import FiremonAPIClient
import json
client = FiremonAPIClient.Client()
client.connect(url='https://firemon-server.local', username='admin', password='Admin123')
domain_id = 1
group_name = 'mytestgroup'
response = client.get(method=f'/domain/{domain_id}/usergroup/name/{group_name}')
print(json.dumps(response.json(), indent=4), response.status_code, response.reason)
client.disconnect()
How to create an object
import FiremonAPIClient
import json
client = FiremonAPIClient.Client()
client.connect(url='https://firemon-server.local', username='admin', password='Admin123')
domain_id = 1
group_name = 'mytestgroup'
response = client.post(method=f'/domain/{domain_id}/usergroup', domainId=domain_id, data={
"name": group_name, "description": "This group is a test and can be deleted"})
print(json.dumps(response.json(), indent=4), response.status_code, response.reason)
client.disconnect()
How to update an object
import FiremonAPIClient
client = FiremonAPIClient.Client()
client.connect(url='https://firemon-server.local', username='admin', password='Admin123')
domain_id = 1
group_id = 123
group_name = 'mytestgroup'
response = client.put(method=f'/domain/{domain_id}/usergroup/{group_id}', domainId=domain_id, id=group_id,
data={"id": group_id, "domainId": domain_id, "name": group_name,
"description": "This group is a test and it has been updated and can be deleted"})
print(response.status_code, response.reason)
client.disconnect()
How to delete an object
import FiremonAPIClient
client = FiremonAPIClient.Client()
client.connect(url='https://firemon-server.local', username='admin', password='Admin123')
domain_id = 1
group_id = 123
response = client.delete(method=f'/domain/{domain_id}/usergroup/{group_id}', domainId=domain_id, id=group_id)
print(response.status_code, response.reason)
client.disconnect()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
FiremonAPIClient-0.0.1.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for FiremonAPIClient-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8543c7814ff1593c7850c202c24dd2c18f4d1698cd549c22ee0a9b44c9e9b551 |
|
MD5 | 9014b24248517712b1c9c7bd3e60e95a |
|
BLAKE2b-256 | 6a768f906f87273a07badf5a1f4f13279e1995e5c4af94ccfa4ed860548bbd4e |