1
1
# Python bindings for Carbon Black REST API
2
2
3
- ** Latest Version: 1.4.0 **
3
+ ** Latest Version: 1.4.2 **
4
4
5
5
[ ![ Build Status] ( https://travis-ci.org/carbonblack/cbapi-python.svg?branch=master )] ( https://travis-ci.org/carbonblack/cbapi-python )
6
6
@@ -31,8 +31,8 @@ Backwards compatibility with old scripts is maintained through the `cbapi.legacy
31
31
` cbapi.CbApi ` directly will continue to work. Once cbapi 2.0.0 is released, the old ` CbApi ` will be deprecated and
32
32
removed entirely no earlier than January 2017.
33
33
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.
36
36
37
37
## Getting Started
38
38
@@ -98,14 +98,14 @@ will be adding more samples over time. For a quick start, see the following code
98
98
99
99
### API Token
100
100
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
102
102
on the Developer Network website on how to acquire the API token for
103
103
[ Enterprise Response] ( http://developer.carbonblack.com/reference/enterprise-response/authentication/ ) or
104
104
[ Enterprise Protection] ( http://developer.carbonblack.com/reference/enterprise-protection/authentication/ )
105
105
106
106
Once you acquire your API token, place it in one of the default credentials file locations:
107
107
108
- * `` /etc/carbonblack/credentials.response `` (or `` .protection `` for Cb Enterprise Protection)
108
+ * `` /etc/carbonblack/credentials.response `` (or `` .protection `` for CB Enterprise Protection)
109
109
* `` ~/.carbonblack/credentials.response ``
110
110
* (current working directory) `` .carbonblack/credentials.response ``
111
111
@@ -131,16 +131,16 @@ by comma separated key-value pairs providing the necessary credential informatio
131
131
132
132
The possible options for each credential profile are:
133
133
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.
135
135
* ** token** : The API token for the user ID. More than one credential profile can be specified for a given server, with
136
136
different tokens for each.
137
137
* ** ssl_verify** : True or False; controls whether the SSL/TLS certificate presented by the server is validated against
138
138
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:
140
140
`` http://myusername:[email protected] :8001/ `` where the hostname of the proxy is
`` proxy.company.com `` , port
141
141
8001, and using username/password `` myusername `` and `` mypassword `` respectively.
142
142
* ** 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.
144
144
145
145
Future versions of cbapi will also provide the ability to "pin" the TLS certificate so as to provide certificate
146
146
verification on self-signed or internal CA signed certificates.
0 commit comments