Apache Flink

Apache Flink Jobs API

The Jobs API from Apache Flink — 42 operation(s) for jobs.

GitHub OpenAPI

Operations 45

GET /jobs Apache Flink List Jobs #
GET /jobs/metrics Apache Flink List Jobs Metrics #
GET /jobs/overview Apache Flink List Jobs Overview #
GET /jobs/{jobid} Apache Flink Get Jobs #
PATCH /jobs/{jobid} Apache Flink Update Jobs #
GET /jobs/{jobid}/accumulators Apache Flink List Jobs Accumulators #
GET /jobs/{jobid}/checkpoints Apache Flink List Jobs Checkpoints #
POST /jobs/{jobid}/checkpoints Apache Flink Create Jobs Checkpoints #
GET /jobs/{jobid}/checkpoints/config Apache Flink List Checkpoints Config #
GET /jobs/{jobid}/checkpoints/details/{checkpointid} Apache Flink Get Checkpoints Details #
GET /jobs/{jobid}/checkpoints/details/{checkpointid}/subtasks/{vertexid} Apache Flink Get Details Subtasks #
GET /jobs/{jobid}/checkpoints/{triggerid} Apache Flink Get Jobs Checkpoints #
PATCH /jobs/{jobid}/clientHeartbeat Apache Flink Update Jobs Clientheartbeat #
GET /jobs/{jobid}/config Apache Flink List Jobs Config #
GET /jobs/{jobid}/exceptions Apache Flink List Jobs Exceptions #
GET /jobs/{jobid}/execution-result Apache Flink List Jobs Execution-Result #
GET /jobs/{jobid}/jobmanager/config Apache Flink List Jobmanager Config #
GET /jobs/{jobid}/jobmanager/environment Apache Flink List Jobmanager Environment #
GET /jobs/{jobid}/jobmanager/log-url Apache Flink List Jobmanager Log-Url #
GET /jobs/{jobid}/metrics Apache Flink List Jobs Metrics #
GET /jobs/{jobid}/plan Apache Flink List Jobs Plan #
PATCH /jobs/{jobid}/rescaling Apache Flink Update Jobs Rescaling #
GET /jobs/{jobid}/rescaling/{triggerid} Apache Flink Get Jobs Rescaling #
GET /jobs/{jobid}/resource-requirements Apache Flink List Jobs Resource-Requirements #
PUT /jobs/{jobid}/resource-requirements Apache Flink Update Jobs Resource-Requirements #
POST /jobs/{jobid}/savepoints Apache Flink Create Jobs Savepoints #
GET /jobs/{jobid}/savepoints/{triggerid} Apache Flink Get Jobs Savepoints #
GET /jobs/{jobid}/status Apache Flink List Jobs Status #
POST /jobs/{jobid}/stop Apache Flink Create Jobs Stop #
GET /jobs/{jobid}/taskmanagers/{taskmanagerid}/log-url Apache Flink List Taskmanagers Log-Url #
GET /jobs/{jobid}/vertices/{vertexid} Apache Flink Get Jobs Vertices #
GET /jobs/{jobid}/vertices/{vertexid}/accumulators Apache Flink List Vertices Accumulators #
GET /jobs/{jobid}/vertices/{vertexid}/backpressure Apache Flink List Vertices Backpressure #
GET /jobs/{jobid}/vertices/{vertexid}/flamegraph Apache Flink List Vertices Flamegraph #
GET /jobs/{jobid}/vertices/{vertexid}/jm-operator-metrics Apache Flink List Vertices Jm-Operator-Metrics #
GET /jobs/{jobid}/vertices/{vertexid}/metrics Apache Flink List Vertices Metrics #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/accumulators Apache Flink List Subtasks Accumulators #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/metrics Apache Flink List Subtasks Metrics #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex} Apache Flink Get Vertices Subtasks #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt} Apache Flink Get Subtasks Attempts #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt}/accumulators Apache Flink List Attempts Accumulators #
GET /jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/metrics Apache Flink List Subtasks Metrics #
GET /jobs/{jobid}/vertices/{vertexid}/subtasktimes Apache Flink List Vertices Subtasktimes #
GET /jobs/{jobid}/vertices/{vertexid}/taskmanagers Apache Flink List Vertices Taskmanagers #
GET /jobs/{jobid}/vertices/{vertexid}/watermarks Apache Flink List Vertices Watermarks #

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-jobs-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-jobs-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-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Flink JobManager REST Jobs 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:


# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apache-flink/refs/heads/main/openapi/apache-flink-jobs-api-openapi.yml