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.1.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.1-py3-none-any.whl (106.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: api_sandbox-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 faf922fda277a62258b81c63eb6f57762a457eb71974b6d7133118c1de955871
MD5 bb7593a77cab8159e36142767a00123d
BLAKE2b-256 f042187344662536fb6406f222b786637dd634177655b4f054666358663b50e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: api_sandbox-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2f96bb44272879bc668048d9ad67f7ff4d9821ec2ab2d9285ff58f19b521297b
MD5 1260bec69ae8ab2bdc6c8bd78d6d433d
BLAKE2b-256 ce6d387a45166278ff6cf2bb774c7a73f9b41b54c4f8563fa45c90edf3a5f66d

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