How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Apache Flink

Apache Flink Jobs API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Apache Flink Jobs API is one of 10 APIs that Apache Flink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Job. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 45 operations across 42 paths, and defines 97 schemas. It is described by OpenAPI 3.2.0, at version v1/2.0-SNAPSHOT.

Requests are made against a single base URL, http://localhost:8081.

45 operations 42 paths 97 schemas 38 GET3 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1/2.0-SNAPSHOT
Base URL
http://localhost:8081
Contact
user@flink.apache.org
License
Apache 2.0
Resource Areas
1

Paths & Operations 45

Across 42 paths, the API surfaces 45 operations — 38 GET, 3 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 45
GET
/jobs
Apache Flink List Jobs
getJobIdsWithStatusesOverview → 200
GET
/jobs/metrics
Apache Flink List Jobs Metrics
getAggregatedJobMetrics 3 params → 200
GET
/jobs/overview
Apache Flink List Jobs Overview
getJobsOverview → 200
GET
/jobs/{jobid}
Apache Flink Get Jobs
getJobDetails 1 param → 200
PATCH
/jobs/{jobid}
Apache Flink Update Jobs
cancelJob 2 params → 202
GET
/jobs/{jobid}/accumulators
Apache Flink List Jobs Accumulators
getJobAccumulators 2 params → 200
GET
/jobs/{jobid}/checkpoints
Apache Flink List Jobs Checkpoints
getCheckpointingStatistics 1 param → 200
POST
/jobs/{jobid}/checkpoints
Apache Flink Create Jobs Checkpoints
triggerCheckpoint 1 param body → 202
GET
/jobs/{jobid}/checkpoints/config
Apache Flink List Checkpoints Config
getCheckpointConfig 1 param → 200
GET
/jobs/{jobid}/checkpoints/details/{checkpointid}
Apache Flink Get Checkpoints Details
getCheckpointStatisticDetails 2 params → 200
GET
/jobs/{jobid}/checkpoints/details/{checkpointid}/subtasks/{vertexid}
Apache Flink Get Details Subtasks
getTaskCheckpointStatistics 3 params → 200
GET
/jobs/{jobid}/checkpoints/{triggerid}
Apache Flink Get Jobs Checkpoints
getCheckpointStatus 2 params → 200
PATCH
/jobs/{jobid}/clientHeartbeat
Apache Flink Update Jobs Clientheartbeat
triggerHeartbeat 1 param body → 202
GET
/jobs/{jobid}/config
Apache Flink List Jobs Config
getJobConfig 1 param → 200
GET
/jobs/{jobid}/exceptions
Apache Flink List Jobs Exceptions
getJobExceptions 3 params → 200
GET
/jobs/{jobid}/execution-result
Apache Flink List Jobs Execution-Result
getJobExecutionResult 1 param → 200
GET
/jobs/{jobid}/jobmanager/config
Apache Flink List Jobmanager Config
getJobManagerJobConfiguration 1 param → 200
GET
/jobs/{jobid}/jobmanager/environment
Apache Flink List Jobmanager Environment
getJobManagerJobEnvironment 1 param → 200
GET
/jobs/{jobid}/jobmanager/log-url
Apache Flink List Jobmanager Log-Url
getJobManagerLogUrl 1 param → 200
GET
/jobs/{jobid}/metrics
Apache Flink List Jobs Metrics
getJobMetrics 2 params → 200
GET
/jobs/{jobid}/plan
Apache Flink List Jobs Plan
getJobPlan 1 param → 200
PATCH
/jobs/{jobid}/rescaling
Apache Flink Update Jobs Rescaling
rescaleJob 2 params → 200
GET
/jobs/{jobid}/rescaling/{triggerid}
Apache Flink Get Jobs Rescaling
getRescalingStatus 2 params → 200
GET
/jobs/{jobid}/resource-requirements
Apache Flink List Jobs Resource-Requirements
getJobResourceRequirements 1 param → 200
PUT
/jobs/{jobid}/resource-requirements
Apache Flink Update Jobs Resource-Requirements
updateJobResourceRequirements 1 param body → 200
POST
/jobs/{jobid}/savepoints
Apache Flink Create Jobs Savepoints
triggerSavepoint 1 param body → 202
GET
/jobs/{jobid}/savepoints/{triggerid}
Apache Flink Get Jobs Savepoints
getSavepointStatus 2 params → 200
GET
/jobs/{jobid}/status
Apache Flink List Jobs Status
getJobStatusInfo 1 param → 200
POST
/jobs/{jobid}/stop
Apache Flink Create Jobs Stop
triggerStopWithSavepoint 1 param body → 202
GET
/jobs/{jobid}/taskmanagers/{taskmanagerid}/log-url
Apache Flink List Taskmanagers Log-Url
getTaskManagerLogUrl 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}
Apache Flink Get Jobs Vertices
getJobVertexDetails 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/accumulators
Apache Flink List Vertices Accumulators
getJobVertexAccumulators 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/backpressure
Apache Flink List Vertices Backpressure
getJobVertexBackPressure 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/flamegraph
Apache Flink List Vertices Flamegraph
getJobVertexFlameGraph 4 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/jm-operator-metrics
Apache Flink List Vertices Jm-Operator-Metrics
getJobManagerOperatorMetrics 3 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/metrics
Apache Flink List Vertices Metrics
getJobVertexMetrics 3 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/accumulators
Apache Flink List Subtasks Accumulators
getSubtasksAllAccumulators 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/metrics
Apache Flink List Subtasks Metrics
getAggregatedSubtaskMetrics 5 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}
Apache Flink Get Vertices Subtasks
getSubtaskCurrentAttemptDetails 3 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt}
Apache Flink Get Subtasks Attempts
getSubtaskExecutionAttemptDetails 4 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/attempts/{attempt}/accumulators
Apache Flink List Attempts Accumulators
getSubtaskExecutionAttemptAccumulators 4 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasks/{subtaskindex}/metrics
Apache Flink List Subtasks Metrics
getSubtaskMetrics 4 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/subtasktimes
Apache Flink List Vertices Subtasktimes
getSubtasksTimes 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/taskmanagers
Apache Flink List Vertices Taskmanagers
getJobVertexTaskManagers 2 params → 200
GET
/jobs/{jobid}/vertices/{vertexid}/watermarks
Apache Flink List Vertices Watermarks
getJobVertexWatermarks 2 params → 200

Schemas 97

The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are CheckpointStatistics (17 properties), JobDetailsInfo (16 properties), CheckpointConfigInfo (15 properties), TaskCheckpointStatisticsWithSubtaskDetails (13 properties). Each schema is shown below with its type and property counts.

SubtaskTimeInfo
object
4 properties
CompletedCheckpointStatistics
object
JobDetailsVertexInfo
object
11 properties
MultipleJobsDetails
object
1 property
ApplicationStatus
string
ConfigurationInfoEntry
object
2 properties
RestAPICheckpointType
string
JobExecutionResultResponseBody
object
2 properties 1 required
CheckpointAlignmentSummary
object
4 properties
JobType
string
JobVertexID
string
AggregationMode
string
RootExceptionInfo
object
8 properties
StatsSummaryDto
object
8 properties
Id
string
AsynchronousOperationInfo
object
1 property
ThreadStates
string
Parallelism
object
2 properties
AsynchronousOperationResult
object
2 properties
VertexBackPressureStatus
string
Node
object
3 properties
FailedCheckpointStatistics
object
JobVertexDetailsInfo
object
7 properties
CheckpointDurationSummary
object
2 properties
JobResourceRequirementsBody
object
IOMetricsInfo
object
11 properties
TriggerId
string
JobConfigInfo
object
3 properties
AggregatedMetricsResponseBody
object
CheckpointInfo
object
2 properties
JobDetailsInfo
object
16 properties
RestoredCheckpointStatistics
object
4 properties
SavepointFormatType
string
VertexBackPressureLevel
string
LogUrlResponse
object
1 property
SubtaskCheckpointStatistics
object
3 properties 1 required
ExecutionConfigInfo
object
4 properties
CheckpointingStatistics
object
4 properties
SerializedThrowable
object
1 property
JobVertexBackPressureInfo
object
4 properties
JobVertexAccumulatorsInfo
object
2 properties
ExternalizedCheckpointInfo
object
2 properties
JobAccumulatorsInfo
object
3 properties
JobDetails
object
9 properties
FailureLabel
object
2 properties
JobVertexTaskManagerInfo
object
9 properties
SavepointInfo
object
2 properties
JobAccumulator
object
UserTaskAccumulator
object
3 properties
JobIdWithStatus
object
2 properties
ExceptionInfo
object
7 properties
QueueStatus
object
1 property 1 required
Counts
object
5 properties
JobPlanInfo
object
1 property
SubtaskExecutionAttemptDetailsInfo
object
11 properties
TaskCheckpointStatistics
object
11 properties
SlotSharingGroupId
object
3 properties
JobID
string
JobResult
object
6 properties
JobVertexTaskManagersInfo
object
4 properties
CheckpointConfigInfo
object
15 properties
JobVertexResourceRequirements
object
1 property
LatestCheckpoints
object
4 properties
CheckpointType
string
SubtaskAccumulatorsInfo
object
4 properties
SavepointTriggerRequestBody
object
4 properties
ProcessingMode
string
ResourceID
string
SubtasksTimesInfo
object
4 properties
TriggerResponse
object
1 property
JobExceptionHistory
object
2 properties
AggregatedTaskDetailsInfo
object
2 properties
TaskCheckpointStatisticsWithSubtaskDetailsSummary
object
6 properties
JVMInfo
object
3 properties
CheckpointStatsStatus
string
CheckpointStatistics
object
17 properties 1 required
SubtasksAllAccumulatorsInfo
object
3 properties
JobIdsWithStatusOverview
object
1 property
TerminationMode
string
RawJson
object
CheckpointTriggerRequestBody
object
2 properties
JobStatus
string
JobClientHeartbeatRequestBody
object
1 property
JobStatusInfo
object
1 property
VertexFlameGraph
object
2 properties
SerializedValueOptionalFailureObject
object
1 property
TaskCheckpointStatisticsWithSubtaskDetails
object
13 properties
Metric
object
2 properties 1 required
ExecutionState
string
SubtaskExecutionAttemptAccumulatorsInfo
object
4 properties
SubtaskBackPressureInfo
object
7 properties
JobExceptionsInfoWithHistory
object
1 property
MetricCollectionResponseBody
object
1 property
CheckpointStatisticsSummary
object
6 properties
StopWithSavepointRequestBody
object
4 properties
UserAccumulator
object
3 properties
EnvironmentInfo
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apache-flink-jobs-api-openapi.yml Raw ↑

Other APIs Apache Flink publishes across the network.

Apache Flink Monitoring API
AE Profile APIs.io
Apache Flink Cluster API
AE Profile APIs.io
Apache Flink Config API
AE Profile APIs.io
Apache Flink Datasets API
AE Profile APIs.io
Apache Flink Jars API
AE Profile APIs.io
Apache Flink Jobmanager API
AE Profile APIs.io
Apache Flink Overview API
AE Profile APIs.io
Apache Flink Savepoint Disposal API
AE Profile APIs.io
Apache Flink Taskmanagers API
AE Profile APIs.io
#Job
← Back to A APIs
API Details
ID
apache-flink:apache-flink-jobs-api
Base URL
http://localhost:8081
Docs
https://nightlies.apache.org/flink/flink-docs-stable/docs/ops/rest_api/
Provider
Apache Flink
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=apache-flink-jobs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/apache-flink-jobs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Apache Flink Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.