Merge pull request #183 from carbonblack/cbapi-1.6-develop

CBAPI 1.6 - Devices v6, Alerts v6

Author: abowersox-cb

.gitignore

@@ -68,6 +68,7 @@ target/
 # Eclipse/PyDev
 /.project
 /.pydevproject
+/.settings
 
 # Credential files
 .carbonblack/

README.md

@@ -1,6 +1,6 @@
 # Python bindings for Carbon Black REST API
 
-**Latest Version: 1.5.6**
+**Latest Version: 1.6.0**
 
 These are the new Python bindings for the Carbon Black Enterprise Response and Enterprise Protection REST APIs.
 To learn more about the REST APIs, visit the Carbon Black Developer Network Website at https://developer.carbonblack.com.

docs/changelog.rst

@@ -1,5 +1,43 @@
 CbAPI Changelog
 ===============
+.. top-of-changelog (DO NOT REMOVE THIS COMMENT)
+
+CbAPI 1.6.0 - Released December 3, 2019
+---------------------------------------
+
+Updates
+
+* New Carbon Black Cloud API Support
+	* Support for Devices v6:
+		* List and search for devices
+		* Export device information to CSV
+		* Device control actions: quarantine, bypass, background scan, deregister/delete, update
+	* Support for Alerts v6:
+		* Search for and retrieve alerts
+		* Update alert status (dismiss alerts)
+	
+Examples
+
+* Devices v6:
+	*	psc/device_control.py
+	*	psc/download_device_list.py
+	*	psc/list_devices.py
+* Alerts v6:
+	*	psc/alert_search_suggestions.py
+	*	psc/bulk_update_alerts.py
+	*	psc/bulk_update_cbanalytics_alerts.py
+	*	psc/bulk_update_threat_alerts.py
+	*	psc/bulk_update_vmware_alerts.py
+	*	psc/bulk_update_watchlist_alerts.py
+	*	psc/list_alert_facets.py
+	*	psc/list_alerts.py
+	*	psc/list_cbanalytics_alert_facets.py
+	*	psc/list_cbanalytics_alerts.py
+	*	psc/list_vmware_alert_facets.py
+	*	psc/list_vmware_alerts.py
+	*	psc/list_watchlist_alert_facets.py
+	*	psc/list_watchlist_alerts.py
+
 CbAPI 1.5.6 - Released November 19, 2019
 ----------------------------------------
 

docs/conf.py

@@ -12,18 +12,18 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
+# import sys (imports not needed)
+# import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -44,7 +44,7 @@
 source_suffix = '.rst'
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -59,9 +59,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.5'
+version = u'1.6'
 # The full version, including alpha/beta/rc tags.
-release = u'1.5.6'
+release = u'1.6.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -72,9 +72,9 @@
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -83,27 +83,27 @@
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'tango'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
@@ -124,14 +124,14 @@
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
-#html_title = u'cbapi v0.9.1'
+# html_title = u'cbapi v0.9.1'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -140,7 +140,7 @@
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -150,64 +150,64 @@
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []
 
 # If not None, a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
 # The empty string is equivalent to '%b %d, %Y'.
-#html_last_updated_fmt = None
+# html_last_updated_fmt = None
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Language to be used for generating the HTML full-text search index.
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
-#html_search_language = 'en'
+# html_search_language = 'en'
 
 # A dictionary with options for the search language support, empty by default.
 # 'ja' uses this config value.
 # 'zh' user can custom change `jieba` dictionary path.
-#html_search_options = {'type': 'default'}
+# html_search_options = {'type': 'default'}
 
 # The name of a javascript file (relative to the configuration directory) that
 # implements a search results scorer. If empty, the default will be used.
-#html_search_scorer = 'scorer.js'
+# html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'CarbonBlackAPI-PythonBindingsdoc'
@@ -222,23 +222,23 @@
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
@@ -251,7 +251,7 @@
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -266,16 +266,16 @@
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False
 
 latex_elements = {
     # Additional stuff for the LaTeX preamble.
@@ -291,11 +291,12 @@
     # Latex figure (float) alignment
     # 'figure_align': 'htbp',
     'preamble': "".join((
-        '\DeclareUnicodeCharacter{25A0}{=}',  # Solid box
+        '\\DeclareUnicodeCharacter{25A0}{=}',  # Solid box
     )),
 }
 
 autoclass_content = 'both'
 
+
 def setup(app):
     app.add_stylesheet('css/custom.css')

docs/index.rst

@@ -247,6 +247,7 @@ documenting all of the methods available to you.
    protection-api
    defense-api
    threathunter-api
+   psc-api
    livequery-api
    exceptions
 

docs/livequery-examples.rst

@@ -1,5 +1,5 @@
 CB LiveQuery API Examples
-========================
+=========================
 
 Let's cover a few example functions that our LiveQuery Python bindings enable. To begin, we need to import the
 relevant libraries::