openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints TaskManagers 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: TaskManagers
  description: TaskManager listing and inspection.
paths:
  /taskmanagers:
    get:
      tags:
      - TaskManagers
      summary: List TaskManagers
      operationId: listTaskManagers
      responses:
        '200':
          description: List of TaskManagers in the cluster.
  /taskmanagers/{taskmanagerid}/metrics:
    get:
      tags:
      - TaskManagers
      summary: TaskManager metrics
      operationId: getTaskManagerMetrics
      parameters:
      - in: path
        name: taskmanagerid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: TaskManager metrics.
  /taskmanagers/{taskmanagerid}/logs:
    get:
      tags:
      - TaskManagers
      summary: List TaskManager logs
      operationId: listTaskManagerLogs
      parameters:
      - in: path
        name: taskmanagerid
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Available TaskManager log files.