Community-supported Python interface to the Sumo Logic REST API. The idea is to make it easier to
hit the API in Python code. Sample scripts available in the scripts
folder. Please submit issues
here via Github. Do not submit customer issues to Sumo Logic support (but REST API issues are of
course supported).
Sumo Logic only accepts connections from clients using TLS version 1.2 or greater. To utilize the content of this repo, ensure that it's running in an execution environment that is configured to use TLS 1.2 or greater.
pip install sumologic-sdk
See scripts/
Copyright 2017 Sumo Logic Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Please see CONTRIBUTING.md for guidelines
This repository and the code within is not supported by Sumo Logic.
Bumps certifi from 2019.3.9 to 2022.12.7.
9e9e840
2022.12.07b81bdb2
2022.09.24939a28f
2022.09.14aca828a
2022.06.15.2de0eae1
Only use importlib.resources's new files() / Traversable API on Python ≥3.11 ...b8eb5e9
2022.06.15.147fb7ab
Fix deprecation warning on Python 3.11 (#199)b0b48e0
fixes #198 -- update link in license9d514b4
2022.06.154151e88
Add py.typed to MANIFEST.in to package in sdist (#196)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase
.
Added support for the Report Jobs that can be done for V2 Dashboards.
Start Report Job Get Report Job Generation Status Get Report Job Generation Result
In addition to these three apis, I also added a get_file() method under post_file(). This downloads the dashboard report to the root directory.
Adding Autoparsing mode option to search job function.
Added a method to get the global parent folder for the authenticated user. This can be used to create a comprehensive list of top-level folders to inventory library content. Inspired by https://stackoverflow.com/questions/65832802/in-sumo-logic-how-do-i-get-a-list-of-folders-off-the-root-folder.
Thank you for considering my contribution to this valuable project!
Example-
| Account_name as User
it renames field with lower case user
The API server implements several asynchronous APIs that require users to submit job, poll for status, and finally fetch results. It would be logical and would help fulfill the purpose of the Python SDK as a high level client to expose helper methods that support handling these asynchronous backend jobs smoothly. The goal would be for a single call to handle necessary functionality:
Support should allow for some specification by user of things like poll period, maximum number of tries/timeout, etc. The higher level methods could then signal situations like timeouts and failures with exceptions or similar.
The outcome would be higher level support in the SDK that smooths out the user experience and enables simpler client code without the need to add in so much polling and retry logic, etc.
Similar ideas have been proposed in #3 and #32.
Content Management APIs and Lookup APIs
Make print statements compatible with Python3
Include PR 22,24,25,27,29,31,34,35.
Merged PR 18,20. Also bypass 0.1.6 to match PyPI
Merged PR 7,15