Apache Flink Jobs API

openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints Jobs API
  description: The Flink REST API is exposed by the JobManager Dispatcher and provides monitoring and management capabilities for a Flink cluster. It covers cluster configuration, JobManager environment and metrics, job lifecycle (submit, list, cancel, stop), checkpoint and savepoint management, JAR upload and execution, dataset operations, and TaskManager inspection.
  version: v1
  contact:
    name: Apache Flink
    url: https://flink.apache.org/community/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8081
  description: Default JobManager Dispatcher endpoint
tags:
- name: Jobs
  description: Job lifecycle and inspection.
paths:
  /jobs:
    get:
      tags:
      - Jobs
      summary: List jobs
      operationId: listJobs
      responses:
        '200':
          description: List of jobs and their status.
  /jobs/overview:
    get:
      tags:
      - Jobs
      summary: Jobs overview
      operationId: getJobsOverview
      responses:
        '200':
          description: Overview of all jobs.
  /jobs/metrics:
    get:
      tags:
      - Jobs
      summary: Aggregated job metrics
      operationId: getJobsMetrics
      responses:
        '200':
          description: Aggregated job-level metrics.
  /jobs/{jobid}:
    get:
      tags:
      - Jobs
      summary: Get job details
      operationId: getJob
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Details of the specified job.
    patch:
      tags:
      - Jobs
      summary: Cancel or stop a job
      operationId: terminateJob
      parameters:
      - $ref: '#/components/parameters/JobId'
      - in: query
        name: mode
        schema:
          type: string
          enum:
          - cancel
          - stop
      responses:
        '202':
          description: Termination accepted.
  /jobs/{jobid}/config:
    get:
      tags:
      - Jobs
      summary: Job configuration
      operationId: getJobConfig
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Job configuration values.
  /jobs/{jobid}/exceptions:
    get:
      tags:
      - Jobs
      summary: Job exception history
      operationId: getJobExceptions
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Recorded exceptions for the job.
  /jobs/{jobid}/accumulators:
    get:
      tags:
      - Jobs
      summary: Job accumulators
      operationId: getJobAccumulators
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Accumulator values for the job.
components:
  parameters:
    JobId:
      in: path
      name: jobid
      required: true
      schema:
        type: string
      description: A Flink job ID.