Skip to content

Commit 4541eef

Browse files
committed
Updates and version bump
1 parent 2715dc5 commit 4541eef

File tree

6 files changed

+32
-9
lines changed

6 files changed

+32
-9
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Python bindings for Carbon Black REST API
22

3-
**Latest Version: 1.4.0**
3+
**Latest Version: 1.4.2**
44

55
[![Build Status](https://travis-ci.org/carbonblack/cbapi-python.svg?branch=master)](https://travis-ci.org/carbonblack/cbapi-python)
66

@@ -31,8 +31,8 @@ Backwards compatibility with old scripts is maintained through the `cbapi.legacy
3131
`cbapi.CbApi` directly will continue to work. Once cbapi 2.0.0 is released, the old `CbApi` will be deprecated and
3232
removed entirely no earlier than January 2017.
3333

34-
New scripts should use the `cbapi.CbResponseAPI` (for Cb Response) and
35-
`cbapi.CbProtectionAPI` (for Cb Protection / former Bit9) API entry points.
34+
New scripts should use the `cbapi.CbResponseAPI` (for CB Response) and
35+
`cbapi.CbProtectionAPI` (for CB Protection / former Bit9) API entry points.
3636

3737
## Getting Started
3838

@@ -98,14 +98,14 @@ will be adding more samples over time. For a quick start, see the following code
9898

9999
### API Token
100100

101-
In order to perform any queries via the API, you will need to get the API token for your Cb user. See the documentation
101+
In order to perform any queries via the API, you will need to get the API token for your CB user. See the documentation
102102
on the Developer Network website on how to acquire the API token for
103103
[Enterprise Response](http://developer.carbonblack.com/reference/enterprise-response/authentication/) or
104104
[Enterprise Protection](http://developer.carbonblack.com/reference/enterprise-protection/authentication/)
105105

106106
Once you acquire your API token, place it in one of the default credentials file locations:
107107

108-
* ``/etc/carbonblack/credentials.response`` (or ``.protection`` for Cb Enterprise Protection)
108+
* ``/etc/carbonblack/credentials.response`` (or ``.protection`` for CB Enterprise Protection)
109109
* ``~/.carbonblack/credentials.response``
110110
* (current working directory) ``.carbonblack/credentials.response``
111111

@@ -131,16 +131,16 @@ by comma separated key-value pairs providing the necessary credential informatio
131131

132132
The possible options for each credential profile are:
133133

134-
* **url**: The base URL of the Cb server. This should include the protocol (https) and the hostname, and nothing else.
134+
* **url**: The base URL of the CB server. This should include the protocol (https) and the hostname, and nothing else.
135135
* **token**: The API token for the user ID. More than one credential profile can be specified for a given server, with
136136
different tokens for each.
137137
* **ssl_verify**: True or False; controls whether the SSL/TLS certificate presented by the server is validated against
138138
the local trusted CA store.
139-
* **proxy**: A proxy specification that will be used when connecting to the Cb server. The format is:
139+
* **proxy**: A proxy specification that will be used when connecting to the CB server. The format is:
140140
``http://myusername:[email protected]:8001/`` where the hostname of the proxy is ``proxy.company.com``, port
141141
8001, and using username/password ``myusername`` and ``mypassword`` respectively.
142142
* **ignore_system_proxy**: If you have a system-wide proxy specified, setting this to True will force cbapi to bypass
143-
the proxy and directly connect to the Cb server.
143+
the proxy and directly connect to the CB server.
144144

145145
Future versions of cbapi will also provide the ability to "pin" the TLS certificate so as to provide certificate
146146
verification on self-signed or internal CA signed certificates.

docs/_static/Cb-Python-API.png

8.27 KB
Loading

docs/_static/css/custom.css

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.wy-side-nav-search {
2+
background-color: #FFFFFF;
3+
}
4+
5+
.pre {
6+
background-color: #FFFFFF;
7+
}

docs/changelog.rst

+13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
CbAPI Changelog
22
===============
3+
CbAPI 1.4.2 - Released March 27, 2019
4+
----------------------------------------
5+
6+
This release introduces additional support for Cb PSC's ThreatHunter APIs
7+
8+
* Threat Intelligence APIs
9+
10+
CbAPI 1.4.1 - Released January 10, 2019
11+
----------------------------------------
12+
13+
* Bug fixes
14+
* Adding to authorized error to make it clear that users should check API creds
15+
316
CbAPI 1.4.0 - Released January 10, 2019
417
----------------------------------------
518

docs/conf.py

+3
Original file line numberDiff line numberDiff line change
@@ -296,3 +296,6 @@
296296
}
297297

298298
autoclass_content = 'both'
299+
300+
def setup(app):
301+
app.add_stylesheet('css/custom.css')

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
setup(
3838
name='cbapi',
39-
version='1.4.1',
39+
version='1.4.2',
4040
url='https://github.com/carbonblack/cbapi-python',
4141
license='MIT',
4242
author='Carbon Black',

0 commit comments

Comments
 (0)