Skip to main content

Python api client for firepower management center

Project description

python3 pypi license status published


A simple wrapper for firepower management center restful api.


  • Authentication and automatic session refresh
  • Rate-limit handling with automatic retry operation
  • Automatic squashing of paginated api payloads
  • Sanitization of api payloads received via GET operations and used for PUT/POST operations
  • Debug logging for api calls using logger module
  • Result caching for various operations


  • Python >= 3.7



pip install fireREST

Import api client

from fireREST import Client


FireREST uses basic authentication to authenticate with fmc. In case your authentication token times out the api client will automatically try to re-authenticate 3 times and handle any intermediate authentication exceptions.

Basic Authentication

client = Client(hostname='', username='firerest', password='Cisco123')


A variety of helper functions can be used to translate object names to their respective UUID values. Since fmc rest api uses uuid values this is neccessary to find pre-existing objects by the name defined in fmc.

Object Name to ID

name = 'NET_OBJ'
uuid = client.get_object_id_by_name('network', name)

Access Control Policy Name to ID

uuid = client.get_acp_id_by_name(name)

Access Control Policy Rule Name to ID

uuid = client.get_object_id_by_name(acp, acp_rule)


Create Network Object

net_obj = {
    'name': 'NetObjViaAPI',
    'value': '',

response = client.create_object('network', net_obj)

Get Network Object

obj_name = 'NetObjViaAPI'
obj_id = client.get_object_id_by_name('network', 'NetObjViaAPI')
obj_payload = client.get_object('network', obj_id)

Update Network Object

obj_name = 'NetObjViaAPI'
obj_id = client.get_object_id_by_name('network', 'NetObjViaAPI')

net_obj = {
    'id': obj_id,
    'name': 'NetObjViaAPI',
    'value': '',

response = client.update_object('network', obj_id, net_obj)

Delete Network Object

obj_name = 'NetObjViaAPI'
obj_id = client.get_object_id_by_name('network', 'NetObjViaAPI')
response = client.delete_object('network', obj_id)


Oliver Kaiser (


GNU General Public License v3.0 or later.

See LICENSE for the full text.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for fireREST, version 0.1.4
Filename, size File type Python version Upload date Hashes
Filename, size fireREST-0.1.4.tar.gz (15.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page