graylog-api-client 0.1.0__tar.gz → 0.1.1__tar.gz

graylog_api_client-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Chrxxxxs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{graylog_api_client-0.1.0 → graylog_api_client-0.1.1}/PKG-INFO

@@ -1,7 +1,10 @@
 Metadata-Version: 2.4
 Name: graylog-api-client
-Version: 0.1.0
-Summary: 
+Version: 0.1.1
+Summary: A Python wrapper for the Graylog REST API
+License-Expression: MIT
+License-File: LICENSE
+Keywords: graylog,REST,API Wrapper
 Author: Chrxxxxs
 Author-email: 134285960+Chrxxxxs@users.noreply.github.com
 Requires-Python: >=3.13
@@ -9,6 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: requests (>=2.32.5,<3.0.0)
+Project-URL: Repository, https://github.com/Chrxxxxs/graylog_api_client
 Description-Content-Type: text/markdown
 
 ### This is a low level Graylog API Wrapper heavily based on the guide by [pretzel](https://www.pretzellogix.net/2021/12/08/how-to-write-a-python3-sdk-library-module-for-a-json-rest-api/).
@@ -23,6 +27,6 @@ Planned:
 
 ### Test Environment:
 1. Install docker and docker-compose
-2. Copy the sample docker-compose file by [Graylog](https://github.com/Graylog2/docker-compose) for the open-core and create a .env file with the needed values
+2. Copy the sample docker-compose file by [Graylog](https://github.com/Graylog2/docker-compose) for the open-core (or enterprise if you want to see all API endpoints) and create a .env file with the needed values
 3. docker-compose up
 4. Log in and create an api-key

{graylog_api_client-0.1.0 → graylog_api_client-0.1.1}/README.md

@@ -10,6 +10,6 @@ Planned:
 
 ### Test Environment:
 1. Install docker and docker-compose
-2. Copy the sample docker-compose file by [Graylog](https://github.com/Graylog2/docker-compose) for the open-core and create a .env file with the needed values
+2. Copy the sample docker-compose file by [Graylog](https://github.com/Graylog2/docker-compose) for the open-core (or enterprise if you want to see all API endpoints) and create a .env file with the needed values
 3. docker-compose up
 4. Log in and create an api-key

{graylog_api_client-0.1.0 → graylog_api_client-0.1.1}/pyproject.toml

@@ -1,16 +1,21 @@
 [project]
 name = "graylog-api-client"
-version = "0.1.0"
-description = ""
+version = "0.1.1"
+description = "A Python wrapper for the Graylog REST API"
 authors = [
     {name = "Chrxxxxs",email = "134285960+Chrxxxxs@users.noreply.github.com"}
 ]
+keywords = ["graylog", "REST", "API Wrapper"]
+license = "MIT"
 readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "requests (>=2.32.5,<3.0.0)",
 ]
 
+[project.urls]
+Repository = "https://github.com/Chrxxxxs/graylog_api_client"
+
 [tool.poetry]
 packages = [{include = "graylog_api_client", from = "src"}]
 

{graylog_api_client-0.1.0 → graylog_api_client-0.1.1}/src/graylog_api_client/graylog_api_client.py

@@ -1,12 +1,14 @@
 import logging
-from typing import Union, Dict
-from src.graylog_api_client.rest_adapter import RestAdapter
-from src.graylog_api_client.data_structures import GraylogApiResult
+from typing import List, Union, Dict
+
+from .rest_adapter import RestAdapter
+from .data_structures import GraylogApiResult
 
 
 class GraylogAPI:
     def __init__(self, host: str, api_key: str, ssl_verify: Union[str, bool] = True, logger: logging.Logger = None):
         self._rest_adapter = RestAdapter(host=host, api_key=api_key, ssl_verify=ssl_verify, logger=logger)
+
     # The endpoints grouped like they are in the api-browser
     # /authz Authorization
     def get_auth_grants_overview(self) -> GraylogApiResult:
@@ -89,6 +91,21 @@ class GraylogAPI:
     # /telemetry
     # /token_usage
     # /users
+    def create_user(self, username: str, first_name: str, last_name: str, email: str, password: str, permissions: List[str], data: Dict = None) -> GraylogApiResult:
+        user_data = {
+            "username": username,
+            "first_name": first_name,
+            "last_name": last_name,
+            "email": email,
+            "password": password,
+        }
+        if permissions:
+            user_data["permissions"] = permissions
+        if data:
+            user_data.update(data)
+        result = self._rest_adapter.post("users", data=user_data)
+        return result
+
     def get_users(self, parameters: Dict = None) -> GraylogApiResult:
         result = self._rest_adapter.get("users", parameters)
         return result
@@ -109,6 +126,20 @@ class GraylogAPI:
         result = self._rest_adapter.get(f"users/{user_id}/tokens")
         return result
 
+    def delete_user_by_id(self, user_id: str) -> GraylogApiResult:
+        result = self._rest_adapter.delete(f"users/id/{user_id}")
+        return result
+
+    def delete_user_by_username(self, username: str) -> GraylogApiResult:
+        result = self._rest_adapter.delete(f"users/{username}")
+        return result
+
+    def change_user_status(self, user_id: str, status: str) -> GraylogApiResult:
+        if status not in ["enabled", "disabled", "deleted"]:
+            raise ValueError(f"Status must be either 'enabled', 'disabled' or 'deleted' but was: {status}")
+        result = self._rest_adapter.put(f"users/{user_id}/status/{status}")
+        return result
+
     # /views Main Views Endpoints
     def get_views(self, parameters: Dict = None) -> GraylogApiResult:
         result = self._rest_adapter.get("views", parameters)

{graylog_api_client-0.1.0 → graylog_api_client-0.1.1}/src/graylog_api_client/rest_adapter.py

@@ -1,10 +1,9 @@
-import os
 import requests
 import logging
 from typing import Dict, Union
 
-from src.graylog_api_client.exceptions import GraylogApiException
-from src.graylog_api_client.data_structures import GraylogApiResult
+from .exceptions import GraylogApiException
+from .data_structures import GraylogApiResult
 
 
 class RestAdapter:
@@ -21,7 +20,7 @@ class RestAdapter:
         self._api_key = api_key
         self._ssl_verify = ssl_verify
         self._session = requests.Session()
-        self._session.headers.update({"Accept": "application/json"})
+        self._session.headers.update({"Accept": "application/json", "X-Requested-By": "python-graylog-api-client"})
         self._session.auth = (self._api_key, "token")  # Graylog uses the format Basic Auth: "<API-token>:token"
         if not ssl_verify:
             requests.packages.urllib3.disable_warnings()
@@ -46,7 +45,10 @@ class RestAdapter:
             self._logger.error(msg=str(e))
             raise GraylogApiException("Invalid API Response") from e
         try:
-            data = response.json()
+            if response.content != b'':
+                data_out = response.json()
+            else:
+                data_out = None
         except (ValueError, requests.exceptions.JSONDecodeError) as e:
             self._logger.error(msg=log_line_post.format(False, None, e))
             raise GraylogApiException("Bad JSON in response") from e
@@ -54,7 +56,7 @@ class RestAdapter:
         log_line = log_line_post.format(is_success, response.status_code, response.reason)
         if is_success:
             self._logger.debug(msg=log_line)
-            return GraylogApiResult(status_code=response.status_code, message=response.reason, data=data)
+            return GraylogApiResult(status_code=response.status_code, message=response.reason, data=data_out)
         self._logger.error(msg=log_line)
         raise GraylogApiException(f"{response.status_code}: {response.reason}")