openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints JobManager 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: JobManager
  description: JobManager configuration, environment, logs, metrics, and threads.
paths:
  /jobmanager/config:
    get:
      tags:
      - JobManager
      summary: Cluster configuration
      operationId: getJobManagerConfig
      responses:
        '200':
          description: JobManager configuration entries.
  /jobmanager/environment:
    get:
      tags:
      - JobManager
      summary: JobManager environment
      operationId: getJobManagerEnvironment
      responses:
        '200':
          description: JobManager JVM and environment details.
  /jobmanager/logs:
    get:
      tags:
      - JobManager
      summary: List JobManager log files
      operationId: listJobManagerLogs
      responses:
        '200':
          description: Available JobManager log files.
  /jobmanager/metrics:
    get:
      tags:
      - JobManager
      summary: JobManager metrics
      operationId: getJobManagerMetrics
      parameters:
      - in: query
        name: get
        schema:
          type: string
        description: Comma-separated metric names.
      responses:
        '200':
          description: Requested JobManager metric values.
  /jobmanager/thread-dump:
    get:
      tags:
      - JobManager
      summary: JobManager thread dump
      operationId: getJobManagerThreadDump
      responses:
        '200':
          description: Thread dump of the JobManager.