Firecracker API
RESTful public-facing API. The API is accessible through HTTP calls on specific URLs carrying JSON modeled data. The transport medium is a Unix Domain Socket.
What You Can Do
MCP Tools
describeinstance
Returns general information about an instance.
createsyncaction
Creates a synchronous action.
describeballoonconfig
Returns the current balloon device configuration.
putballoon
Creates or updates a balloon device.
patchballoon
Updates a balloon device.
describeballoonstats
Returns the latest balloon device statistics, only if enabled pre-boot.
patchballoonstatsinterval
Updates a balloon device statistics polling interval.
startballoonhinting
Starts a free page hinting run only if enabled pre-boot.
describeballoonhinting
Returns the balloon hinting statistics, only if enabled pre-boot.
stopballoonhinting
Stops a free page hinting run only if enabled pre-boot.
putguestbootsource
Creates or updates the boot source. Pre-boot only.
putcpuconfiguration
Configures CPU features flags for the vCPUs of the guest VM. Pre-boot only.
putguestdrivebyid
Creates or updates a drive. Pre-boot only.
patchguestdrivebyid
Updates the properties of a drive. Post-boot only.
putguestpmembyid
Creates or updates a pmem device. Pre-boot only.
patchguestpmembyid
Updates the rate limiter of a pmem device. Post-boot only.
putlogger
Initializes the logger by specifying a named pipe or a file for the logs output.
getmachineconfiguration
Gets the machine configuration of the VM.
putmachineconfiguration
Updates the Machine Configuration of the VM. Pre-boot only.
patchmachineconfiguration
Partially updates the Machine Configuration of the VM. Pre-boot only.
putmetrics
Initializes the metrics system by specifying a named pipe or a file for the metrics output.
putmmds
Creates a MMDS (Microvm Metadata Service) data store.
patchmmds
Updates the MMDS data store.
getmmds
Get the MMDS data store.
putmmdsconfig
Set MMDS configuration. Pre-boot only.
putentropydevice
Creates an entropy device. Pre-boot only.
putserialdevice
Configures the serial console
putmemoryhotplug
Configures the hotpluggable memory
patchmemoryhotplug
Updates the size of the hotpluggable memory region
getmemoryhotplug
Retrieves the status of the hotpluggable memory
putguestnetworkinterfacebyid
Creates a network interface. Pre-boot only.
patchguestnetworkinterfacebyid
Updates the rate limiters applied to a network interface. Post-boot only.
createsnapshot
Creates a full or diff snapshot. Post-boot only.
loadsnapshot
Loads a snapshot. Pre-boot only.
getfirecrackerversion
Gets the Firecracker version.
patchvm
Updates the microVM state.
getexportvmconfig
Gets the full VM configuration.
putguestvsock
Creates/updates a vsock device. Pre-boot only.