runtm-api

FastAPI control plane for Runtm. See the API docs for endpoint reference.

Hosted API: app.runtm.com

Endpoints

Method Path Description
POST /v0/deployments Create deployment (multipart: manifest + artifact.zip)
GET /v0/deployments/:id Get deployment status, URL, timestamps, error
GET /v0/deployments/:id/logs Get build/deploy logs

Creating Deployments

POST /v0/deployments

Creates a new deployment or redeploys an existing one (based on manifest name).

Query Parameters:

  • new=true - Force creation of new deployment instead of redeploying existing
  • tier=starter|standard|performance - Override machine tier from manifest

Request:

  • manifest (file) - runtm.yaml manifest file
  • artifact (file) - artifact.zip containing project files

Headers:

  • Authorization: Bearer <token> - API authentication token
  • Idempotency-Key: <key> - Optional idempotency key for retries

Example:

curl -X POST "http://localhost:8000/v0/deployments?tier=performance" \
  -H "Authorization: Bearer $RUNTM_API_KEY" \
  -F "manifest=@runtm.yaml" \
  -F "artifact=@artifact.zip"

Machine Tiers:

All deployments use auto-stop for cost savings (machines stop when idle and start automatically on traffic).

Tier CPUs Memory Est. Cost
starter (default) 1 shared 256MB ~$2/month*
standard 1 shared 512MB ~$5/month*
performance 2 shared 1GB ~$10/month*

*Costs are estimates for 24/7 operation. With auto-stop, costs are much lower for low-traffic services.

Development

# Install dependencies
pip install -e ".[dev]"

# Run migrations
alembic upgrade head

# Start server
uvicorn runtm_api.main:app --reload --host 0.0.0.0 --port 8000

# Run tests
pytest

Environment Variables

Variable Description Default
DATABASE_URL PostgreSQL connection string Required
REDIS_URL Redis connection string Required
RUNTM_API_SECRET API authentication secret (what server validates against) Required
ARTIFACT_STORAGE_PATH Local artifact storage path /artifacts
ARTIFACT_STORAGE_BACKEND Storage backend: local or s3 local
BUCKET_NAME S3/Tigris bucket name (when backend=s3) -
AWS_ENDPOINT_URL_S3 S3 endpoint URL (e.g. https://fly.storage.tigris.dev) -
AUTH_MODE Auth mode: single_tenant or multi_tenant single_tenant

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.2.139)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for gustrigos from gravatar.com gustrigos

Credits

Author/Maintainer: Gustavo Trigos

License

GNU Affero General Public License v3 or later (AGPLv3+) (AGPL-3.0-or-later)

Requires

Python >=3.9

Provides Extra

dev

Tags

api control-plane deployment fastapi

Classifiers

Report project as malware

Download files

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

Source Distribution

runtm_api-0.2.136.tar.gz (62.7 kB view details)

Uploaded Source

Built Distribution

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

runtm_api-0.2.136-py3-none-any.whl (61.3 kB view details)

Uploaded Python 3

File details

Details for the file runtm_api-0.2.136.tar.gz.

File metadata

  • Download URL: runtm_api-0.2.136.tar.gz
  • Upload date:
  • Size: 62.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","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

Hashes for runtm_api-0.2.136.tar.gz
Algorithm Hash digest
SHA256 418d6b71081a65262cb2201e744f5fceab64213e6c063d92c67d9af24543ac2f
MD5 4c3c9e299b6d6db67c0c862cb6231782
BLAKE2b-256 0e991bdd9eef5fd943ccdaed7073bc78a4907dd6b74233aacf57f9396eee468f

See more details on using hashes here.

File details

Details for the file runtm_api-0.2.136-py3-none-any.whl.

File metadata

  • Download URL: runtm_api-0.2.136-py3-none-any.whl
  • Upload date:
  • Size: 61.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","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

Hashes for runtm_api-0.2.136-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f2e92b9b70b941f5c8700a7549bd7359a886e2c62df499c4637c6952f5b136
MD5 a7bc8538aa5d987e4a6ec7cd8e4641fe
BLAKE2b-256 517c77b3cdd9bd4813d0f4cdb40058db0936fb005b915f95e7adae30abe58256

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 Sentry Error logging StatusPage Status page