Skip to main content
GET
/
flink_jobs
/
{job_id}
Get Flink Job
curl --request GET \
  --url https://api.streamkap.com/flink_jobs/{job_id} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "name": "<string>",
  "job_type": "pyflink",
  "status": "CREATED",
  "flink_job_name": "<string>",
  "flink_job_id": "<string>",
  "parallelism": 1,
  "created_by": "<string>",
  "created_timestamp": "2023-11-07T05:31:56Z",
  "updated_timestamp": "2023-11-07T05:31:56Z",
  "live_status": "<string>",
  "checkpoints": {},
  "errors": [
    {}
  ],
  "job_args": {},
  "savepoint_path": "<string>",
  "error_message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
job_id
string
required

Response

Successful Response

Extended response with live Flink REST data.

​
_id
string
required
​
name
string
required
​
job_type
enum<string>
required
Available options:
pyflink,
jar
​
status
enum<string>
required
Available options:
CREATED,
DEPLOYING,
RUNNING,
FAILED,
CANCELLED,
FINISHED
​
flink_job_name
string
required
​
flink_job_id
string | null
​
parallelism
integer
default:1
​
created_by
string | null
​
created_timestamp
string<date-time> | null
​
updated_timestamp
string<date-time> | null
​
live_status
string | null

Live status from Flink REST API

​
checkpoints
Checkpoints · object
​
errors
Errors · object[] | null
​
job_args
Job Args · object
​
savepoint_path
string | null
​
error_message
string | null