graylog-api-client 0.2.0__tar.gz → 0.2.1__tar.gz

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graylog-api-client
-Version: 0.2.0
+Version: 0.2.1
 Summary: A Python wrapper for the Graylog REST API
 License-Expression: MIT
 License-File: LICENSE
@@ -19,7 +19,7 @@ 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/).
 As there are a lot of endpoints not all of them are implemented by now. I started by implementing the GET requests first.
 Also the API responses all follow very different schemas and an implementation of that into Python is probably not worth the effort which is why the responses from this API are so low-level.
-Feel free to add endpoints or schemas in PRs if you need them :)
+Due to the amount of Endpoints and the frequent changes, this project does not aim to implement all of them. Instead, only the ones that are needed are added. If some are missing that you need, create an issue or PR. When adding calls to a new Endpoint, follow the schema that is already used (e.g. all authz calls are located in [endpoints.authz.py](/src/graylog_api_client/endpoints/authz.py)).
 #### Last tested Graylog Major Version is: 7
 
 ### Example Usage
@@ -34,11 +34,12 @@ api = GraylogAPI(
     ssl_verify=True                   # /path/to/cert for custom certificate
 )
 
-# Example: Fetch all streams
-streams = api.get_streams()
+# Example: Fetch users
+users = api.users.get_users_paginated({"sort": "username"})
 
 # Print the result
-print("Streams:", streams.data)
+for user in users.data.get("users", []):
+    print(f"Username: {user['username']}, Email: {user['email']}, id: {user['id']}")
 ```
 
 Planned:

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/README.md

@@ -1,7 +1,7 @@
 ### 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/).
 As there are a lot of endpoints not all of them are implemented by now. I started by implementing the GET requests first.
 Also the API responses all follow very different schemas and an implementation of that into Python is probably not worth the effort which is why the responses from this API are so low-level.
-Feel free to add endpoints or schemas in PRs if you need them :)
+Due to the amount of Endpoints and the frequent changes, this project does not aim to implement all of them. Instead, only the ones that are needed are added. If some are missing that you need, create an issue or PR. When adding calls to a new Endpoint, follow the schema that is already used (e.g. all authz calls are located in [endpoints.authz.py](/src/graylog_api_client/endpoints/authz.py)).
 #### Last tested Graylog Major Version is: 7
 
 ### Example Usage
@@ -16,11 +16,12 @@ api = GraylogAPI(
     ssl_verify=True                   # /path/to/cert for custom certificate
 )
 
-# Example: Fetch all streams
-streams = api.get_streams()
+# Example: Fetch users
+users = api.users.get_users_paginated({"sort": "username"})
 
 # Print the result
-print("Streams:", streams.data)
+for user in users.data.get("users", []):
+    print(f"Username: {user['username']}, Email: {user['email']}, id: {user['id']}")
 ```
 
 Planned:

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "graylog-api-client"
-version = "0.2.0"
+version = "0.2.1"
 description = "A Python wrapper for the Graylog REST API"
 authors = [
     {name = "Chrxxxxs",email = "134285960+Chrxxxxs@users.noreply.github.com"}

graylog_api_client-0.2.1/src/graylog_api_client/endpoints/__init__.py

@@ -0,0 +1,13 @@
+from .plugins import Plugins
+from .authz import Endpoint_AUTH
+from .search import Endpoint_SEARCH
+from .users import Endpoint_USER
+from .views import Endpoint_VIEWS
+
+__all__ = [
+    "Plugins",
+    "Endpoint_AUTH",
+    "Endpoint_SEARCH",
+    "Endpoint_USER",
+    "Endpoint_VIEWS"
+]

graylog_api_client-0.2.1/src/graylog_api_client/endpoints/_template.py

@@ -0,0 +1,12 @@
+from ..data_structures import GraylogApiResult
+from ..rest_adapter import RestAdapter
+
+
+class Endpoint_TEMPLATE:
+    # Graylog Endpoint for /template
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+
+
+# New Endpoints should be created using this template. The class name should be changed to the name of the endpoint, and the methods should be added as needed.
+_ = GraylogApiResult  # This is a placeholder to avoid linter errors for unused imports.

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/src/graylog_api_client/endpoints/authz.py

@@ -1,27 +1,33 @@
 from ..data_structures import GraylogApiResult
 from ..rest_adapter import RestAdapter
-from typing import Dict
+
 
 class Endpoint_AUTH:
+    # Graylog Endpoint for /authz
     def __init__(self, rest_adapter: RestAdapter):
         self._rest_adapter = rest_adapter
 
     def get_grants_overview(self) -> GraylogApiResult:
+        """Graylog API Route: GET /authz/grants-overview"""
         overview = self._rest_adapter.get("authz/grants-overview")
         return overview
 
-    def get_roles(self, parameters: Dict = None) -> GraylogApiResult:
+    def get_roles(self, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /authz/roles"""
         roles = self._rest_adapter.get("authz/roles", parameters)
         return roles
 
-    def get_roles_of_user(self, username: str, parameters: Dict = None) -> GraylogApiResult:
+    def get_roles_of_user(self, username: str, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /authz/roles/user/{username}"""
         roles = self._rest_adapter.get(f"authz/roles/user/{username}", parameters)
         return roles
 
     def get_role_by_id(self, role_id: str) -> GraylogApiResult:
+        """Graylog API Route: GET /authz/roles/{role_id}"""
         roles = self._rest_adapter.get(f"authz/roles/{role_id}")
         return roles
 
-    def get_assignees_of_role(self, role_id: str, parameters: Dict = None) -> GraylogApiResult:
+    def get_assignees_of_role(self, role_id: str, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /authz/roles/{role_id}/assignees"""
         assignees = self._rest_adapter.get(f"authz/roles/{role_id}/assignees", parameters)
-        return assignees
+        return assignees

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/src/graylog_api_client/endpoints/plugins/SecurityApp.py

@@ -1,19 +1,21 @@
 from ...data_structures import GraylogApiResult
 from ...rest_adapter import RestAdapter
-from typing import Union, Dict
-from datetime import datetime
+
 
 class SecurityApp:
+    # Graylog Endpoint for /plugins/org.graylog.plugins.securityapp
     def __init__(self, rest_adapter: RestAdapter):
         self._rest_adapter = rest_adapter
         self.Assets = Assets(rest_adapter)
 
+
 class Assets:
+    # Graylog Endpoint for /plugins/org.graylog.plugins.securityapp.asset
     def __init__(self, rest_adapter: RestAdapter):
         self._rest_adapter = rest_adapter
-    
-    def get_assets(self, *, sort: str = "name", page: int = 1, per_page: int = 15, query: str = "",\
-                               filters: str = "", direction: str = "asc") -> GraylogApiResult:
+
+    def get_assets(self, *, sort: str = "name", page: int = 1, per_page: int = 15, query: str = "",
+                   filters: str = "", direction: str = "asc") -> GraylogApiResult:
         parameters = {
             "sort": sort,
             "page": page,
@@ -24,7 +26,7 @@ class Assets:
         }
         result = self._rest_adapter.get("plugins/org.graylog.plugins.securityapp.asset/assets", parameters)
         return result
-    
+
     # The API Browser is very confusing/wrong for creating assets
     def create_user_asset(
         self, *, name: str, usernames: list[str], user_ids: list[str] = [], email_addresses: list[str] = [], first_name: str = "", last_name: str = "", category: list[str] = [], priority: int = 1
@@ -45,10 +47,10 @@ class Assets:
         }
         result = self._rest_adapter.post("plugins/org.graylog.plugins.securityapp.asset/assets", data=data)
         return result
-    
+
     def create_machine_asset(
         self, *, name: str, hostnames: list[str], ip_addresses: list[str] = [], mac_addresses: list[str] = [], category: list[str] = [], custom_fields: dict[str, str] = {},
-        description: str = "", geo_info: dict[str, int|str] = {}, owner: str = "", priority: int = 1
+        description: str = "", geo_info: dict[str, int | str] = {}, owner: str = "", priority: int = 1
     ) -> GraylogApiResult:
         """Create a machine asset."""
         data = {
@@ -68,9 +70,8 @@ class Assets:
         }
         result = self._rest_adapter.post("plugins/org.graylog.plugins.securityapp.asset/assets", data=data)
         return result
-    
+
     def add_categories_to_multiple_assets(self, *, asset_ids: list[str], categories: list[str]) -> GraylogApiResult:
-        # Untested
         data = {
             "asset_ids": asset_ids,
             "categories": categories,
@@ -83,7 +84,7 @@ class Assets:
             f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}"
         )
         return result
-    
+
     def edit_asset_by_id(self, asset_id: str, **updates) -> GraylogApiResult:
         """Edit the asset with the given ID by passing the updates as keyword arguments."""
         current_state = self.get_asset_by_id_detailed(asset_id)
@@ -93,9 +94,9 @@ class Assets:
             f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}", data=payload
         )
         return result
-    
+
     def delete_asset_by_id(self, asset_id: str) -> GraylogApiResult:
         result = self._rest_adapter.delete(
             f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}"
         )
-        return result
+        return result

{graylog_api_client-0.2.0 → graylog_api_client-0.2.1}/src/graylog_api_client/endpoints/plugins/__init__.py

@@ -1,7 +1,8 @@
 from ...rest_adapter import RestAdapter
 from .SecurityApp import SecurityApp
 
+
 class Plugins:
     def __init__(self, rest_adapter: RestAdapter):
         self._rest_adapter = rest_adapter
-        self.SecurityApp = SecurityApp(rest_adapter)
+        self.SecurityApp = SecurityApp(rest_adapter)

graylog_api_client-0.2.1/src/graylog_api_client/endpoints/search.py

@@ -0,0 +1,28 @@
+from ..data_structures import GraylogApiResult
+from ..rest_adapter import RestAdapter
+from typing import Literal
+
+
+class Endpoint_SEARCH:
+    # Graylog Endpoint for /search
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+
+    def post_search_query(self, query: str, start: int, timerange: dict, streams: list[str], stream_categories: list[str] | None = None,
+                          sort: str | None = None, sort_order: Literal["Ascending", "Descending"] | None = None,
+                          fields: list[str] | None = None, size: int = 50) -> GraylogApiResult:
+        """Graylog API Route: POST /search/messages \n
+        start replaces the "from" parameter in the API."""
+        data = {
+            "query": query,
+            "from": str(start),
+            "timerange": timerange,
+            "streams": streams,
+            "stream_categories": stream_categories,
+            "sort": sort,
+            "sort_order": sort_order,
+            "fields": fields,
+            "size": str(size),
+        }
+        result = self._rest_adapter.post("search/messages", data=data)
+        return result

graylog_api_client-0.2.1/src/graylog_api_client/endpoints/users.py

@@ -0,0 +1,68 @@
+from ..data_structures import GraylogApiResult
+from ..rest_adapter import RestAdapter
+from warnings import deprecated
+
+
+class Endpoint_USER:
+    # Graylog Endpoint for /users
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+
+    def create_user(self, username: str, first_name: str, last_name: str, email: str, password: str, permissions: list[str], data: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: POST /users"""
+        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
+
+    @deprecated("This method is marked as deprecated by Graylog and will not work with future Graylog versions. Use the 'get_users_paginated' method instead.")
+    def get_users(self, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /users"""
+        result = self._rest_adapter.get("users", parameters)
+        return result
+
+    def get_users_paginated(self, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /users/paginated"""
+        result = self._rest_adapter.get("users/paginated", parameters)
+        return result
+
+    def get_user_by_id(self, user_id: str) -> GraylogApiResult:
+        """Graylog API Route: GET /users/id/{user_id}"""
+        result = self._rest_adapter.get(f"users/id/{user_id}")
+        return result
+
+    def get_user_by_username(self, username: str) -> GraylogApiResult:
+        """Graylog API Route: GET /users/{username}"""
+        result = self._rest_adapter.get(f"users/{username}")
+        return result
+
+    def get_user_tokens_by_id(self, user_id: str) -> GraylogApiResult:
+        """Graylog API Route: GET /users/{user_id}/tokens"""
+        result = self._rest_adapter.get(f"users/{user_id}/tokens")
+        return result
+
+    def delete_user_by_id(self, user_id: str) -> GraylogApiResult:
+        """Graylog API Route: DELETE /users/id/{user_id}"""
+        result = self._rest_adapter.delete(f"users/id/{user_id}")
+        return result
+
+    def delete_user_by_username(self, username: str) -> GraylogApiResult:
+        """Graylog API Route: DELETE /users/{username}"""
+        result = self._rest_adapter.delete(f"users/{username}")
+        return result
+
+    def change_user_status(self, user_id: str, status: str) -> GraylogApiResult:
+        """Graylog API Route: PUT /users/{user_id}/status/{status}"""
+        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

graylog_api_client-0.2.1/src/graylog_api_client/endpoints/views.py

@@ -0,0 +1,18 @@
+from ..data_structures import GraylogApiResult
+from ..rest_adapter import RestAdapter
+
+
+class Endpoint_VIEWS:
+    # Graylog Endpoint for /views
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+
+    def get_views(self, parameters: dict | None = None) -> GraylogApiResult:
+        """Graylog API Route: GET /views"""
+        result = self._rest_adapter.get("views", parameters)
+        return result
+
+    def get_view_by_id(self, view_id: str) -> GraylogApiResult:
+        """Graylog API Route: GET /views/{view_id}"""
+        result = self._rest_adapter.get(f"views/{view_id}")
+        return result

graylog_api_client-0.2.1/src/graylog_api_client/graylog_api_client.py

@@ -0,0 +1,123 @@
+import logging
+from typing import Literal
+from warnings import deprecated
+
+from .rest_adapter import RestAdapter
+from .data_structures import GraylogApiResult
+from .endpoints import Plugins, Endpoint_AUTH, Endpoint_SEARCH, Endpoint_USER, Endpoint_VIEWS
+
+
+class GraylogAPI:
+    def __init__(self, host: str, api_key: str, ssl_verify: str | bool = True, logger: logging.Logger | None = None):
+        """GraylogAPI client
+
+        :param host: The hostname of the Graylog API endpoint plus the protocol. Example: https://graylog.com/api
+        :param api_key: An API Key to authenticate with Graylog
+        :param ssl_verify: Enables or Disables TLS Certificate verification. For a custom certificate, this value must a path pointing to the certificate, defaults to True
+        :param logger: The logger being used by the Adapter, will use a new one if none is given, defaults to None
+        """
+        self._rest_adapter = RestAdapter(host=host, api_key=api_key, ssl_verify=ssl_verify, logger=logger)
+        self.plugins = Plugins(rest_adapter=self._rest_adapter)
+        self.authz = Endpoint_AUTH(rest_adapter=self._rest_adapter)
+        self.users = Endpoint_USER(rest_adapter=self._rest_adapter)
+        self.views = Endpoint_VIEWS(rest_adapter=self._rest_adapter)
+        self.search = Endpoint_SEARCH(rest_adapter=self._rest_adapter)
+
+    # The endpoints grouped like they are in the api-browser
+    # /authz Authorization
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'authz' attribute instead.")
+    def get_auth_grants_overview(self) -> GraylogApiResult:
+        overview = self.authz.get_grants_overview()
+        return overview
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'authz' attribute instead.")
+    def get_auth_roles(self, parameters: dict | None = None) -> GraylogApiResult:
+        roles = self.authz.get_roles(parameters)
+        return roles
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'authz' attribute instead.")
+    def get_auth_roles_of_user(self, username: str, parameters: dict | None = None) -> GraylogApiResult:
+        roles = self.authz.get_roles_of_user(username, parameters)
+        return roles
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'authz' attribute instead.")
+    def get_auth_role_by_id(self, role_id: str) -> GraylogApiResult:
+        roles = self.authz.get_role_by_id(role_id)
+        return roles
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'authz' attribute instead.")
+    def get_auth_assignees_of_role(self, role_id: str, parameters: dict | None = None) -> GraylogApiResult:
+        assignees = self.authz.get_assignees_of_role(role_id, parameters)
+        return assignees
+
+    # /search Search Options (Decorators, Export, Functions etc.)
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'search' attribute instead.")
+    def post_search_query(self, query: str, start: int, timerange: dict, streams: list[str], stream_categories: list[str] | None = None,
+                          sort: str | None = None, sort_order: Literal["Ascending", "Descending"] | None = None,
+                          fields: list[str] | None = None, size: int = 50) -> GraylogApiResult:
+        """start replaces the "from" parameter in the API"""
+        result = self.search.post_search_query(query, start, timerange, streams, stream_categories, sort, sort_order, fields, size)
+        return result
+
+    # /streams
+    @deprecated("This method is deprecated by Graylog and will not work with future Graylog versions")
+    def get_streams(self) -> GraylogApiResult:
+        result = self._rest_adapter.get("streams")
+        return result
+
+    # /users
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def create_user(self, username: str, first_name: str, last_name: str, email: str, password: str, permissions: list[str], data: dict | None = None) -> GraylogApiResult:
+        result = self.users.create_user(username, first_name, last_name, email, password, permissions, data)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def get_users(self, parameters: dict | None = None) -> GraylogApiResult:
+        result = self.users.get_users(parameters)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def get_users_paginated(self, parameters: dict | None = None) -> GraylogApiResult:
+        result = self.users.get_users_paginated(parameters)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def get_user_by_id(self, user_id: str) -> GraylogApiResult:
+        result = self.users.get_user_by_id(user_id)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def get_user_by_username(self, username: str) -> GraylogApiResult:
+        result = self.users.get_user_by_username(username)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def get_user_tokens_by_id(self, user_id: str) -> GraylogApiResult:
+        result = self.users.get_user_tokens_by_id(user_id)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def delete_user_by_id(self, user_id: str) -> GraylogApiResult:
+        result = self.users.delete_user_by_id(user_id)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def delete_user_by_username(self, username: str) -> GraylogApiResult:
+        result = self.users.delete_user_by_username(username)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'users' attribute instead.")
+    def change_user_status(self, user_id: str, status: str) -> GraylogApiResult:
+        result = self.users.change_user_status(user_id, status)
+        return result
+
+    # /views Main Views Endpoints
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'views' attribute instead.")
+    def get_views(self, parameters: dict | None = None) -> GraylogApiResult:
+        result = self.views.get_views(parameters)
+        return result
+
+    @deprecated("This method is deprecated and will be removed in a future version. Use the 'views' attribute instead.")
+    def get_view_by_id(self, view_id: str) -> GraylogApiResult:
+        result = self.views.get_view_by_id(view_id)
+        return result

graylog_api_client-0.2.0/src/graylog_api_client/graylog_api_client.py

@@ -1,180 +0,0 @@
-import logging
-from datetime import datetime
-from typing import List, Literal, Union, Dict
-
-from .rest_adapter import RestAdapter
-from .data_structures import GraylogApiResult
-from .endpoints.authz import Endpoint_AUTH
-from .endpoints.plugins import Plugins
-
-
-class GraylogAPI:
-    def __init__(self, host: str, api_key: str, ssl_verify: Union[str, bool] = True, logger: logging.Logger = None):
-        """GraylogAPI client
-
-        :param host: The hostname of the Graylog API endpoint plus the protocol. Example: https://graylog.com/api
-        :param api_key: An API Key to authenticate with Graylog
-        :param ssl_verify: Enables or Disables TLS Certificate verification. For a custom certificate, this value must a path pointing to the certificate, defaults to True
-        :param logger: The logger being used by the Adapter, will use a new one if none is given, defaults to None
-        """
-        self._rest_adapter = RestAdapter(host=host, api_key=api_key, ssl_verify=ssl_verify, logger=logger)
-        self.authz = Endpoint_AUTH(rest_adapter=self._rest_adapter)
-        self.plugins = Plugins(rest_adapter=self._rest_adapter)
-
-    # The endpoints grouped like they are in the api-browser
-    # /authz Authorization
-    def get_auth_grants_overview(self) -> GraylogApiResult:
-        overview = self.authz.get_grants_overview()
-        return overview
-
-    def get_auth_roles(self, parameters: Dict = None) -> GraylogApiResult:
-        roles = self.authz.get_roles(parameters)
-        return roles
-
-    def get_auth_roles_of_user(self, username: str, parameters: Dict = None) -> GraylogApiResult:
-        roles = self.authz.get_roles_of_user(username, parameters)
-        return roles
-
-    def get_auth_role_by_id(self, role_id: str) -> GraylogApiResult:
-        roles = self.authz.get_role_by_id(role_id)
-        return roles
-
-    def get_auth_assignees_of_role(self, role_id: str, parameters: Dict = None) -> GraylogApiResult:
-        assignees = self.authz.get_assignees_of_role(role_id, parameters)
-        return assignees
-
-    # /ca
-    def get_ca(self) -> GraylogApiResult:
-        result = self._rest_adapter.get("ca")
-        return result
-
-    # /certificates
-    def get_certificates(self) -> GraylogApiResult:
-        result = self._rest_adapter.get("certificates")
-        return result
-
-    # /cluster
-    def get_cluster(self) -> GraylogApiResult:
-        result = self._rest_adapter.get("cluster")
-        return result
-
-    def get_processbufferdump(self, node_id: str = "") -> GraylogApiResult:
-        result = self._rest_adapter.get(f"cluster/{node_id}/processbufferdump".replace("//", "/"))
-        return result
-
-    def get_jvminfo(self, node_id: str) -> GraylogApiResult:
-        result = self._rest_adapter.get(f"cluster/{node_id}/jvm")
-        return result
-
-    # /contentstream
-    # /dashboards
-    # /datanodes
-    # /datanode
-    # /api-docs API-Documentation
-    # /enterprise
-    # /entitylists
-    # /entity_scopes
-    # /entity_suggestions
-    # /events
-    # /system/inputs/{inputId}/extractors Extractors
-    # /favorites
-    # /views/fields FieldTypes
-    # /system/indexer Indexer
-    # /search/universal/absolute Legacy Message Search
-    # /messages
-    # /migration
-    # /system/pipelines Pipelines
-    # /plugins
-    # /remote-reindex-migration
-    # /roles
-    # /views/search Search
-    # /search Search Options (Decorators, Export, Functions etc.)
-    def post_search_query(self, query: str, start: int, timerange: dict, streams: list[str], stream_categories: list[str] = None,\
-                          sort: str = None, sort_order: Literal["Ascending", "Descending"] = None,\
-                          fields: list[str] = None, size: int = 50) -> GraylogApiResult:
-        """start replaces the "from" parameter in the API"""
-        data = {
-            "query": query,
-            "from": str(start),
-            "timerange": timerange,
-            "streams": streams,
-            "stream_categories": stream_categories,
-            "sort": sort,
-            "sort_order": sort_order,
-            "fields": fields,
-            "size": str(size),
-        }
-        result = self._rest_adapter.post("search/messages", data=data)
-        return result
-    
-    # /views/searchjobs Searchjobs
-    # /sidecars
-    # /sidecar
-    # /startpage
-    # /system/inputs/{inputId}/staticfields Staticfields
-    # /streams
-    def get_streams(self) -> GraylogApiResult:
-        result = self._rest_adapter.get("streams")
-        return result
-
-    # /system Main System endpoints
-    # /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
-
-    def get_users_paginated(self, parameters: Dict = None) -> GraylogApiResult:
-        result = self._rest_adapter.get("users/paginated", parameters)
-        return result
-
-    def get_user_by_id(self, user_id: str) -> GraylogApiResult:
-        result = self._rest_adapter.get(f"users/id/{user_id}")
-        return result
-
-    def get_user_by_username(self, username: str) -> GraylogApiResult:
-        result = self._rest_adapter.get(f"users/{username}")
-        return result
-
-    def get_user_tokens_by_id(self, user_id: str) -> GraylogApiResult:
-        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)
-        return result
-
-    def get_view_by_id(self, view_id: str) -> GraylogApiResult:
-        result = self._rest_adapter.get(f"views/{view_id}")
-        return result