openapi: 3.1.0
info:
  title: Apache Flink REST Checkpoints 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: Checkpoints
  description: Checkpoint configuration, status, and details.
paths:
  /jobs/{jobid}/checkpoints:
    get:
      tags:
      - Checkpoints
      summary: Checkpoint statistics for a job
      operationId: getJobCheckpoints
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Aggregated checkpoint information.
    post:
      tags:
      - Checkpoints
      summary: Trigger a checkpoint
      operationId: triggerCheckpoint
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '202':
          description: Checkpoint trigger accepted.
  /jobs/{jobid}/checkpoints/config:
    get:
      tags:
      - Checkpoints
      summary: Checkpoint configuration for a job
      operationId: getCheckpointConfig
      parameters:
      - $ref: '#/components/parameters/JobId'
      responses:
        '200':
          description: Checkpointing configuration.
  /jobs/{jobid}/checkpoints/details/{checkpointid}:
    get:
      tags:
      - Checkpoints
      summary: Checkpoint details
      operationId: getCheckpointDetails
      parameters:
      - $ref: '#/components/parameters/JobId'
      - in: path
        name: checkpointid
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Detailed information for a single checkpoint.
components:
  parameters:
    JobId:
      in: path
      name: jobid
      required: true
      schema:
        type: string
      description: A Flink job ID.