graylog-api-client 0.1.2

A Python wrapper for the Graylog REST API

This is a low level Graylog API Wrapper heavily based on the guide by pretzel.

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 :)

Last tested Graylog Version is: 6.3.4

Example Usage

from graylog_api_client import GraylogAPI

# Initialize the GraylogAPI client
api = GraylogAPI(
    host="https://localhost:9000/api",  # Replace with your Graylog server URL
    api_key="your_api_key_here",       # Replace with your API key
    ssl_verify=True                   # /path/to/cert for custom certificate
)

# Example: Fetch all streams
streams = api.get_streams()

# Print the result
print("Streams:", streams.data)

Planned:

1. Tests that run against a Graylog instance to check if the Wrapper works after Graylog Updates

Test Environment:

1. Install docker and docker-compose
2. Copy the sample docker-compose file by Graylog 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