Firecracker

Firecracker Mmds API

The Mmds API from Firecracker — 2 operation(s) for mmds.

GitHub OpenAPI

Operations 4

PUT /mmds Creates a MMDS (Microvm Metadata Service) data store. #
PATCH /mmds Updates the MMDS data store. #
GET /mmds Get the MMDS data store. #
PUT /mmds/config Set MMDS configuration. Pre-boot only. #

Documentation

📖
Documentation
https://github.com/firecracker-microvm/firecracker/tree/main/docs
📖
GettingStarted
https://github.com/firecracker-microvm/firecracker/blob/main/docs/getting-started.md

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/firecracker/refs/heads/main/openapi/firecracker-mmds-api-openapi.yml

Other Resources

🔗
API Requests
https://github.com/firecracker-microvm/firecracker/tree/main/docs/api_requests
🔗
Specification
https://github.com/firecracker-microvm/firecracker/blob/main/SPECIFICATION.md
🔗
Design
https://github.com/firecracker-microvm/firecracker/blob/main/docs/design.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/firecracker-mmds-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

firecracker-mmds-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Firecracker Actions Mmds API
  description: 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.
  version: 1.16.0-dev
  termsOfService: ''
  contact:
    email: firecracker-maintainers@amazon.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost/
tags:
- name: Mmds
paths:
  /mmds:
    put:
      summary: Creates a MMDS (Microvm Metadata Service) data store.
      operationId: putMmds
      responses:
        204:
          description: MMDS data store created/updated.
        400:
          description: MMDS data store cannot be created due to bad input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Mmds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MmdsContentsObject'
        description: The MMDS data store as JSON.
    patch:
      summary: Updates the MMDS data store.
      operationId: patchMmds
      responses:
        204:
          description: MMDS data store updated.
        400:
          description: MMDS data store cannot be updated due to bad input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Mmds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MmdsContentsObject'
        description: The MMDS data store patch JSON.
    get:
      summary: Get the MMDS data store.
      operationId: getMmds
      responses:
        200:
          description: The MMDS data store JSON.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        404:
          description: The MMDS data store content can not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Mmds
  /mmds/config:
    put:
      summary: Set MMDS configuration. Pre-boot only.
      operationId: putMmdsConfig
      description: Configures MMDS version, IPv4 address used by the MMDS network stack and interfaces that allow MMDS requests.
      responses:
        204:
          description: MMDS configuration was created/updated.
        400:
          description: MMDS configuration cannot be updated due to bad input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Mmds
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MmdsConfig'
        description: The MMDS configuration as JSON.
        required: true
components:
  schemas:
    Error:
      type: object
      properties:
        fault_message:
          type: string
          description: A description of the error condition
          readOnly: true
    MmdsContentsObject:
      type: object
      description: Describes the contents of MMDS in JSON format.
      additionalProperties: true
    MmdsConfig:
      type: object
      description: Defines the MMDS configuration.
      required:
      - network_interfaces
      properties:
        version:
          description: Enumeration indicating the MMDS version to be configured.
          type: string
          enum:
          - V1
          - V2
          default: V1
        network_interfaces:
          description: List of the network interface IDs capable of forwarding packets to the MMDS. Network interface IDs mentioned must be valid at the time of this request. The net device model will reply to HTTP GET requests sent to the MMDS address via the interfaces mentioned. In this case, both ARP requests and TCP segments heading to `ipv4_address` are intercepted by the device model, and do not reach the associated TAP device.
          type: array
          items:
            type: string
        ipv4_address:
          type: string
          format: 169.254.([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-4]).([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])
          default: 169.254.169.254
          description: A valid IPv4 link-local address.
        imds_compat:
          type: boolean
          description: MMDS operates compatibly with EC2 IMDS (i.e. responds "text/plain" content regardless of Accept header in requests).
          default: false