crucible

REST API for the crucible daemon, a Firecracker microVM sandbox runtime. The daemon is the contract every SDK mirrors. Auth is a bearer token (Authorization: Bearer <key>); /healthz is always exempt, and a loopback daemon with no keys configured serves unauthenticated. The exec and service-log endpoints stream a binary frame protocol OpenAPI cannot model — see the guides for the frame format.

• Version: 0.9.4

apps

• GET List apps
• POST Create a durable app
• GET Get an app
• PUT Update an app
• DELETE Delete an app
• GET List an app's custom domains
• POST Attach a custom domain to an app
• DELETE Detach a custom domain
• GET Interactive exec into an app (WebSocket)
• POST Run a command in an app's current instance (streams frames)
• GET Read an app's current-instance logs
• GET Get an app's usage metrics
• GET List app lifecycle events
• GET List every app's usage metrics

images

• GET List cached images
• POST Pull and convert an OCI image
• POST Import a docker-save archive
• GET Get a cached image
• DELETE Delete a cached image

logs

• GET Read durable sandbox logs

meta

• GET Liveness check
• GET List rootfs profiles
• GET Effective policy for the caller

registry

• GET List registry credentials
• POST Store a private-registry credential
• DELETE Remove a registry credential

sandboxes

• GET List sandboxes
• POST Create a sandbox
• GET Get a sandbox
• DELETE Destroy a sandbox
• GET Interactive exec (WebSocket)
• POST Run a command (streams frames)
• GET Read a single guest file
• POST Push files into a sandbox

secrets

• GET List secret bundles
• GET List a bundle's key names
• PUT Store a secret bundle
• DELETE Delete a secret bundle

service

• GET Service status
• PUT Configure the supervised service
• GET Stream service logs
• POST Restart the service
• POST Start the service
• POST Stop the service

snapshots

• POST Snapshot a sandbox
• GET List snapshots
• GET Get a snapshot
• DELETE Delete a snapshot
• POST Fork sandboxes from a snapshot

volumes

• GET List all volume backups
• DELETE Delete a backup
• GET List volumes
• POST Create a persistent volume
• POST Reload the encryption keyring
• POST Re-wrap every volume off a key
• GET Get a volume
• DELETE Delete a volume
• GET List a volume's backups
• POST Back up a volume
• POST Clone a volume
• POST Grow a volume
• POST Restore a backup to a new volume
• POST Re-wrap a volume's encryption key
• POST Crypto-shred an encrypted volume