# FissionPlane

## Docs

- [Authenticate Requests to the FissionPlane API](https://fissionplane.dev/docs/api/authentication.md): Pass an API key or OIDC bearer token to the control plane. The data plane uses short-lived capability tokens minted by the control plane.
- [Commands API: Run Processes in Sandbox Data Plane](https://fissionplane.dev/docs/api/commands.md): Data plane endpoints for running commands to completion, starting background processes, listing supervised processes, and signaling or killing processes.
- [Files API: Read, Write, and Manage Sandbox Files](https://fissionplane.dev/docs/api/files.md): Data plane endpoints for listing directories, reading and writing files, uploading and downloading, and managing the sandbox filesystem.
- [FissionPlane REST API Overview and Base URLs](https://fissionplane.dev/docs/api/overview.md): FissionPlane exposes two HTTP APIs: the control plane API for sandbox lifecycle and templates, and the data plane API for commands and file operations per sandbox.
- [Sandbox API: Create, List, Pause, Resume, Delete](https://fissionplane.dev/docs/api/sandboxes.md): Control plane endpoints for managing sandbox lifecycle. Create from a template, pause to object storage, resume, extend deadlines, and filter by metadata.
- [Streaming API: Process I/O and File Watch via WebSocket](https://fissionplane.dev/docs/api/streaming.md): Stream process stdout, stderr, and stdin over WebSocket. Watch filesystem changes with inotify events. Both streams support replay from a sequence number.
- [Templates API: Build and Manage Sandbox Templates](https://fissionplane.dev/docs/api/templates.md): Control plane endpoints for template lifecycle. Start async builds from OCI images, stream build logs, list templates, and resolve aliases to artifact IDs.
- [Capability Tokens API: Mint Scoped Sandbox Credentials](https://fissionplane.dev/docs/api/tokens.md): Mint short-lived capability tokens scoped to a sandbox epoch. Use tokens to authenticate data plane requests and to grant scoped browser or third-party access.
- [FissionPlane Architecture: Four Planes, One Cluster](https://fissionplane.dev/docs/concepts/architecture.md): FissionPlane splits into four planes: control, gateway, node runtime, and guest. The data path bypasses the control plane so workloads survive outages.
- [Functions: Deploy Serverless Code on Your Own Hardware](https://fissionplane.dev/docs/concepts/functions.md): Deploy versioned functions from OCI images. FissionPlane invokes each from a warm snapshot and scales to zero. Functions are planned for a future release.
- [Sandboxes: Stateful Firecracker Linux Environments](https://fissionplane.dev/docs/concepts/sandboxes.md): Sandboxes run in Firecracker microVMs with their own kernel, filesystem, and network namespace. Create, pause, resume, and delete on demand from the SDK.
- [FissionPlane Security: Isolation, Tokens, and Trust](https://fissionplane.dev/docs/concepts/security.md): Hardware isolation per sandbox, epoch-scoped capability tokens, and a strict no-credentials-in-guest guarantee keep untrusted workloads contained.
- [Templates: Immutable Pre-Booted Sandbox Environments](https://fissionplane.dev/docs/concepts/templates.md): Templates are immutable pre-booted artifacts from OCI images. Every sandbox starts from a template. Build them once and create sandboxes in milliseconds.
- [Build FissionPlane Templates from Any OCI Container Image](https://fissionplane.dev/docs/guides/build-templates.md): Build a template from any OCI image with declarative steps. Sandboxes start in milliseconds from the pre-booted snapshot instead of a cold boot.
- [Read, Write, and Watch Files in FissionPlane Sandboxes](https://fissionplane.dev/docs/guides/filesystem.md): Use the FissionPlane filesystem API to upload, download, list, stat, move, and watch files inside a running sandbox via the data plane.
- [Pause and Resume Sandboxes with Full State Preserved](https://fissionplane.dev/docs/guides/pause-resume.md): Save a sandbox to object storage and resume it later with memory, processes, and files intact. Deadlines can be extended to keep a sandbox running longer.
- [Expose Sandbox Ports as Public or Private HTTPS URLs](https://fissionplane.dev/docs/guides/ports.md): Expose any sandbox port as private or public through a stable HTTPS URL. Private ports require a capability token; public ports allow anonymous access.
- [Run Commands and Stream Process Output in Sandboxes](https://fissionplane.dev/docs/guides/run-commands.md): Execute blocking commands, start background processes with PTY support, stream stdout and stderr, and send signals inside FissionPlane sandboxes.
- [Install FissionPlane on Kubernetes with a Helm Chart](https://fissionplane.dev/docs/installation.md): Install FissionPlane on any Kubernetes cluster using a single Helm chart. Covers prerequisites, node pool setup, and first-run validation.
- [FissionPlane: Self-Hosted Firecracker Sandbox Platform](https://fissionplane.dev/docs/introduction.md): FissionPlane runs AI agents, code interpreters, and CI jobs in isolated Firecracker microVMs on your own Kubernetes cluster. No cloud lock-in.
- [FissionPlane Quickstart: Your First Sandbox in Minutes](https://fissionplane.dev/docs/quickstart.md): Install the FissionPlane SDK, connect to your control plane, create your first sandbox, and run a command inside a Firecracker microVM.
- [FissionPlane Python SDK: Sandboxes, Commands, and Templates](https://fissionplane.dev/docs/sdks/python.md): Install and configure the fissionplane Python package. Use sync or async clients to manage sandboxes, run commands, stream output, and build templates.
- [FissionPlane Rust SDK: Async Sandboxes and Templates](https://fissionplane.dev/docs/sdks/rust.md): Add the fissionplane crate to your Rust project. Async Tokio-based client for sandboxes, commands, file I/O, port exposure, and template builds.
- [TypeScript SDK for FissionPlane Sandboxes and Templates](https://fissionplane.dev/docs/sdks/typescript.md): Install and configure the @fissionplane/sdk package for Node.js. Manage sandboxes, run commands, stream process I/O, and build templates from TypeScript.