Proteus_API_Guide_3.7.1
Making APIs Work for You
BlueCat Gateway
An API Client for BlueCat to be able to easily use the API in a more standard way.
$ pip install BlueCatAPIClient
The argument "method" must be specify every time.
import BlueCatAPIClient
client = BlueCatAPIClient.Client(verify=False, warnings=False, api_version='v1')
client.get(url=None, method='', data=None, auth = None)
# client.headers
# client.url_base
# client.token
# client.sessionimport BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.get(method='searchByCategory', keyword='MyIPV4Block', category='all', count=1)
print(json.dumps(response.json(), indent=4))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.get(method='searchByCategory', keyword='MyIPV4Block', category='all', start=0, count=1)
print(json.dumps(response.json(), indent=4))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.get(method='getEntityById', id='12345')
print(json.dumps(response.json(), indent=4))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.get(method='searchByCategory', keyword='MyIPV4Block', category='all', start=0, count=1)
if response.status_code == 200:
properties = client.properties_to_json(response.json()[0].get('properties', ''))
print(properties)
print(client.json_to_properties(properties))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.post(method='addIP4BlockByCIDR', parentId='12345', CIDR='10.0.0.1/24', properties='name=MyIPV4Block')
print(json.dumps(response.json(), indent=4))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.get(method='searchByCategory', keyword='MyIPV4Block', category='all', start=0, count=1)
update_entity = response.json()[0]
update_entity['name'] = 'MyIPV4Block_TEST'
response = client.put(update_entity)
print(json.dumps(response.json(), indent=4))
client.disconnect()import BlueCatAPIClient
import json
client = BlueCatAPIClient.Client()
client.connect(url='https://BlueCat-server.local', username='admin', password='Admin123')
response = client.delete(ObjectId=12345)
print(json.dumps(response.json(), indent=4))
client.disconnect()