Merge pull request #194 from carbonblack/lhilmes-cb-patch-1

Updated readme, edits to PSC copy

Author: bvasil-cb

README.md

@@ -114,7 +114,7 @@ For distinction between credentials of different Carbon Black products, use the
 * ``credentials.response`` for CB Response
 * ``credentials.protection`` for CB Protection
 
-For example, if you use a PSC product, you should have created a credentials file in one of these locations:
+For example, if you use a Carbon Black Cloud product, you should have created a credentials file in one of these locations:
 
 * ``/etc/carbonblack/credentials.psc``
 * ``~/.carbonblack/credentials.psc``
@@ -147,7 +147,7 @@ The possible options for each credential profile are:
   different tokens for each.
 * **ssl_verify**: True or False; controls whether the SSL/TLS certificate presented by the server is validated against
   the local trusted CA store.
-* **org_key**: The organization key. This is required to access the PSC, and can be found in the console. The format is ``123ABC45``.
+* **org_key**: The organization key. This is required to access the Carbon Black Cloud, and can be found in the console. The format is ``123ABC45``.
 * **proxy**: A proxy specification that will be used when connecting to the CB server. The format is:
   ``http://myusername:[email protected]:8001/`` where the hostname of the proxy is ``proxy.company.com``, port
   8001, and using username/password ``myusername`` and ``mypassword`` respectively.

bin/cbapi-psc

@@ -40,7 +40,7 @@ def configure(opts):
     if not os.path.exists(credential_path):
         os.makedirs(credential_path, 0o700)
 
-    url = input("URL to the Cb PSC API server (do not include '/integrationServices') [https://hostname]: ")
+    url = input("URL to the Carbon Black Cloud API server (do not include '/integrationServices') [https://hostname]: ")
 
     ssl_verify = True
 

docs/getting-started.rst

@@ -36,7 +36,7 @@ Alternatively, if you're using Windows (change ``c:\python27`` if Python is inst
 This configuration script will walk you through entering your API credentials and will save them to your current user's
 credential file location, which is located in the ``.carbonblack`` directory in your user's home directory.
 
-If using cbapi-psc, you will also be asked to provide an org key. An org key is required to access the PSC, and can be found in the console under Settings -> API Keys.
+If using cbapi-psc, you will also be asked to provide an org key. An org key is required to access the Carbon Black Cloud, and can be found in the console under Settings -> API Keys.
 
 Your First Query
 ----------------

docs/index.rst

@@ -137,7 +137,7 @@ For distinction between credentials of different Carbon Black products, use the
 * ``credentials.response`` for CB Response
 * ``credentials.protection`` for CB Protection
 
-For example, if you use a PSC product, you should have created a credentials file in one of these locations:
+For example, if you use a Carbon Black Cloud product, you should have created a credentials file in one of these locations:
 
 * ``/etc/carbonblack/credentials.psc``
 * ``~/.carbonblack/credentials.psc``
@@ -170,7 +170,7 @@ The possible options for each credential profile are:
   different tokens for each.
 * **ssl_verify**: True or False; controls whether the SSL/TLS certificate presented by the server is validated against
   the local trusted CA store.
-* **org_key**: The organization key. This is required to access the PSC, and can be found in the console. The format is ``123ABC45``.
+* **org_key**: The organization key. This is required to access the Carbon Black Cloud, and can be found in the console. The format is ``123ABC45``.
 * **proxy**: A proxy specification that will be used when connecting to the CB server. The format is:
   ``http://myusername:[email protected]:8001/`` where the hostname of the proxy is ``proxy.company.com``, port
   8001, and using username/password ``myusername`` and ``mypassword`` respectively.
@@ -184,9 +184,9 @@ Environment Variable Support
 
 The latest cbapi for python supports specifying API credentials in the following three environment variables:
 
-`CBAPI_TOKEN` the envar for holding the CbR/CbP api token or the ConnectorId/APIKEY combination for CB Defense/PSC.
+`CBAPI_TOKEN` the envar for holding the CbR/CbP api token or the ConnectorId/APIKEY combination for CB Defense/Carbon Black Cloud.
 
-The `CBAPI_URL` envar holds the FQDN of the target, a CbR , CBD, or CbD/PSC server specified just as they are in the
+The `CBAPI_URL` envar holds the FQDN of the target, a CbR , CBD, or CbD/Carbon Black Cloud server specified just as they are in the
 configuration file format specified above.
 
 The  optional `CBAPI_SSL_VERIFY` envar can be used to control SSL validation(True/False or 0/1), which will default to ON when

docs/threathunter-api.rst

@@ -4,7 +4,7 @@ CB ThreatHunter API
 ===================
 
 This page documents the public interfaces exposed by cbapi when communicating with a
-Carbon Black PSC ThreatHunter server.
+Carbon Black Cloud ThreatHunter server.
 
 Main Interface
 --------------

src/cbapi/psc/livequery/rest_api.py

@@ -7,7 +7,7 @@
 
 
 class CbLiveQueryAPI(BaseAPI):
-    """The main entry point into the Cb PSC LiveQuery API.
+    """The main entry point into the Carbon Black Cloud LiveQuery API.
 
     :param str profile: (optional) Use the credentials in the named profile when connecting to the Carbon Black server.
         Uses the profile named 'default' when not specified.

src/cbapi/psc/threathunter/rest_api.py

@@ -8,7 +8,7 @@
 
 
 class CbThreatHunterAPI(BaseAPI):
-    """The main entry point into the Cb ThreatHunter PSC API.
+    """The main entry point into the Carbon Black Cloud ThreatHunter API.
 
     :param str profile: (optional) Use the credentials in the named profile when connecting to the Carbon Black server.
         Uses the profile named 'default' when not specified.