systemd Jobs API

openapi: 3.1.0
info:
  title: systemd-hostnamed (org.freedesktop.hostname1) Boot Jobs 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: Jobs
  description: Pending and active jobs scheduled by the Manager.
paths:
  /jobs:
    get:
      tags:
      - Jobs
      operationId: ListJobs
      summary: List Pending And Running Jobs
      description: Mirrors `ListJobs()`.
      responses:
        '200':
          description: Array of jobs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Job'
  /jobs/{id}/cancel:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: integer
    post:
      tags:
      - Jobs
      operationId: CancelJob
      summary: Cancel A Pending Job
      description: Mirrors `CancelJob(id)`.
      responses:
        '204':
          description: Job cancelled.
components:
  schemas:
    Job:
      type: object
      properties:
        id:
          type: integer
        unit:
          type: string
        type:
          type: string
          enum:
          - start
          - verify-active
          - stop
          - reload
          - restart
          - try-restart
          - reload-or-start
        state:
          type: string
          enum:
          - waiting
          - running
        object_path:
          type: string
        unit_object_path:
          type: string