Skip to main content

CLI for API sandboxes. Test your APIs in a sandbox env.

Project description

sdb

sdb is the CLI for the API sandbox platform from DigitalApi.ai.

It is built for three core jobs:

  • import and diff OpenAPI specs
  • create sandbox releases and promote aliases
  • drive auth, simulation, traces, and generated runtime bundles from one CLI

The public package name is api-sandbox.
The installed binary name is always sdb.

Install

Recommended:

pipx install api-sandbox

Upgrade:

pipx upgrade api-sandbox

If you prefer a virtualenv:

python -m pip install api-sandbox

Quickstart

Local bootstrap:

sdb config bootstrap local
sdb doctor --json

Managed-beta Cloud Run bootstrap:

sdb config bootstrap cloud-run \
  --project api-sandbox-20260416-1715 \
  --base-url https://api.sandbox.digitalapi.ai \
  --profile-name prod \
  --activate

Common flows:

sdb spec import ./openapi.yaml
sdb sandbox create bank-sim --api "Payments API" --mode simulation
sdb sandbox list --name bank-sim
sdb sandbox request bank-sim GET /payments --alias latest
sdb trace tail bank-sim --limit 10

What Works Today

  • spec import, validate, diff, list, get
  • sandbox create, list, get, clone, archive, reset, export-manifest
  • release create, list, get, promote
  • auth profiles, apps, client credentials, discovery, scopes, login
  • simulation packs, scenarios, snapshots, timers, webhooks, bundles, deploys
  • traces: list, get, replay, tail
  • runtime requests through sdb sandbox request
  • local profiles and private Cloud Run operator profiles
  • --dry-run, --yes, --watch, and redacted --trace

Docs

Start here:

Release

Public release path:

  • build wheel + sdist
  • verify artifacts in CI
  • publish to PyPI from a signed GitHub Actions tag workflow

Release checklist:

Repository

This repository also contains the control plane, runtime, runbooks, execution plans, and product contracts that back the CLI.

For repository contributors:

python -m pip install -e ".[dev]"
make check
pytest -q

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

api_sandbox-0.1.0.tar.gz (78.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

api_sandbox-0.1.0-py3-none-any.whl (106.6 kB view details)

Uploaded Python 3

File details

Details for the file api_sandbox-0.1.0.tar.gz.

File metadata

  • Download URL: api_sandbox-0.1.0.tar.gz
  • Upload date:
  • Size: 78.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for api_sandbox-0.1.0.tar.gz
Algorithm Hash digest
SHA256 61fb730c74ef5e498f2e4abd5235ba6a7501bcb3b29563fd190fd8444073aaad
MD5 5e9517c4acbfcee8d92ec4593be3abc8
BLAKE2b-256 a427dcb881a1ab19a537c0dbe361c8a222cf9e4075a7c136d4a5f1b70d0238c3

See more details on using hashes here.

File details

Details for the file api_sandbox-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: api_sandbox-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 106.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for api_sandbox-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36d857e0520959d3a7d81ef1d1dd23e0b7c927273a3b88ce99df2de79b4d7f86
MD5 c2eb56bb01ee5f3f2601a5beb5e5f671
BLAKE2b-256 765fc3e8a085cfc4efec6c2e53f8e85169b13d4db235cd285144c1d50a61587b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page