{"id":21621651,"url":"https://github.com/carbonblack/carbon-black-cloud-sdk-python","last_synced_at":"2026-01-26T01:35:01.628Z","repository":{"id":37855664,"uuid":"279401084","full_name":"carbonblack/carbon-black-cloud-sdk-python","owner":"carbonblack","description":"VMware Carbon Black Cloud Python SDK","archived":false,"fork":false,"pushed_at":"2025-06-27T17:55:53.000Z","size":8035,"stargazers_count":44,"open_issues_count":0,"forks_count":22,"subscribers_count":12,"default_branch":"develop","last_synced_at":"2026-01-04T13:52:14.859Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/carbonblack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-13T20:07:55.000Z","updated_at":"2025-06-27T17:53:50.000Z","dependencies_parsed_at":"2023-12-04T14:39:00.860Z","dependency_job_id":"828980c2-01db-4f80-aa67-c39d269ded37","html_url":"https://github.com/carbonblack/carbon-black-cloud-sdk-python","commit_stats":{"total_commits":1151,"total_committers":24,"mean_commits":"47.958333333333336","dds":0.6064291920069504,"last_synced_commit":"e99d267eadd7160eaa84d6ad8deb690174eb0bb7"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"purl":"pkg:github/carbonblack/carbon-black-cloud-sdk-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carbonblack%2Fcarbon-black-cloud-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carbonblack%2Fcarbon-black-cloud-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carbonblack%2Fcarbon-black-cloud-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carbonblack%2Fcarbon-black-cloud-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carbonblack","download_url":"https://codeload.github.com/carbonblack/carbon-black-cloud-sdk-python/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carbonblack%2Fcarbon-black-cloud-sdk-python/sbom","scorecard":{"id":265502,"data":{"date":"2025-08-11","repo":{"name":"github.com/carbonblack/carbon-black-cloud-sdk-python","commit":"819affec905ead4f6f574bf1d1468104d5fac837"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":5,"reason":"7 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/verify-python.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:117: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:134: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:174: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:214: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:223: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:154: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:195: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/verify-python.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/carbonblack/carbon-black-cloud-sdk-python/verify-python.yml/develop?enable=pin","Warn: containerImage not pinned by hash: docker/docs/Dockerfile:1: pin your Docker image by updating python:3.9-slim-buster to python:3.9-slim-buster@sha256:320a7a4250aba4249f458872adecf92eea88dc6abd2d76dc5c0f01cac9b53990","Warn: pipCommand not pinned by hash: docker/docs/Dockerfile:22-24","Warn: pipCommand not pinned by hash: docker/docs/Dockerfile:22-24","Warn: pipCommand not pinned by hash: docker/docs/Dockerfile:22-24","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:25","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:57","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:121","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:220","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:221","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:41","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:73","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:89","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:105","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:139","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:140","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:141","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:159","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:160","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:181","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:182","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:201","Warn: pipCommand not pinned by hash: .github/workflows/verify-python.yml:202","Info:   0 out of  13 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of  21 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: github.com/carbonblack/.github/SECURITY.md:1","Info: Found linked content: github.com/carbonblack/.github/SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/carbonblack/.github/SECURITY.md:1","Info: Found text in security policy: github.com/carbonblack/.github/SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":0,"reason":"11 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2019-182 / GHSA-8867-vpm3-g98g","Warn: Project is vulnerable to: PYSEC-2012-8 / GHSA-p3h7-3c45-qj4v","Warn: Project is vulnerable to: PYSEC-2019-181 / GHSA-p86x-652p-6385","Warn: Project is vulnerable to: PYSEC-2023-117 / GHSA-mrwq-x4v8-fh7p","Warn: Project is vulnerable to: PYSEC-2021-142 / GHSA-8q59-q68h-6hv4","Warn: Project is vulnerable to: PYSEC-2018-49 / GHSA-rprw-h62v-c2w7","Warn: Project is vulnerable to: PYSEC-2014-14 / GHSA-652x-xj99-gmcc","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2014-13 / GHSA-cfj3-7x9c-4p3h","Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T11:55:10.000Z","repository_id":37855664,"created_at":"2025-08-17T11:55:10.000Z","updated_at":"2025-08-17T11:55:10.000Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28763969,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T00:37:26.264Z","status":"ssl_error","status_checked_at":"2026-01-26T00:37:25.959Z","response_time":113,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T00:00:49.846Z","updated_at":"2026-01-26T01:35:01.623Z","avatar_url":"https://github.com/carbonblack.png","language":"Python","readme":"# Carbon Black Cloud Python SDK\n\n**Latest Version:** 1.5.8\n\u003cbr\u003e\n**Release Date:** June 27, 2025\n\n\n## Recent updates\n\nView the latest release notes [here](https://github.com/carbonblack/carbon-black-cloud-sdk-python/releases).\n\n\n## License\n\nUse of the Carbon Black Cloud Python SDK is governed by the license found in [LICENSE](https://github.com/carbonblack/carbon-black-cloud-sdk-python/blob/develop/LICENSE).\n\n## Support\n\n1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.\n2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.\n3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).\n\n## Documentation\n\nVisit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/) for this project's documentation.\n\n## Requirements\n\nThe Carbon Black Cloud Python SDK is design to work on Python 3.8 and above.\n\nAll requirements are installed as part of `pip install carbon-black-cloud-sdk`. If you're planning on pushing changes to the Carbon Black Cloud Python SDK, the following can be used after cloning the repo `pip install -r requirements.txt`\n\n### Carbon Black Cloud\n\nAt least one Carbon Black Cloud product is required to use this SDK:\n\n* [Platform](https://developer.carbonblack.com/reference/carbon-black-cloud/platform-apis/)\n* [Endpoint Standard](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-defense/)\n* [Audit and Remediation](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-liveops/)\n* [Enterprise EDR](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-threathunter/)\n* [Workload](https://developer.carbonblack.com/reference/carbon-black-cloud/workload-protection/)\n\n### Python Packages\n\n- requests\n- pyyaml\n- python-dateutil\n- schema\n- solrq\n- jsonschema\n- validators\n- keyring (for MacOS)\n\nIf developing the SDK, you also need:\n\n- pytest==5.4.2\n- pymox==1.0.0\n- coverage==5.1\n- flake8==3.8.1\n- flake8-colors==0.1.6\n- flake8-docstrings==1.5.0\n- pre-commit\u003e=2.15.0\n\n\n## Getting Started\n\nVisit the [Getting Started Guide](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started) for an example of authenticating and making an API call using the SDK.\n\n### Setting the User-Agent\n\nThe SDK supports custom User-Agent's when making API calls. This allows you to identify yourself when using the SDK. See [Setting the User-Agent](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started#setting-the-user-agent) section of the documentation for more information.\n\n## Developing Improvements for the Carbon Black Cloud Python SDK\n\nUse the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.\n\n### Installing for SDK development\n\nYou will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, see [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).\n\n```\ngit clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python\ncd carbon-black-cloud-sdk-python\npip install -r requirements.txt\n```\n\n**Note: Before contributing any code please make sure to read the [CONTRIBUTING](CONTRIBUTING.md) page.**\n\nIf you want to test/execute the example scripts from the repo then install the SDK with the following command. This will install the SDK in editable mode so changes to the repo modify the installed package.\n\n```\npip install -e .\n```\n\n**Note: The above command needs to be run from the base folder of the repo**\n\n\n### Running the SDK tests\n\nFrom the parent directory `carbon-black-cloud-sdk-python`, run the command `pytest`.\n\n### Building the documentation\n\n#### Locally\nReadTheDocs hosts [the documentation for the SDK](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/). If you make changes to the SDK that require an update to the documentation, first install the documentation packages from pip:\n\n```\npip install sphinxcontrib-apidoc sphinx_rtd_theme sphinx-copybutton\n```\n\nThen, build the docs locally with the following commands:\n\n```\ncd docs\nmake html\n```\n\nNote that the module rst files such as ```docs/cbc_sdk.platform.rst ``` are handcrafted to control layout.\n* This command will generate new version, but it is not necessary and changes should not be added to the repository.\n* All pull requests will trigger a build of the documentation which can be viewed from Read The Docs --\u003e Builds.\n```\nsphinx-apidoc -f -o docs src/cbc_sdk\n```\n\nThe documentation is built in `docs/_build/html`.\n\n**N.B.:** If your documentation pages appear to generate incorrectly, check to see if you received the warning message\n`No module named 'cbc_sdk'`.  If so, set your `PYTHONPATH` to include the `src/` subdirectory of the SDK project\ndirectory before running `make html`, or the equivalent command `sphinx-build -M html . _build`.\n\n#### Pull-Requests\n\nThe webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull request\n\n#### Using Docker\n\nBuild the documentation by running:\n```shell\n$ docker run -p 7000:7000 -it $(docker build -f ./docker/docs/Dockerfile . -q) make livehtml\n```\n\n### Development Flow\n\nTo begin a code change, start by creating a branch off of the develop branch.\n```\ngit checkout develop\ngit checkout -b {branch-name}\n```\n\nWhen the feature or bug fix is finished you will need to create a pull request to the CarbonBlack repo, the following will push your changes to Github.\n```\ngit push {remote} {branch-name}\n```\n\nIf your branch is behind the develop branch, you will need to rebase.\n```\ngit checkout {branch-name}\ngit rebase develop\n```\n\n**Note:** if your develop branch is out of sync with the Carbon Black repo then you will need to sync your fork. For information on syncing your fork, see [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).\n","funding_links":[],"categories":["Python","Mobile"],"sub_categories":["Cloud"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarbonblack%2Fcarbon-black-cloud-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarbonblack%2Fcarbon-black-cloud-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarbonblack%2Fcarbon-black-cloud-sdk-python/lists"}