systemd

systemd Machines API

The Machines API from systemd — 7 operation(s) for machines.

Documentation GitHub OpenAPI

Operations 7

GET /machines List All Registered Machines #

GET /machines/{name} Get A Machine By Name #

POST /machines/{name}/terminate Terminate A Machine #

POST /machines/{name}/kill Send A Signal To A Machine #

POST /machines/{name}/open-shell Open A Shell Inside A Machine #

POST /machines/{name}/copy-from Copy A File Out Of A Machine #

POST /machines/{name}/copy-to Copy A File Into A Machine #

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/systemd-machines-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

openapi: 3.2.0
info:
  title: systemd-hostnamed (org.freedesktop.hostname1) Boot Machines API
  version: '1.0'
  summary: D-Bus API of systemd-hostnamed modeled as REST operations.
  description: 'Documentation/contract artifact for the `org.freedesktop.hostname1` D-Bus interface on the

    system bus. Manages the system hostname (static, transient, pretty), chassis type, deployment,

    location, icon name, and other machine info.

    '
  license:
    name: LGPL-2.1-or-later
    url: https://github.com/systemd/systemd/blob/main/LICENSES/LGPL-2.1-or-later.txt
servers:
- url: dbus://system/org.freedesktop.hostname1
tags:
- name: Machines
paths:
  /machines:
    get:
      tags:
      - Machines
      operationId: ListMachines
      summary: List All Registered Machines
      description: Mirrors `ListMachines()`. Returns (name, class, service, object path) tuples.
      responses:
        '200':
          description: Array of machines.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Machine'
  /machines/{name}:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Machines
      operationId: GetMachine
      summary: Get A Machine By Name
      description: Mirrors `GetMachine(name)`.
      responses:
        '200':
          description: Machine object path.
  /machines/{name}/terminate:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Machines
      operationId: TerminateMachine
      summary: Terminate A Machine
      description: Mirrors `TerminateMachine(name)`.
      responses:
        '204':
          description: Terminated.
  /machines/{name}/kill:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Machines
      operationId: KillMachine
      summary: Send A Signal To A Machine
      description: Mirrors `KillMachine(name, who, signal)`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                who:
                  type: string
                  enum:
                  - all
                  - leader
                signal:
                  type: integer
      responses:
        '204':
          description: Signal sent.
  /machines/{name}/open-shell:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Machines
      operationId: OpenMachineShell
      summary: Open A Shell Inside A Machine
      description: Mirrors `OpenMachineShell(name, user, path, args, env)`. Returns a PTY FD.
      responses:
        '200':
          description: PTY FD info.
  /machines/{name}/copy-from:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Machines
      operationId: CopyFromMachine
      summary: Copy A File Out Of A Machine
      description: Mirrors `CopyFromMachine(name, src, dest)`.
      responses:
        '204':
          description: Copied.
  /machines/{name}/copy-to:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Machines
      operationId: CopyToMachine
      summary: Copy A File Into A Machine
      description: Mirrors `CopyToMachine(name, src, dest)`.
      responses:
        '204':
          description: Copied.
components:
  schemas:
    Machine:
      type: object
      properties:
        name:
          type: string
        class:
          type: string
          enum:
          - vm
          - container
        service:
          type: string
          description: Service that registered the machine (e.g. systemd-nspawn, libvirt).
        object_path:
          type: string