How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Firecracker

Firecracker Vm API

The Vm API from Firecracker — 2 operation(s) for vm.

Documentation Provider Profile APIs.io OpenAPI GitHub

Firecracker Vm API is one of 19 APIs that Firecracker publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include vm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 2.0, at version 1.16.0-dev.

Requests are made against the base URL http://localhost/.

2 operations 2 paths 24 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.16.0-dev
Base URL
http://localhost/
Contact
firecracker-maintainers@amazon.com
License
Apache 2.0
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Vm 2
PATCH
/vm
Updates the microVM state.
patchVm 1 param → 204400default
GET
/vm/config
Gets the full VM configuration.
getExportVmConfig → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are FullVmConfiguration (13 properties), Drive (9 properties), MachineConfiguration (6 properties), CpuConfig (5 properties). Each schema is shown below with its type and property counts.

Vsock
object
Defines a vsock device, backed by a set of Unix Domain Sockets, on the host side. For host-initiated connections, Firecracker will be listening on the Unix soc…
3 properties 2 required
CpuTemplate
string
The CPU Template defines a set of flags to be disabled from the microvm so that the features exposed to the guest are the same as in the selected instance type…
Pmem
object
5 properties 2 required
EntropyDevice
object
Defines an entropy device.
1 property
NetworkInterface
object
Defines a network interface.
5 properties 2 required
RateLimiter
object
Defines an IO rate limiter with independent bytes/s and ops/s limits. Limits are defined by configuring each of the bandwidth and ops token buckets. This field…
2 properties
FullVmConfiguration
object
13 properties
MemoryHotplugConfig
object
The configuration of the hotpluggable memory device (virtio-mem)
3 properties
CpuidRegisterModifier
object
Modifier for a specific CPUID register within a leaf (x8664)
2 properties 2 required
Vm
object
Defines the microVM running state. It is especially useful in the snapshotting context.
1 property 1 required
MmdsConfig
object
Defines the MMDS configuration.
4 properties 1 required
Metrics
object
Describes the configuration option for the metrics capability.
1 property 1 required
Balloon
object
Balloon device descriptor.
5 properties 2 required
CpuConfig
object
The CPU configuration template defines a set of bit maps as modifiers of flags accessed by register to be disabled/enabled for the microvm.
5 properties
CpuidLeafModifier
object
Modifier for a CPUID leaf and subleaf (x8664)
4 properties 4 required
Error
object
1 property
BootSource
object
Boot source descriptor.
3 properties 1 required
MachineConfiguration
object
Describes the number of vCPUs, memory size, SMT capabilities, huge page configuration and the CPU template.
6 properties 2 required
MsrModifier
object
Modifier for a model specific register (x8664)
2 properties 2 required
TokenBucket
object
Defines a token bucket with a maximum capacity (size), an initial burst size (onetimeburst) and an interval for refilling purposes (refilltime). The refill-rat…
3 properties 2 required
Drive
object
9 properties 2 required
VcpuFeatures
object
vCPU feature modifier (aarch64)
2 properties 2 required
ArmRegisterModifier
object
Modifier for an ARM register (aarch64)
2 properties 2 required
Logger
object
Describes the configuration option for the logging capability.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firecracker-vm-api-openapi.yml Raw ↑

Other APIs Firecracker publishes across the network.

Firecracker Actions API
AE Profile APIs.io
Firecracker Balloon API
AE Profile APIs.io
Firecracker Boot Source API
AE Profile APIs.io
Firecracker Cpu Config API
AE Profile APIs.io
Firecracker Drives API
AE Profile APIs.io
Firecracker Entropy API
AE Profile APIs.io
Firecracker Firecracker API API
AE Profile APIs.io
Firecracker Hotplug API
AE Profile APIs.io
Firecracker Logger API
AE Profile APIs.io
Firecracker Machine Config API
AE Profile APIs.io
Firecracker Metrics API
AE Profile APIs.io
Firecracker Mmds API
AE Profile APIs.io
#vm
← Back to F APIs
API Details
ID
firecracker:firecracker-vm-api
Base URL
http://localhost/
Docs
https://github.com/firecracker-microvm/firecracker
Provider
Firecracker
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=firecracker-vm-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/firecracker-vm-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Firecracker Vm API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.