veltro-sdk
Python client for VectorFlow and Sigmatic, with frozen Warden API bindings. It uses the standard library only and is Apache-2.0.
pip install veltro-sdk
Sigmatic
Create a personal access token in your Sigmatic stack's identity settings. Pass it to the product gateway prefix:
from veltro_sdk import BearerToken, SigmaticClient
sigmatic = SigmaticClient("https://sigmatic.example.com/sigmatic", auth=BearerToken(pat))
sources = sigmatic.data_sources.list()
For an identity session, use the canonical namespace:
from veltro_sdk import VeltroClient
suite = VeltroClient.login("https://sigmatic.example.com", email, password)
sources = suite.sigmatic.data_sources.list()
The former detection client name, namespace and gateway prefix have been removed without aliases. Each product stack has its own identity; credentials do not cross stack boundaries.
VectorFlow
REST v1 requires an environment-scoped service-account key, not an identity PAT or browser session:
from veltro_sdk import BearerToken, VectorFlowClient
vectorflow = VectorFlowClient(
"https://vectorflow.example.com/vectorflow",
auth=BearerToken("vf_live_…"),
)
pipelines = vectorflow.pipelines.list()
VeltroClient also exposes vectorflow when given vectorflow_key or
vectorflow_auth. Missing credentials fail locally with MissingCredential.
The warden namespace and WardenClient retain the frozen Warden contract;
Warden has no supported new install path.
Calling convention
Every operation is a method on a resource namespace. Path parameters are positional and percent-encoded; everything else is a keyword option passed to the transport:
client.data_sources.get("ds-123") # path parameter
client.alerts.list(params={"status": "open", "limit": 50})
client.rules.create(json={"title": "…", "sigma_yaml": "…"})
client.export.download(raw=True) # bytes, not JSON
| Option | Meaning |
|---|---|
params |
query parameters (None values dropped, lists repeat the key) |
json |
JSON request body |
data |
raw request body |
headers |
extra headers, applied after the credential |
timeout |
per-request timeout override (seconds) |
raw |
return bytes instead of parsed JSON |
Responses are the products' JSON, decoded — the SDK does not reshape them. The
field-level reference is each product's OpenAPI document (/openapi.json on
Sigmatic and Warden, /api/v1/openapi.json on VectorFlow).
Errors
| Exception | Raised when |
|---|---|
VeltroAPIError |
any non-2xx; carries .status, .code (the product's own refusal name), .message, .body |
VeltroTransportError |
the request never produced a response (DNS, TLS, connect, timeout) |
VeltroResponseTooLarge |
the response exceeded max_response_bytes (32 MiB default), enforced while streaming |
MissingCredential |
a product namespace was used without a credential it accepts |
429, 502, 503 and 504 are retried twice with exponential backoff,
honouring Retry-After. Nothing else is retried: a 409 or 422 is the
product's answer, not a transient fault.
Credentials are never logged: every credential object masks its material in
repr, and the transport keeps request headers out of exception messages.
An identity session is scoped to the origin that minted it. Pointing a product
client at a different origin while passing auth=session sends no cookie
there rather than the identity session — the cookie runs through
http.cookiejar, so Domain, Path and Secure are all honoured.
Coverage
| Product | Resources | Operations | Generated from |
|---|---|---|---|
| Sigmatic | See sdk/specs/sigmatic-operations.json |
Generated product operations | Product OpenAPI |
| Warden | Frozen API bindings | Generated product operations | Product OpenAPI |
| VectorFlow | See sdk/specs/vectorflow-operations.json |
Generated REST v1 operations | Product OpenAPI |
Machine planes are deliberately not bound — product-peer and external
writeback seams (workload-exchange authorised), SCIM, ingest, agent enrollment,
inbound webhook receivers, the unauthenticated case portal, and VectorFlow's
tRPC transport. Each exclusion and its reason is recorded in
sdk/specs/<product>-operations.json.
client.resource_names lists the namespaces a client exposes.
1 maintainer
Metadata
1 maintainer
Release files for veltro-sdk 0.39.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| veltro_sdk-0.39.3.tar.gz | 41.1 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| veltro_sdk-0.39.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 77.6 kB
Release files / veltro_sdk-0.39.3.tar.gz
| Download URL | veltro_sdk-0.39.3.tar.gz |
|---|---|
| Size | 41.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e8f18db0c423279913688eccba2daca776693c4e63891dcd38fc1aa91fcff5ff
|
|
BLAKE2b-256 checksum How to use checksums |
2cce8f6f47df7e375465504cab80e8f1d8899f5e818ccc8b11c3737f1a18f61b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / veltro_sdk-0.39.3-py3-none-any.whl
| Download URL | veltro_sdk-0.39.3-py3-none-any.whl |
|---|---|
| Size | 36.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eefaf0611ca1566455a6fda1369f2f9f1bd220b052bb22e327a8e858cfdd58b3
|
|
BLAKE2b-256 checksum How to use checksums |
01d9f19c0d4f8b663b3a436765b4f617adf793a06cd8b1bc1c1a38cf0ff9b5ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for veltro-sdk 0.39.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for veltro_sdk-0.39.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
