Apache Flink

Apache Flink Overview API

The Overview API from Apache Flink — 1 operation(s) for overview.

GitHub OpenAPI

Operations 1

GET /overview Apache Flink List Overview #

Documentation

📖
Documentation
https://nightlies.apache.org/flink/flink-docs-stable/docs/ops/rest_api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/openapi/apache-flink-overview-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/json-schema/flink-rest-job-details-info-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/json-ld/apache-flink-rest-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apache-flink-overview-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apache-flink-overview-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flink JobManager REST Cluster Overview 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
servers:
- url: http://localhost:8081
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Overview
paths:
  /overview:
    get:
      description: Returns an overview over the Flink cluster.
      operationId: getClusterOverview
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterOverviewWithVersion'
      summary: Apache Flink List Overview
      tags:
      - Overview
components:
  schemas:
    ClusterOverviewWithVersion:
      type: object
      properties:
        flink-commit:
          type: string
        flink-version:
          type: string
        jobs-cancelled:
          type: integer
          format: int32
        jobs-failed:
          type: integer
          format: int32
        jobs-finished:
          type: integer
          format: int32
        jobs-running:
          type: integer
          format: int32
        slots-available:
          type: integer
          format: int32
        slots-free-and-blocked:
          type: integer
          format: int32
        slots-total:
          type: integer
          format: int32
        taskmanagers:
          type: integer
          format: int32
        taskmanagers-blocked:
          type: integer
          format: int32