openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints Cluster 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: Cluster
  description: Cluster lifecycle and configuration.
paths:
  /cluster:
    delete:
      tags:
      - Cluster
      summary: Shut down the cluster
      operationId: shutdownCluster
      responses:
        '200':
          description: Cluster shutdown initiated.
  /config:
    get:
      tags:
      - Cluster
      summary: Web UI configuration
      operationId: getWebUIConfig
      responses:
        '200':
          description: Web UI configuration.