Splunk SOAR SDK - the official tool for Splunk SOAR app development
Documentation
Detailed documentation can be found here
Installation
The Splunk SOAR SDK is available as a package on PyPI.
The recommended installation method is via uv.
Find us at .conf25
To learn more about the SDK, check out our (presentation slides)[https://conf.splunk.com/files/2025/slides/DEV1495.pdf] from .conf25!
Installing the SDK as a tool
This package defines the soarapps command line interface. To use it, install as a uv tool:
uv tool install splunk-soar-sdk
soarapps --help
Quick Start
Create a new, empty app: Run soarapps init.
Migrate an existing app to the SDK: Run soarapps convert myapp, where myapp is your app written using BaseConnector. This will convert asset configuration, action declarations, and inputs and outputs. You'll still need to re-implement your action code, as well as any custom views and webhooks.
Getting Help
If you need help, please file a GitHub issue at https://github.com/phantomcyber/splunk-soar-sdk/issues.
Installing the SDK as an app dependency
When developing a new Splunk SOAR app using the SDK, you should use uv as your project management tool:
uv add splunk-soar-sdk
Running the above command will add splunk-soar-sdk as a dependency of your Splunk SOAR app, in your pyproject.toml file.
Usage
In order to start using SDK and build your first Splunk SOAR App, follow the Getting Started guide.
A Splunk SOAR app developed with the SDK will look something like this:
Project structure:
string_reverser/
├─ src/
│ ├─ __init__.py
│ ├─ app.py
├─ tests/
│ ├─ __init__.py
│ ├─ test_app.py
├─ .pre-commit-config.yaml
├─ logo.svg
├─ logo_dark.svg
├─ pyproject.toml
With app.py containing:
from soar_sdk.abstract import SOARClient
from soar_sdk.app import App
from soar_sdk.asset import AssetField, BaseAsset
from soar_sdk.params import Params
from soar_sdk.action_results import ActionOutput
class Asset(BaseAsset):
base_url: str
api_key: str = AssetField(sensitive=True, description="API key for authentication")
app = App(name="test_app", asset_cls=Asset, appid="1e1618e7-2f70-4fc0-916a-f96facc2d2e4", app_type="sandbox", logo="logo.svg", logo_dark="logo_dark.svg", product_vendor="Splunk", product_name="Example App", publisher="Splunk")
@app.test_connectivity()
def test_connectivity(soar: SOARClient, asset: Asset) -> None:
soar.debug(f"testing connectivity against {asset.base_url}")
class ReverseStringParams(Params):
input_string: str
class ReverseStringOutput(ActionOutput):
reversed_string: str
@app.action(action_type="test", verbose="Reverses a string.")
def reverse_string(
param: ReverseStringParams, soar: SOARClient
) -> ReverseStringOutput:
reversed_string = param.input_string[::-1]
return ReverseStringOutput(reversed_string=reversed_string)
if __name__ == "__main__":
app.cli()
Requirements
- uv
- Python >=3.9
- Python may be installed locally with uv
- Splunk SOAR >=6.4.0
- You can get Splunk SOAR Community Edition from the Splunk website
Copyright 2025 Splunk 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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file splunk_soar_sdk-3.26.0.tar.gz.
File metadata
- Download URL: splunk_soar_sdk-3.26.0.tar.gz
- Upload date:
- Size: 740.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e56cc26833e257f50286abab2a7bc09bfc649c90d352e30e6a42efc0d72170e
|
|
| MD5 |
0ac9e63dd0f14bb3e853cb0be73d0c56
|
|
| BLAKE2b-256 |
a1ee43fae5fcf99a210df240e1543bb41d9afd1d32b98a82d8248b4329a9b7f9
|
File details
Details for the file splunk_soar_sdk-3.26.0-py3-none-any.whl.
File metadata
- Download URL: splunk_soar_sdk-3.26.0-py3-none-any.whl
- Upload date:
- Size: 216.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0c1ce03b430fd6a45530cf15308a96dd71b3a0cd1fe43d1ca82758253be37e13
|
|
| MD5 |
aac3b7600209c39d0ab087fcf1b96d53
|
|
| BLAKE2b-256 |
b4178c5090b046cf5aba055a55728ebebfc479d16e363c6e39ac20e7dd97c41e
|
