{"library":"splunk-sdk","title":"Splunk SDK for Python","type":"library","description":"The Splunk Software Development Kit for Python allows developers to programmatically interact with the Splunk platform's REST API. It provides a Pythonic interface for searching data, managing configurations, working with indexes and inputs, and building custom applications. The library is actively maintained with frequent minor releases and bug fixes.","language":"python","status":"active","last_verified":"Fri May 22","install":{"commands":["pip install splunk-sdk"],"cli":null},"imports":["import splunklib.client as client"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":"https://pypi.org/project/splunk-sdk","github":"https://github.com/splunk/splunk-sdk-python","docs":"https://docs.splunk.com/Documentation/PythonSDK","changelog":"https://github.com/splunk/splunk-sdk-python/releases","pypi":"https://pypi.org/project/splunk-sdk/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"import os\nimport splunklib.client as client\n\n# Configure connection details using environment variables or replace directly\nHOST = os.environ.get('SPLUNK_HOST', 'localhost')\nPORT = int(os.environ.get('SPLUNK_PORT', 8089))\nUSERNAME = os.environ.get('SPLUNK_USERNAME', 'admin')\nPASSWORD = os.environ.get('SPLUNK_PASSWORD', 'your_password') # Use a strong password or token in production\n\ntry:\n    # Connect to Splunk\n    service = client.connect(\n        host=HOST,\n        port=PORT,\n        username=USERNAME,\n        password=PASSWORD,\n        autologin=True,\n        # Set verify=False for self-signed certificates in development, but not recommended for production\n        # verify=False # Example: os.environ.get('SPLUNK_SSL_VERIFY', 'true').lower() == 'true'\n    )\n\n    # Print connected user and Splunk version\n    print(f\"Connected as: {service.username}\")\n    print(f\"Splunk version: {service.info['version']}\")\n\n    # List available apps\n    print(\"\\nAvailable apps:\")\n    for app in service.apps:\n        print(f\"- {app.name}\")\n\nexcept Exception as e:\n    print(f\"Error connecting to Splunk: {e}\")\n    print(\"Please ensure Splunk is running and connection details (host, port, username, password) are correct.\")\n    print(\"For self-signed certificates, you might need to set verify=False (not recommended for production).\")\n","lang":"python","description":"This quickstart demonstrates how to connect to a Splunk Enterprise instance using username and password authentication, and then lists the installed applications. It uses environment variables for credentials, which is a common practice for security.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-22","installed_version":"2.1.1","pypi_latest":"3.0.0","is_stale":true,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":2.4,"avg_import_s":0.15,"wheel_type":"sdist"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.14,"mem_mb":5.7,"disk_size":"20.9M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":2.2,"import_time_s":0.09,"mem_mb":5.7,"disk_size":"21M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.18,"mem_mb":6,"disk_size":"23.6M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":2.3,"import_time_s":0.15,"mem_mb":6,"disk_size":"24M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.15,"mem_mb":6,"disk_size":"13.5M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":3.2,"import_time_s":0.15,"mem_mb":6,"disk_size":"14M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"splunk-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.2,"mem_mb":7,"disk_size":"12.7M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"splunk-sdk","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":1.6,"import_time_s":0.21,"mem_mb":7.1,"disk_size":"13M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.12,"mem_mb":5.6,"disk_size":"20.5M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"splunk-sdk","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":2.5,"import_time_s":0.1,"mem_mb":5.6,"disk_size":"21M"}]}}