Apache Flink

Apache Flink Task Managers API

The Task Managers API from Apache Flink — 6 operation(s) for task managers.

GitHub OpenAPI

Operations 6

GET /taskmanagers Apache Flink List Taskmanagers #
GET /taskmanagers/metrics Apache Flink List Taskmanagers Metrics #
GET /taskmanagers/{taskmanagerid} Apache Flink Get Taskmanagers #
GET /taskmanagers/{taskmanagerid}/logs Apache Flink List Taskmanagers Logs #
GET /taskmanagers/{taskmanagerid}/metrics Apache Flink List Taskmanagers Metrics #
GET /taskmanagers/{taskmanagerid}/thread-dump Apache Flink List Taskmanagers Thread-Dump #

Documentation

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

Specifications

⚙
OpenAPI
https://artifacts.apis.io/apache-flink/openapi/apache-flink-task-managers-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-task-manager-details-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-task-managers-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-thread-dump-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-metric-collection-response-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-log-list-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/apache-flink/json-schema/apache-flink-aggregated-metrics-response-body-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/apache-flink/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:apache-flink-task-managers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-task-managers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flink JobManager REST Taskmanagers 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: Task Managers
paths:
  /taskmanagers:
    get:
      description: Returns an overview over all task managers.
      operationId: getTaskManagers
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskManagersInfo'
      summary: Apache Flink List Taskmanagers
      tags:
      - Task Managers
  /taskmanagers/metrics:
    get:
      description: Provides access to aggregated task manager metrics.
      operationId: getAggregatedTaskManagerMetrics
      parameters:
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      - name: agg
        in: query
        description: 'Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".'
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/AggregationMode'
      - name: taskmanagers
        in: query
        description: Comma-separated list of 32-character hexadecimal strings to select specific task managers.
        required: false
        style: form
        schema:
          $ref: '#/components/schemas/ResourceID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregatedMetricsResponseBody'
      summary: Apache Flink List Taskmanagers Metrics
      tags:
      - Task Managers
  /taskmanagers/{taskmanagerid}:
    get:
      description: Returns details for a task manager.
      operationId: getTaskManagerDetails
      parameters:
      - name: taskmanagerid
        in: path
        description: 32-character hexadecimal string that identifies a task manager.
        required: true
        schema:
          $ref: '#/components/schemas/ResourceID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskManagerDetailsInfo'
      summary: Apache Flink Get Taskmanagers
      tags:
      - Task Managers
  /taskmanagers/{taskmanagerid}/logs:
    get:
      description: Returns the list of log files on a TaskManager.
      operationId: getTaskManagerLogs
      parameters:
      - name: taskmanagerid
        in: path
        description: 32-character hexadecimal string that identifies a task manager.
        required: true
        schema:
          $ref: '#/components/schemas/ResourceID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogListInfo'
      summary: Apache Flink List Taskmanagers Logs
      tags:
      - Task Managers
  /taskmanagers/{taskmanagerid}/metrics:
    get:
      description: Provides access to task manager metrics.
      operationId: getTaskManagerMetrics
      parameters:
      - name: taskmanagerid
        in: path
        description: 32-character hexadecimal string that identifies a task manager.
        required: true
        schema:
          $ref: '#/components/schemas/ResourceID'
      - name: get
        in: query
        description: Comma-separated list of string values to select specific metrics.
        required: false
        style: form
        schema:
          type: string
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricCollectionResponseBody'
      summary: Apache Flink List Taskmanagers Metrics
      tags:
      - Task Managers
  /taskmanagers/{taskmanagerid}/thread-dump:
    get:
      description: Returns the thread dump of the requested TaskManager.
      operationId: getTaskManagerThreadDump
      parameters:
      - name: taskmanagerid
        in: path
        description: 32-character hexadecimal string that identifies a task manager.
        required: true
        schema:
          $ref: '#/components/schemas/ResourceID'
      responses:
        '200':
          description: The request was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThreadDumpInfo'
      summary: Apache Flink List Taskmanagers Thread-Dump
      tags:
      - Task Managers
components:
  schemas:
    HardwareDescription:
      type: object
      properties:
        cpuCores:
          type: integer
          format: int32
        freeMemory:
          type: integer
          format: int64
        managedMemory:
          type: integer
          format: int64
        physicalMemory:
          type: integer
          format: int64
    TaskManagerDetailsInfo:
      type: object
      properties:
        allocatedSlots:
          type: array
          items:
            $ref: '#/components/schemas/SlotInfo'
        blocked:
          type: boolean
        dataPort:
          type: integer
          format: int32
        freeResource:
          $ref: '#/components/schemas/ResourceProfileInfo'
        freeSlots:
          type: integer
          format: int32
        hardware:
          $ref: '#/components/schemas/HardwareDescription'
        id:
          $ref: '#/components/schemas/ResourceID'
        jmxPort:
          type: integer
          format: int32
        memoryConfiguration:
          $ref: '#/components/schemas/TaskExecutorMemoryConfiguration'
        metrics:
          $ref: '#/components/schemas/TaskManagerMetricsInfo'
        path:
          type: string
        slotsNumber:
          type: integer
          format: int32
        timeSinceLastHeartbeat:
          type: integer
          format: int64
        totalResource:
          $ref: '#/components/schemas/ResourceProfileInfo'
    TaskManagerMetricsInfo:
      type: object
      properties:
        directCount:
          type: integer
          format: int64
        directMax:
          type: integer
          format: int64
        directUsed:
          type: integer
          format: int64
        garbageCollectors:
          type: array
          items:
            $ref: '#/components/schemas/GarbageCollectorInfo'
        heapCommitted:
          type: integer
          format: int64
        heapMax:
          type: integer
          format: int64
        heapUsed:
          type: integer
          format: int64
        mappedCount:
          type: integer
          format: int64
        mappedMax:
          type: integer
          format: int64
        mappedUsed:
          type: integer
          format: int64
        nettyShuffleMemoryAvailable:
          type: integer
          format: int64
        nettyShuffleMemorySegmentsAvailable:
          type: integer
          format: int64
        nettyShuffleMemorySegmentsTotal:
          type: integer
          format: int64
        nettyShuffleMemorySegmentsUsed:
          type: integer
          format: int64
        nettyShuffleMemoryTotal:
          type: integer
          format: int64
        nettyShuffleMemoryUsed:
          type: integer
          format: int64
        nonHeapCommitted:
          type: integer
          format: int64
        nonHeapMax:
          type: integer
          format: int64
        nonHeapUsed:
          type: integer
          format: int64
    MetricCollectionResponseBody:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/Metric'
    Metric:
      required:
      - id
      type: object
      properties:
        id:
          type: string
        value:
          type: string
    ThreadInfo:
      type: object
      properties:
        stringifiedThreadInfo:
          type: string
        threadName:
          type: string
    ResourceID:
      pattern: '[0-9a-f]{32}'
      type: string
    TaskExecutorMemoryConfiguration:
      type: object
      properties:
        frameworkHeap:
          type: integer
          format: int64
        frameworkOffHeap:
          type: integer
          format: int64
        jvmMetaspace:
          type: integer
          format: int64
        jvmOverhead:
          type: integer
          format: int64
        managedMemory:
          type: integer
          format: int64
        networkMemory:
          type: integer
          format: int64
        taskHeap:
          type: integer
          format: int64
        taskOffHeap:
          type: integer
          format: int64
        totalFlinkMemory:
          type: integer
          format: int64
        totalProcessMemory:
          type: integer
          format: int64
    AggregatedMetricsResponseBody:
      type: object
    LogListInfo:
      type: object
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/LogInfo'
    JobID:
      pattern: '[0-9a-f]{32}'
      type: string
    TaskManagerInfo:
      type: object
      properties:
        blocked:
          type: boolean
        dataPort:
          type: integer
          format: int32
        freeResource:
          $ref: '#/components/schemas/ResourceProfileInfo'
        freeSlots:
          type: integer
          format: int32
        hardware:
          $ref: '#/components/schemas/HardwareDescription'
        id:
          $ref: '#/components/schemas/ResourceID'
        jmxPort:
          type: integer
          format: int32
        memoryConfiguration:
          $ref: '#/components/schemas/TaskExecutorMemoryConfiguration'
        path:
          type: string
        slotsNumber:
          type: integer
          format: int32
        timeSinceLastHeartbeat:
          type: integer
          format: int64
        totalResource:
          $ref: '#/components/schemas/ResourceProfileInfo'
    ThreadDumpInfo:
      type: object
      properties:
        threadInfos:
          type: array
          items:
            $ref: '#/components/schemas/ThreadInfo'
    SlotInfo:
      type: object
      properties:
        jobId:
          $ref: '#/components/schemas/JobID'
        resource:
          $ref: '#/components/schemas/ResourceProfileInfo'
    GarbageCollectorInfo:
      type: object
      properties:
        count:
          type: integer
          format: int64
        name:
          type: string
        time:
          type: integer
          format: int64
    ResourceProfileInfo:
      type: object
      properties:
        cpuCores:
          type: number
          format: double
        extendedResources:
          type: object
          additionalProperties:
            type: number
            format: double
        managedMemory:
          type: integer
          format: int32
        networkMemory:
          type: integer
          format: int32
        taskHeapMemory:
          type: integer
          format: int32
        taskOffHeapMemory:
          type: integer
          format: int32
    AggregationMode:
      type: string
      enum:
      - MIN
      - MAX
      - SUM
      - AVG
      - SKEW
    LogInfo:
      type: object
      properties:
        mtime:
          type: integer
          format: int64
        name:
          type: string
        size:
          type: integer
          format: int64
    TaskManagersInfo:
      type: object
      properties:
        taskmanagers:
          type: array
          items:
            $ref: '#/components/schemas/TaskManagerInfo'