Apache Flink Config API

The Config API from Apache Flink — 1 operation(s) for config.

OpenAPI Specification

apache-flink-config-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Flink JobManager REST Cluster Config API
  contact:
    email: user@flink.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: v1/2.0-SNAPSHOT
tags:
- name: Config
paths:
  /config:
    get:
      description: Returns the configuration of the WebUI.
      operationId: getDashboardConfiguration
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardConfiguration'
      summary: Apache Flink List Config
      tags:
      - Config
components:
  schemas:
    DashboardConfiguration:
      type: object
      properties:
        features:
          $ref: '#/components/schemas/Features'
        flink-revision:
          type: string
        flink-version:
          type: string
        refresh-interval:
          type: integer
          format: int64
        timezone-name:
          type: string
        timezone-offset:
          type: integer
          format: int32
    Features:
      type: object
      properties:
        web-cancel:
          type: boolean
        web-history:
          type: boolean
        web-rescale:
          type: boolean
        web-submit:
          type: boolean