##### /cluster

Verb: `DELETE` | Response code: `200 OK`
Shuts down the cluster

Request

    {}

Response

    {}

##### /config

Verb: `GET` | Response code: `200 OK`
Returns the configuration of the WebUI.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration",
      "properties" : {
        "features" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration:Features",
          "properties" : {
            "web-cancel" : {
              "type" : "boolean"
            },
            "web-history" : {
              "type" : "boolean"
            },
            "web-rescale" : {
              "type" : "boolean"
            },
            "web-submit" : {
              "type" : "boolean"
            }
          }
        },
        "flink-revision" : {
          "type" : "string"
        },
        "flink-version" : {
          "type" : "string"
        },
        "refresh-interval" : {
          "type" : "integer"
        },
        "timezone-name" : {
          "type" : "string"
        },
        "timezone-offset" : {
          "type" : "integer"
        }
      }
    }

##### /datasets

Verb: `GET` | Response code: `200 OK`
Returns all cluster data sets.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:dataset:ClusterDataSetListResponseBody",
      "properties" : {
        "dataSets" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:dataset:ClusterDataSetEntry",
            "properties" : {
              "id" : {
                "type" : "string"
              },
              "isComplete" : {
                "type" : "boolean"
              }
            }
          }
        }
      }
    }

##### /datasets/delete/:triggerid

Verb: `GET` | Response code: `200 OK`
Returns the status for the delete operation of a cluster data set.
Path parameters

- `triggerid` - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
      "properties" : {
        "operation" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo",
          "properties" : {
            "failure-cause" : {
              "type" : "any"
            }
          }
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /datasets/:datasetid

Verb: `DELETE` | Response code: `202 Accepted`
Triggers the deletion of a cluster data set. This async operation would return a 'triggerid' for further query identifier.
Path parameters

- `datasetid` - 32-character hexadecimal string value that identifies a cluster data set.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /jars

Verb: `GET` | Response code: `200 OK`
Returns a list of all jars previously uploaded via '/jars/upload'.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo",
      "properties" : {
        "address" : {
          "type" : "string"
        },
        "files" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo",
            "properties" : {
              "entry" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo",
                  "properties" : {
                    "description" : {
                      "type" : "string"
                    },
                    "name" : {
                      "type" : "string"
                    }
                  }
                }
              },
              "id" : {
                "type" : "string"
              },
              "name" : {
                "type" : "string"
              },
              "uploaded" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

##### /jars/upload

Verb: `POST` | Response code: `200 OK`
Uploads a jar to the cluster. The jar must be sent as multi-part data. Make sure that the "Content-Type" header is set to "application/x-java-archive", as some http libraries do not add the header by default. Using 'curl' you can upload a jar via 'curl -X POST -H "Expect:" -F "jarfile=@path/to/flink-job.jar" http://hostname:port/jars/upload'.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody",
      "properties" : {
        "filename" : {
          "type" : "string"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "success" ]
        }
      }
    }

##### /jars/:jarid

Verb: `DELETE` | Response code: `200 OK`
Deletes a jar previously uploaded via '/jars/upload'.
Path parameters

- `jarid` - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).

Request

    {}

Response

    {}

##### /jars/:jarid/plan

Verb: `POST` | Response code: `200 OK`
Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters

- `jarid` - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).

Query parameters

- `programArg` (optional): Comma-separated list of program arguments.
- `entry-class` (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
- `parallelism` (optional): Positive integer value that specifies the desired parallelism for the job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody",
      "properties" : {
        "entryClass" : {
          "type" : "string"
        },
        "flinkConfiguration" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "string"
          }
        },
        "jobId" : {
          "type" : "any"
        },
        "parallelism" : {
          "type" : "integer"
        },
        "programArgsList" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
      "properties" : {
        "plan" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan",
          "properties" : {
            "jid" : {
              "type" : "string"
            },
            "name" : {
              "type" : "string"
            },
            "nodes" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node",
                "properties" : {
                  "description" : {
                    "type" : "string"
                  },
                  "id" : {
                    "type" : "string"
                  },
                  "inputs" : {
                    "type" : "array",
                    "items" : {
                      "type" : "object",
                      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node:Input",
                      "properties" : {
                        "caching" : {
                          "type" : "string"
                        },
                        "exchange" : {
                          "type" : "string"
                        },
                        "id" : {
                          "type" : "string"
                        },
                        "local_strategy" : {
                          "type" : "string"
                        },
                        "num" : {
                          "type" : "integer"
                        },
                        "ship_strategy" : {
                          "type" : "string"
                        }
                      }
                    }
                  },
                  "operator" : {
                    "type" : "string"
                  },
                  "operator_strategy" : {
                    "type" : "string"
                  },
                  "optimizer_properties" : {
                    "type" : "object",
                    "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:RawJson"
                  },
                  "parallelism" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "type" : {
              "type" : "string"
            }
          }
        }
      }
    }

##### /jars/:jarid/run

Verb: `POST` | Response code: `200 OK`
Submits a job by running a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.
Path parameters

- `jarid` - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).

Query parameters

- `allowNonRestoredState` (optional): Boolean value that specifies whether the job submission should be rejected if the savepoint contains state that cannot be mapped back to the job.
- `savepointPath` (optional): String value that specifies the path of the savepoint to restore the job from.
- `programArg` (optional): Comma-separated list of program arguments.
- `entry-class` (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.
- `parallelism` (optional): Positive integer value that specifies the desired parallelism for the job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody",
      "properties" : {
        "allowNonRestoredState" : {
          "type" : "boolean"
        },
        "claimMode" : {
          "type" : "string",
          "enum" : [ "CLAIM", "NO_CLAIM", "LEGACY" ]
        },
        "entryClass" : {
          "type" : "string"
        },
        "flinkConfiguration" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "string"
          }
        },
        "jobId" : {
          "type" : "any"
        },
        "parallelism" : {
          "type" : "integer"
        },
        "programArgsList" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "restoreMode" : {
          "type" : "string",
          "enum" : [ "CLAIM", "NO_CLAIM", "LEGACY" ]
        },
        "savepointPath" : {
          "type" : "string"
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody",
      "properties" : {
        "jobid" : {
          "type" : "any"
        }
      }
    }

##### /jobmanager/config

Verb: `GET` | Response code: `200 OK`
Returns the cluster configuration.

Request

    {}

Response

    {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ConfigurationInfoEntry",
        "properties" : {
          "key" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    }

##### /jobmanager/environment

Verb: `GET` | Response code: `200 OK`
Returns the jobmanager environment.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EnvironmentInfo",
      "properties" : {
        "classpath" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "jvm" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EnvironmentInfo:JVMInfo",
          "properties" : {
            "arch" : {
              "type" : "string"
            },
            "options" : {
              "type" : "array",
              "items" : {
                "type" : "string"
              }
            },
            "version" : {
              "type" : "string"
            }
          }
        }
      }
    }

##### /jobmanager/logs

Verb: `GET` | Response code: `200 OK`
Returns the list of log files on the JobManager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogListInfo",
      "properties" : {
        "logs" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogInfo",
            "properties" : {
              "mtime" : {
                "type" : "integer"
              },
              "name" : {
                "type" : "string"
              },
              "size" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

##### /jobmanager/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to job manager metrics.
Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobmanager/thread-dump

Verb: `GET` | Response code: `200 OK`
Returns the thread dump of the JobManager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo",
      "properties" : {
        "threadInfos" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo:ThreadInfo",
            "properties" : {
              "stringifiedThreadInfo" : {
                "type" : "string"
              },
              "threadName" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs

Verb: `GET` | Response code: `200 OK`
Returns an overview over all jobs and their current state.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview",
      "properties" : {
        "jobs" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview:JobIdWithStatus",
            "properties" : {
              "id" : {
                "type" : "any"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "INITIALIZING", "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
              }
            }
          }
        }
      }
    }

##### /jobs/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to aggregated job metrics.
Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.
- `agg` (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".
- `jobs` (optional): Comma-separated list of 32-character hexadecimal strings to select specific jobs.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/overview

Verb: `GET` | Response code: `200 OK`
Returns an overview over all jobs.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:MultipleJobsDetails",
      "properties" : {
        "jobs" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobDetails",
            "properties" : {
              "duration" : {
                "type" : "integer"
              },
              "end-time" : {
                "type" : "integer"
              },
              "jid" : {
                "type" : "any"
              },
              "last-modification" : {
                "type" : "integer"
              },
              "name" : {
                "type" : "string"
              },
              "pending-operators" : {
                "type" : "integer"
              },
              "start-time" : {
                "type" : "integer"
              },
              "state" : {
                "type" : "string",
                "enum" : [ "INITIALIZING", "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
              },
              "tasks" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid

Verb: `GET` | Response code: `200 OK`
Returns details of a job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo",
      "properties" : {
        "duration" : {
          "type" : "integer"
        },
        "end-time" : {
          "type" : "integer"
        },
        "isStoppable" : {
          "type" : "boolean"
        },
        "jid" : {
          "type" : "any"
        },
        "job-type" : {
          "type" : "string",
          "enum" : [ "BATCH", "STREAMING" ]
        },
        "maxParallelism" : {
          "type" : "integer"
        },
        "name" : {
          "type" : "string"
        },
        "now" : {
          "type" : "integer"
        },
        "pending-operators" : {
          "type" : "integer"
        },
        "plan" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan",
          "properties" : {
            "jid" : {
              "type" : "string"
            },
            "name" : {
              "type" : "string"
            },
            "nodes" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node",
                "properties" : {
                  "description" : {
                    "type" : "string"
                  },
                  "id" : {
                    "type" : "string"
                  },
                  "inputs" : {
                    "type" : "array",
                    "items" : {
                      "type" : "object",
                      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node:Input",
                      "properties" : {
                        "caching" : {
                          "type" : "string"
                        },
                        "exchange" : {
                          "type" : "string"
                        },
                        "id" : {
                          "type" : "string"
                        },
                        "local_strategy" : {
                          "type" : "string"
                        },
                        "num" : {
                          "type" : "integer"
                        },
                        "ship_strategy" : {
                          "type" : "string"
                        }
                      }
                    }
                  },
                  "operator" : {
                    "type" : "string"
                  },
                  "operator_strategy" : {
                    "type" : "string"
                  },
                  "optimizer_properties" : {
                    "type" : "object",
                    "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:RawJson"
                  },
                  "parallelism" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "type" : {
              "type" : "string"
            }
          }
        },
        "start-time" : {
          "type" : "integer"
        },
        "state" : {
          "type" : "string",
          "enum" : [ "INITIALIZING", "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
        },
        "status-counts" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "integer"
          }
        },
        "stream-graph" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:RawJson"
        },
        "timestamps" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "integer"
          }
        },
        "vertices" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo",
            "properties" : {
              "duration" : {
                "type" : "integer"
              },
              "end-time" : {
                "type" : "integer"
              },
              "id" : {
                "type" : "any"
              },
              "maxParallelism" : {
                "type" : "integer"
              },
              "metrics" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
                "properties" : {
                  "accumulated-backpressured-time" : {
                    "type" : "integer"
                  },
                  "accumulated-busy-time" : {
                    "type" : "number"
                  },
                  "accumulated-idle-time" : {
                    "type" : "integer"
                  },
                  "read-bytes" : {
                    "type" : "integer"
                  },
                  "read-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "read-records" : {
                    "type" : "integer"
                  },
                  "read-records-complete" : {
                    "type" : "boolean"
                  },
                  "write-bytes" : {
                    "type" : "integer"
                  },
                  "write-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "write-records" : {
                    "type" : "integer"
                  },
                  "write-records-complete" : {
                    "type" : "boolean"
                  }
                }
              },
              "name" : {
                "type" : "string"
              },
              "parallelism" : {
                "type" : "integer"
              },
              "slotSharingGroupId" : {
                "type" : "any"
              },
              "start-time" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING", "INITIALIZING" ]
              },
              "tasks" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid

Verb: `PATCH` | Response code: `202 Accepted`
Terminates a job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Query parameters

- `mode` (optional): String value that specifies the termination mode. The only supported value is: "cancel".

Request

    {}

Response

    {}

##### /jobs/:jobid/accumulators

Verb: `GET` | Response code: `200 OK`
Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Query parameters

- `includeSerializedValue` (optional): Boolean value that specifies whether serialized user task accumulators should be included in the response.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo",
      "properties" : {
        "job-accumulators" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:JobAccumulator"
          }
        },
        "serialized-user-task-accumulators" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "any"
          }
        },
        "user-task-accumulators" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:UserTaskAccumulator",
            "properties" : {
              "name" : {
                "type" : "string"
              },
              "type" : {
                "type" : "string"
              },
              "value" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/checkpoints

Verb: `GET` | Response code: `200 OK`
Returns checkpointing statistics for a job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics",
      "properties" : {
        "counts" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts",
          "properties" : {
            "completed" : {
              "type" : "integer"
            },
            "failed" : {
              "type" : "integer"
            },
            "in_progress" : {
              "type" : "integer"
            },
            "restored" : {
              "type" : "integer"
            },
            "total" : {
              "type" : "integer"
            }
          }
        },
        "history" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
            "properties" : {
              "alignment_buffered" : {
                "type" : "integer"
              },
              "checkpoint_type" : {
                "type" : "string",
                "enum" : [ "CHECKPOINT", "UNALIGNED_CHECKPOINT", "SAVEPOINT", "SYNC_SAVEPOINT" ]
              },
              "checkpointed_size" : {
                "type" : "integer"
              },
              "end_to_end_duration" : {
                "type" : "integer"
              },
              "id" : {
                "type" : "integer"
              },
              "is_savepoint" : {
                "type" : "boolean"
              },
              "latest_ack_timestamp" : {
                "type" : "integer"
              },
              "num_acknowledged_subtasks" : {
                "type" : "integer"
              },
              "num_subtasks" : {
                "type" : "integer"
              },
              "persisted_data" : {
                "type" : "integer"
              },
              "processed_data" : {
                "type" : "integer"
              },
              "savepointFormat" : {
                "type" : "string"
              },
              "state_size" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
              },
              "tasks" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
                }
              },
              "trigger_timestamp" : {
                "type" : "integer"
              }
            }
          }
        },
        "latest" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints",
          "properties" : {
            "completed" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics",
              "properties" : {
                "alignment_buffered" : {
                  "type" : "integer"
                },
                "checkpoint_type" : {
                  "type" : "string",
                  "enum" : [ "CHECKPOINT", "UNALIGNED_CHECKPOINT", "SAVEPOINT", "SYNC_SAVEPOINT" ]
                },
                "checkpointed_size" : {
                  "type" : "integer"
                },
                "discarded" : {
                  "type" : "boolean"
                },
                "end_to_end_duration" : {
                  "type" : "integer"
                },
                "external_path" : {
                  "type" : "string"
                },
                "id" : {
                  "type" : "integer"
                },
                "is_savepoint" : {
                  "type" : "boolean"
                },
                "latest_ack_timestamp" : {
                  "type" : "integer"
                },
                "num_acknowledged_subtasks" : {
                  "type" : "integer"
                },
                "num_subtasks" : {
                  "type" : "integer"
                },
                "persisted_data" : {
                  "type" : "integer"
                },
                "processed_data" : {
                  "type" : "integer"
                },
                "savepointFormat" : {
                  "type" : "string"
                },
                "state_size" : {
                  "type" : "integer"
                },
                "status" : {
                  "type" : "string",
                  "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
                },
                "tasks" : {
                  "type" : "object",
                  "additionalProperties" : {
                    "type" : "object",
                    "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
                    "properties" : {
                      "alignment_buffered" : {
                        "type" : "integer"
                      },
                      "checkpointed_size" : {
                        "type" : "integer"
                      },
                      "end_to_end_duration" : {
                        "type" : "integer"
                      },
                      "id" : {
                        "type" : "integer"
                      },
                      "latest_ack_timestamp" : {
                        "type" : "integer"
                      },
                      "num_acknowledged_subtasks" : {
                        "type" : "integer"
                      },
                      "num_subtasks" : {
                        "type" : "integer"
                      },
                      "persisted_data" : {
                        "type" : "integer"
                      },
                      "processed_data" : {
                        "type" : "integer"
                      },
                      "state_size" : {
                        "type" : "integer"
                      },
                      "status" : {
                        "type" : "string",
                        "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
                      }
                    }
                  }
                },
                "trigger_timestamp" : {
                  "type" : "integer"
                }
              }
            },
            "failed" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics",
              "properties" : {
                "alignment_buffered" : {
                  "type" : "integer"
                },
                "checkpoint_type" : {
                  "type" : "string",
                  "enum" : [ "CHECKPOINT", "UNALIGNED_CHECKPOINT", "SAVEPOINT", "SYNC_SAVEPOINT" ]
                },
                "checkpointed_size" : {
                  "type" : "integer"
                },
                "end_to_end_duration" : {
                  "type" : "integer"
                },
                "failure_message" : {
                  "type" : "string"
                },
                "failure_timestamp" : {
                  "type" : "integer"
                },
                "id" : {
                  "type" : "integer"
                },
                "is_savepoint" : {
                  "type" : "boolean"
                },
                "latest_ack_timestamp" : {
                  "type" : "integer"
                },
                "num_acknowledged_subtasks" : {
                  "type" : "integer"
                },
                "num_subtasks" : {
                  "type" : "integer"
                },
                "persisted_data" : {
                  "type" : "integer"
                },
                "processed_data" : {
                  "type" : "integer"
                },
                "savepointFormat" : {
                  "type" : "string"
                },
                "state_size" : {
                  "type" : "integer"
                },
                "status" : {
                  "type" : "string",
                  "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
                },
                "tasks" : {
                  "type" : "object",
                  "additionalProperties" : {
                    "type" : "object",
                    "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
                  }
                },
                "trigger_timestamp" : {
                  "type" : "integer"
                }
              }
            },
            "restored" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics",
              "properties" : {
                "external_path" : {
                  "type" : "string"
                },
                "id" : {
                  "type" : "integer"
                },
                "is_savepoint" : {
                  "type" : "boolean"
                },
                "restore_timestamp" : {
                  "type" : "integer"
                }
              }
            },
            "savepoint" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics"
            }
          }
        },
        "summary" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary",
          "properties" : {
            "alignment_buffered" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "checkpointed_size" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto",
              "properties" : {
                "avg" : {
                  "type" : "integer"
                },
                "max" : {
                  "type" : "integer"
                },
                "min" : {
                  "type" : "integer"
                },
                "p50" : {
                  "type" : "number"
                },
                "p90" : {
                  "type" : "number"
                },
                "p95" : {
                  "type" : "number"
                },
                "p99" : {
                  "type" : "number"
                },
                "p999" : {
                  "type" : "number"
                }
              }
            },
            "end_to_end_duration" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "persisted_data" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "processed_data" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "state_size" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            }
          }
        }
      }
    }

##### /jobs/:jobid/checkpoints

Verb: `POST` | Response code: `202 Accepted`
Triggers a checkpoint. The 'checkpointType' parameter does not support 'INCREMENTAL' option for now. See FLINK-33723. This async operation would return a 'triggerid' for further query identifier.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointTriggerRequestBody",
      "properties" : {
        "checkpointType" : {
          "type" : "string",
          "enum" : [ "CONFIGURED", "FULL", "INCREMENTAL" ]
        },
        "triggerId" : {
          "type" : "any"
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /jobs/:jobid/checkpoints/config

Verb: `GET` | Response code: `200 OK`
Returns the checkpointing configuration.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo",
      "properties" : {
        "aligned_checkpoint_timeout" : {
          "type" : "integer"
        },
        "changelog_periodic_materialization_interval" : {
          "type" : "integer"
        },
        "changelog_storage" : {
          "type" : "string"
        },
        "checkpoint_storage" : {
          "type" : "string"
        },
        "checkpoints_after_tasks_finish" : {
          "type" : "boolean"
        },
        "externalization" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo",
          "properties" : {
            "delete_on_cancellation" : {
              "type" : "boolean"
            },
            "enabled" : {
              "type" : "boolean"
            }
          }
        },
        "interval" : {
          "type" : "integer"
        },
        "max_concurrent" : {
          "type" : "integer"
        },
        "min_pause" : {
          "type" : "integer"
        },
        "mode" : {
          "type" : "any"
        },
        "state_backend" : {
          "type" : "string"
        },
        "state_changelog_enabled" : {
          "type" : "boolean"
        },
        "timeout" : {
          "type" : "integer"
        },
        "tolerable_failed_checkpoints" : {
          "type" : "integer"
        },
        "unaligned_checkpoints" : {
          "type" : "boolean"
        }
      }
    }

##### /jobs/:jobid/checkpoints/details/:checkpointid

Verb: `GET` | Response code: `200 OK`
Returns details for a checkpoint.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `checkpointid` - Long value that identifies a checkpoint.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
      "properties" : {
        "alignment_buffered" : {
          "type" : "integer"
        },
        "checkpoint_type" : {
          "type" : "string",
          "enum" : [ "CHECKPOINT", "UNALIGNED_CHECKPOINT", "SAVEPOINT", "SYNC_SAVEPOINT" ]
        },
        "checkpointed_size" : {
          "type" : "integer"
        },
        "end_to_end_duration" : {
          "type" : "integer"
        },
        "id" : {
          "type" : "integer"
        },
        "is_savepoint" : {
          "type" : "boolean"
        },
        "latest_ack_timestamp" : {
          "type" : "integer"
        },
        "num_acknowledged_subtasks" : {
          "type" : "integer"
        },
        "num_subtasks" : {
          "type" : "integer"
        },
        "persisted_data" : {
          "type" : "integer"
        },
        "processed_data" : {
          "type" : "integer"
        },
        "savepointFormat" : {
          "type" : "string"
        },
        "state_size" : {
          "type" : "integer"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
        },
        "tasks" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
            "properties" : {
              "alignment_buffered" : {
                "type" : "integer"
              },
              "checkpointed_size" : {
                "type" : "integer"
              },
              "end_to_end_duration" : {
                "type" : "integer"
              },
              "id" : {
                "type" : "integer"
              },
              "latest_ack_timestamp" : {
                "type" : "integer"
              },
              "num_acknowledged_subtasks" : {
                "type" : "integer"
              },
              "num_subtasks" : {
                "type" : "integer"
              },
              "persisted_data" : {
                "type" : "integer"
              },
              "processed_data" : {
                "type" : "integer"
              },
              "state_size" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
              }
            }
          }
        },
        "trigger_timestamp" : {
          "type" : "integer"
        }
      }
    }

##### /jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid

Verb: `GET` | Response code: `200 OK`
Returns checkpoint statistics for a task and its subtasks.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `checkpointid` - Long value that identifies a checkpoint.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails",
      "properties" : {
        "alignment_buffered" : {
          "type" : "integer"
        },
        "checkpointed_size" : {
          "type" : "integer"
        },
        "end_to_end_duration" : {
          "type" : "integer"
        },
        "id" : {
          "type" : "integer"
        },
        "latest_ack_timestamp" : {
          "type" : "integer"
        },
        "num_acknowledged_subtasks" : {
          "type" : "integer"
        },
        "num_subtasks" : {
          "type" : "integer"
        },
        "persisted_data" : {
          "type" : "integer"
        },
        "processed_data" : {
          "type" : "integer"
        },
        "state_size" : {
          "type" : "integer"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
        },
        "subtasks" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics",
            "properties" : {
              "index" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string"
              }
            }
          }
        },
        "summary" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary",
          "properties" : {
            "alignment" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment",
              "properties" : {
                "buffered" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                },
                "duration" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                },
                "persisted" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                },
                "processed" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                }
              }
            },
            "checkpoint_duration" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration",
              "properties" : {
                "async" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                },
                "sync" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
                }
              }
            },
            "checkpointed_size" : {
              "type" : "object",
              "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto",
              "properties" : {
                "avg" : {
                  "type" : "integer"
                },
                "max" : {
                  "type" : "integer"
                },
                "min" : {
                  "type" : "integer"
                },
                "p50" : {
                  "type" : "number"
                },
                "p90" : {
                  "type" : "number"
                },
                "p95" : {
                  "type" : "number"
                },
                "p99" : {
                  "type" : "number"
                },
                "p999" : {
                  "type" : "number"
                }
              }
            },
            "end_to_end_duration" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "start_delay" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            },
            "state_size" : {
              "type" : "object",
              "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:StatsSummaryDto"
            }
          }
        }
      }
    }

##### /jobs/:jobid/checkpoints/:triggerid

Verb: `GET` | Response code: `200 OK`
Returns the status of a checkpoint trigger operation.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `triggerid` - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
      "properties" : {
        "operation" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointInfo",
          "properties" : {
            "checkpointId" : {
              "type" : "integer"
            },
            "failureCause" : {
              "type" : "any"
            }
          }
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /jobs/:jobid/clientHeartbeat

Verb: `PATCH` | Response code: `202 Accepted`
Report the jobClient's aliveness.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobClientHeartbeatRequestBody",
      "properties" : {
        "expiredTimestamp" : {
          "type" : "integer"
        }
      }
    }

Response

    {}

##### /jobs/:jobid/config

Verb: `GET` | Response code: `200 OK`
Returns the configuration of a job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/exceptions

Verb: `GET` | Response code: `200 OK`

Returns the most recent exceptions that have been handled by Flink for this job. The 'exceptionHistory.truncated' flag defines whether exceptions were filtered out through the GET parameter. The backend collects only a specific amount of most recent exceptions per job. This can be configured through web.exception-history-size in the Flink configuration. The following first-level members are deprecated: 'root-exception', 'timestamp', 'all-exceptions', and 'truncated'. Use the data provided through 'exceptionHistory', instead.

Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Query parameters

- `maxExceptions` (optional): Comma-separated list of integer values that specifies the upper limit of exceptions to return.
- `failureLabelFilter` (optional): Collection of string values working as a filter in the form of `key:value` pairs allowing only exceptions with ALL of the specified failure labels to be returned.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfoWithHistory",
      "properties" : {
        "exceptionHistory" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfoWithHistory:JobExceptionHistory",
          "properties" : {
            "entries" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfoWithHistory:RootExceptionInfo",
                "properties" : {
                  "concurrentExceptions" : {
                    "type" : "array",
                    "items" : {
                      "type" : "object",
                      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfoWithHistory:ExceptionInfo",
                      "properties" : {
                        "endpoint" : {
                          "type" : "string"
                        },
                        "exceptionName" : {
                          "type" : "string"
                        },
                        "failureLabels" : {
                          "type" : "object",
                          "additionalProperties" : {
                            "type" : "string"
                          }
                        },
                        "stacktrace" : {
                          "type" : "string"
                        },
                        "taskManagerId" : {
                          "type" : "string"
                        },
                        "taskName" : {
                          "type" : "string"
                        },
                        "timestamp" : {
                          "type" : "integer"
                        }
                      }
                    }
                  },
                  "endpoint" : {
                    "type" : "string"
                  },
                  "exceptionName" : {
                    "type" : "string"
                  },
                  "failureLabels" : {
                    "type" : "object",
                    "additionalProperties" : {
                      "type" : "string"
                    }
                  },
                  "stacktrace" : {
                    "type" : "string"
                  },
                  "taskManagerId" : {
                    "type" : "string"
                  },
                  "taskName" : {
                    "type" : "string"
                  },
                  "timestamp" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "truncated" : {
              "type" : "boolean"
            }
          }
        }
      }
    }

##### /jobs/:jobid/execution-result

Verb: `GET` | Response code: `200 OK`
Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody",
      "properties" : {
        "job-execution-result" : {
          "type" : "any"
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "required" : true,
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /jobs/:jobid/jobmanager/config

Verb: `GET` | Response code: `200 OK`
Returns the jobmanager's configuration of a specific job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "array",
      "items" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ConfigurationInfoEntry",
        "properties" : {
          "key" : {
            "type" : "string"
          },
          "value" : {
            "type" : "string"
          }
        }
      }
    }

##### /jobs/:jobid/jobmanager/environment

Verb: `GET` | Response code: `200 OK`
Returns the jobmanager's environment of a specific job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EnvironmentInfo",
      "properties" : {
        "classpath" : {
          "type" : "array",
          "items" : {
            "type" : "string"
          }
        },
        "jvm" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:EnvironmentInfo:JVMInfo",
          "properties" : {
            "arch" : {
              "type" : "string"
            },
            "options" : {
              "type" : "array",
              "items" : {
                "type" : "string"
              }
            },
            "version" : {
              "type" : "string"
            }
          }
        }
      }
    }

##### /jobs/:jobid/jobmanager/log-url

Verb: `GET` | Response code: `200 OK`
Returns the log url of jobmanager of a specific job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogUrlResponse",
      "properties" : {
        "url" : {
          "type" : "string"
        }
      }
    }

##### /jobs/:jobid/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to job metrics.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/plan

Verb: `GET` | Response code: `200 OK`
Returns the dataflow plan of a job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
      "properties" : {
        "plan" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan",
          "properties" : {
            "jid" : {
              "type" : "string"
            },
            "name" : {
              "type" : "string"
            },
            "nodes" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node",
                "properties" : {
                  "description" : {
                    "type" : "string"
                  },
                  "id" : {
                    "type" : "string"
                  },
                  "inputs" : {
                    "type" : "array",
                    "items" : {
                      "type" : "object",
                      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:Plan:Node:Input",
                      "properties" : {
                        "caching" : {
                          "type" : "string"
                        },
                        "exchange" : {
                          "type" : "string"
                        },
                        "id" : {
                          "type" : "string"
                        },
                        "local_strategy" : {
                          "type" : "string"
                        },
                        "num" : {
                          "type" : "integer"
                        },
                        "ship_strategy" : {
                          "type" : "string"
                        }
                      }
                    }
                  },
                  "operator" : {
                    "type" : "string"
                  },
                  "operator_strategy" : {
                    "type" : "string"
                  },
                  "optimizer_properties" : {
                    "type" : "object",
                    "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo:RawJson"
                  },
                  "parallelism" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "type" : {
              "type" : "string"
            }
          }
        }
      }
    }

##### /jobs/:jobid/rescaling

Verb: `PATCH` | Response code: `200 OK`
Triggers the rescaling of a job. This async operation would return a 'triggerid' for further query identifier.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Query parameters

- `parallelism` (mandatory): Positive integer value that specifies the desired parallelism.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /jobs/:jobid/rescaling/:triggerid

Verb: `GET` | Response code: `200 OK`
Returns the status of a rescaling operation.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `triggerid` - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
      "properties" : {
        "operation" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo",
          "properties" : {
            "failure-cause" : {
              "type" : "any"
            }
          }
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /jobs/:jobid/resource-requirements

Verb: `GET` | Response code: `200 OK`
Request details on the job's resource requirements.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobResourceRequirementsBody",
      "additionalProperties" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:jobgraph:JobVertexResourceRequirements",
        "properties" : {
          "parallelism" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:jobgraph:JobVertexResourceRequirements:Parallelism",
            "properties" : {
              "lowerBound" : {
                "type" : "integer"
              },
              "upperBound" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/resource-requirements

Verb: `PUT` | Response code: `200 OK`
Request to update job's resource requirements.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobResourceRequirementsBody",
      "additionalProperties" : {
        "type" : "object",
        "id" : "urn:jsonschema:org:apache:flink:runtime:jobgraph:JobVertexResourceRequirements",
        "properties" : {
          "parallelism" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:jobgraph:JobVertexResourceRequirements:Parallelism",
            "properties" : {
              "lowerBound" : {
                "type" : "integer"
              },
              "upperBound" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

Response

    {}

##### /jobs/:jobid/savepoints

Verb: `POST` | Response code: `202 Accepted`
Triggers a savepoint, and optionally cancels the job afterwards. This async operation would return a 'triggerid' for further query identifier.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody",
      "properties" : {
        "cancel-job" : {
          "type" : "boolean"
        },
        "formatType" : {
          "type" : "string",
          "enum" : [ "CANONICAL", "NATIVE" ]
        },
        "target-directory" : {
          "type" : "string"
        },
        "triggerId" : {
          "type" : "any"
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /jobs/:jobid/savepoints/:triggerid

Verb: `GET` | Response code: `200 OK`
Returns the status of a savepoint operation.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `triggerid` - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
      "properties" : {
        "operation" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointInfo",
          "properties" : {
            "failure-cause" : {
              "type" : "any"
            },
            "location" : {
              "type" : "string"
            }
          }
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /jobs/:jobid/status

Verb: `GET` | Response code: `200 OK`
Returns the current status of a job execution.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobStatusInfo",
      "properties" : {
        "status" : {
          "type" : "string",
          "enum" : [ "INITIALIZING", "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
        }
      }
    }

##### /jobs/:jobid/stop

Verb: `POST` | Response code: `202 Accepted`
Stops a job with a savepoint. Optionally, it can also emit a MAX_WATERMARK before taking the savepoint to flush out any state waiting for timers to fire. This async operation would return a 'triggerid' for further query identifier.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:stop:StopWithSavepointRequestBody",
      "properties" : {
        "drain" : {
          "type" : "boolean"
        },
        "formatType" : {
          "type" : "string",
          "enum" : [ "CANONICAL", "NATIVE" ]
        },
        "targetDirectory" : {
          "type" : "string"
        },
        "triggerId" : {
          "type" : "any"
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /jobs/:jobid/taskmanagers/:taskmanagerid/log-url

Verb: `GET` | Response code: `200 OK`
Returns the log url of jobmanager of a specific job.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `taskmanagerid` - 32-character hexadecimal string that identifies a task manager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogUrlResponse",
      "properties" : {
        "url" : {
          "type" : "string"
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid

Verb: `GET` | Response code: `200 OK`
Returns details for a task, with a summary for each of its subtasks.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo",
      "properties" : {
        "aggregated" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:AggregatedTaskDetailsInfo",
          "properties" : {
            "metrics" : {
              "type" : "object",
              "additionalProperties" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              }
            },
            "status-duration" : {
              "type" : "object",
              "additionalProperties" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              }
            }
          }
        },
        "id" : {
          "type" : "any"
        },
        "maxParallelism" : {
          "type" : "integer"
        },
        "name" : {
          "type" : "string"
        },
        "now" : {
          "type" : "integer"
        },
        "parallelism" : {
          "type" : "integer"
        },
        "subtasks" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
            "properties" : {
              "attempt" : {
                "type" : "integer"
              },
              "duration" : {
                "type" : "integer"
              },
              "end-time" : {
                "type" : "integer"
              },
              "endpoint" : {
                "type" : "string"
              },
              "metrics" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
                "properties" : {
                  "accumulated-backpressured-time" : {
                    "type" : "integer"
                  },
                  "accumulated-busy-time" : {
                    "type" : "number"
                  },
                  "accumulated-idle-time" : {
                    "type" : "integer"
                  },
                  "read-bytes" : {
                    "type" : "integer"
                  },
                  "read-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "read-records" : {
                    "type" : "integer"
                  },
                  "read-records-complete" : {
                    "type" : "boolean"
                  },
                  "write-bytes" : {
                    "type" : "integer"
                  },
                  "write-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "write-records" : {
                    "type" : "integer"
                  },
                  "write-records-complete" : {
                    "type" : "boolean"
                  }
                }
              },
              "other-concurrent-attempts" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo"
                }
              },
              "start-time" : {
                "type" : "integer"
              },
              "start_time" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING", "INITIALIZING" ]
              },
              "status-duration" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              },
              "subtask" : {
                "type" : "integer"
              },
              "taskmanager-id" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/accumulators

Verb: `GET` | Response code: `200 OK`
Returns user-defined accumulators of a task, aggregated across all subtasks.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexAccumulatorsInfo",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "user-accumulators" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
            "properties" : {
              "name" : {
                "type" : "string"
              },
              "type" : {
                "type" : "string"
              },
              "value" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/backpressure

Verb: `GET` | Response code: `200 OK`
Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo",
      "properties" : {
        "backpressure-level" : {
          "type" : "string",
          "enum" : [ "ok", "low", "high" ]
        },
        "backpressureLevel" : {
          "type" : "string",
          "enum" : [ "ok", "low", "high" ]
        },
        "end-timestamp" : {
          "type" : "integer"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "deprecated", "ok" ]
        },
        "subtasks" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo",
            "properties" : {
              "attempt-number" : {
                "type" : "integer"
              },
              "backpressure-level" : {
                "type" : "string",
                "enum" : [ "ok", "low", "high" ]
              },
              "backpressureLevel" : {
                "type" : "string",
                "enum" : [ "ok", "low", "high" ]
              },
              "busyRatio" : {
                "type" : "number"
              },
              "idleRatio" : {
                "type" : "number"
              },
              "other-concurrent-attempts" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo"
                }
              },
              "ratio" : {
                "type" : "number"
              },
              "subtask" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/flamegraph

Verb: `GET` | Response code: `200 OK`
Returns flame graph information for a vertex, and may initiate flame graph sampling if necessary.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Query parameters

- `type` (optional): String value that specifies the Flame Graph type. Supported options are: "[FULL, ON_CPU, OFF_CPU]".
- `subtaskindex` (optional): Positive integer value that identifies a subtask.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:threadinfo:VertexFlameGraph",
      "properties" : {
        "data" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:threadinfo:VertexFlameGraph:Node",
          "properties" : {
            "children" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "$ref" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:threadinfo:VertexFlameGraph:Node"
              }
            },
            "name" : {
              "type" : "string"
            },
            "value" : {
              "type" : "integer"
            }
          }
        },
        "endTimestamp" : {
          "type" : "integer"
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/jm-operator-metrics

Verb: `GET` | Response code: `200 OK`
Provides access to jobmanager operator metrics. This is an operator that executes on the jobmanager and the coordinator for FLIP 27 sources is one example of such an operator.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/vertices/:vertexid/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to task metrics.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/accumulators

Verb: `GET` | Response code: `200 OK`
Returns all user-defined accumulators for all subtasks of a task.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo",
      "properties" : {
        "id" : {
          "type" : "any"
        },
        "parallelism" : {
          "type" : "integer"
        },
        "subtasks" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo",
            "properties" : {
              "attempt" : {
                "type" : "integer"
              },
              "endpoint" : {
                "type" : "string"
              },
              "subtask" : {
                "type" : "integer"
              },
              "user-accumulators" : {
                "type" : "array",
                "items" : {
                  "type" : "object",
                  "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
                  "properties" : {
                    "name" : {
                      "type" : "string"
                    },
                    "type" : {
                      "type" : "string"
                    },
                    "value" : {
                      "type" : "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to aggregated subtask metrics.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.
- `agg` (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".
- `subtasks` (optional): Comma-separated list of integer ranges (e.g. "1,3,5-9") to select specific subtasks.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex

Verb: `GET` | Response code: `200 OK`
Returns details of the current or latest execution attempt of a subtask.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.
- `subtaskindex` - Positive integer value that identifies a subtask.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
      "properties" : {
        "attempt" : {
          "type" : "integer"
        },
        "duration" : {
          "type" : "integer"
        },
        "end-time" : {
          "type" : "integer"
        },
        "endpoint" : {
          "type" : "string"
        },
        "metrics" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
          "properties" : {
            "accumulated-backpressured-time" : {
              "type" : "integer"
            },
            "accumulated-busy-time" : {
              "type" : "number"
            },
            "accumulated-idle-time" : {
              "type" : "integer"
            },
            "read-bytes" : {
              "type" : "integer"
            },
            "read-bytes-complete" : {
              "type" : "boolean"
            },
            "read-records" : {
              "type" : "integer"
            },
            "read-records-complete" : {
              "type" : "boolean"
            },
            "write-bytes" : {
              "type" : "integer"
            },
            "write-bytes-complete" : {
              "type" : "boolean"
            },
            "write-records" : {
              "type" : "integer"
            },
            "write-records-complete" : {
              "type" : "boolean"
            }
          }
        },
        "other-concurrent-attempts" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo"
          }
        },
        "start-time" : {
          "type" : "integer"
        },
        "start_time" : {
          "type" : "integer"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING", "INITIALIZING" ]
        },
        "status-duration" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "integer"
          }
        },
        "subtask" : {
          "type" : "integer"
        },
        "taskmanager-id" : {
          "type" : "string"
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt

Verb: `GET` | Response code: `200 OK`
Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.
- `subtaskindex` - Positive integer value that identifies a subtask.
- `attempt` - Positive integer value that identifies an execution attempt.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
      "properties" : {
        "attempt" : {
          "type" : "integer"
        },
        "duration" : {
          "type" : "integer"
        },
        "end-time" : {
          "type" : "integer"
        },
        "endpoint" : {
          "type" : "string"
        },
        "metrics" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
          "properties" : {
            "accumulated-backpressured-time" : {
              "type" : "integer"
            },
            "accumulated-busy-time" : {
              "type" : "number"
            },
            "accumulated-idle-time" : {
              "type" : "integer"
            },
            "read-bytes" : {
              "type" : "integer"
            },
            "read-bytes-complete" : {
              "type" : "boolean"
            },
            "read-records" : {
              "type" : "integer"
            },
            "read-records-complete" : {
              "type" : "boolean"
            },
            "write-bytes" : {
              "type" : "integer"
            },
            "write-bytes-complete" : {
              "type" : "boolean"
            },
            "write-records" : {
              "type" : "integer"
            },
            "write-records-complete" : {
              "type" : "boolean"
            }
          }
        },
        "other-concurrent-attempts" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo"
          }
        },
        "start-time" : {
          "type" : "integer"
        },
        "start_time" : {
          "type" : "integer"
        },
        "status" : {
          "type" : "string",
          "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING", "INITIALIZING" ]
        },
        "status-duration" : {
          "type" : "object",
          "additionalProperties" : {
            "type" : "integer"
          }
        },
        "subtask" : {
          "type" : "integer"
        },
        "taskmanager-id" : {
          "type" : "string"
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators

Verb: `GET` | Response code: `200 OK`
Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.
- `subtaskindex` - Positive integer value that identifies a subtask.
- `attempt` - Positive integer value that identifies an execution attempt.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo",
      "properties" : {
        "attempt" : {
          "type" : "integer"
        },
        "id" : {
          "type" : "string"
        },
        "subtask" : {
          "type" : "integer"
        },
        "user-accumulators" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
            "properties" : {
              "name" : {
                "type" : "string"
              },
              "type" : {
                "type" : "string"
              },
              "value" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to subtask metrics.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.
- `subtaskindex` - Positive integer value that identifies a subtask.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /jobs/:jobid/vertices/:vertexid/subtasktimes

Verb: `GET` | Response code: `200 OK`
Returns time-related information for all subtasks of a task.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo",
      "properties" : {
        "id" : {
          "type" : "string"
        },
        "name" : {
          "type" : "string"
        },
        "now" : {
          "type" : "integer"
        },
        "subtasks" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo",
            "properties" : {
              "duration" : {
                "type" : "integer"
              },
              "endpoint" : {
                "type" : "string"
              },
              "subtask" : {
                "type" : "integer"
              },
              "timestamps" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/taskmanagers

Verb: `GET` | Response code: `200 OK`
Returns task information aggregated by task manager.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo",
      "properties" : {
        "id" : {
          "type" : "any"
        },
        "name" : {
          "type" : "string"
        },
        "now" : {
          "type" : "integer"
        },
        "taskmanagers" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo",
            "properties" : {
              "aggregated" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:AggregatedTaskDetailsInfo",
                "properties" : {
                  "metrics" : {
                    "type" : "object",
                    "additionalProperties" : {
                      "type" : "object",
                      "additionalProperties" : {
                        "type" : "integer"
                      }
                    }
                  },
                  "status-duration" : {
                    "type" : "object",
                    "additionalProperties" : {
                      "type" : "object",
                      "additionalProperties" : {
                        "type" : "integer"
                      }
                    }
                  }
                }
              },
              "duration" : {
                "type" : "integer"
              },
              "end-time" : {
                "type" : "integer"
              },
              "endpoint" : {
                "type" : "string"
              },
              "metrics" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
                "properties" : {
                  "accumulated-backpressured-time" : {
                    "type" : "integer"
                  },
                  "accumulated-busy-time" : {
                    "type" : "number"
                  },
                  "accumulated-idle-time" : {
                    "type" : "integer"
                  },
                  "read-bytes" : {
                    "type" : "integer"
                  },
                  "read-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "read-records" : {
                    "type" : "integer"
                  },
                  "read-records-complete" : {
                    "type" : "boolean"
                  },
                  "write-bytes" : {
                    "type" : "integer"
                  },
                  "write-bytes-complete" : {
                    "type" : "boolean"
                  },
                  "write-records" : {
                    "type" : "integer"
                  },
                  "write-records-complete" : {
                    "type" : "boolean"
                  }
                }
              },
              "start-time" : {
                "type" : "integer"
              },
              "status" : {
                "type" : "string",
                "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING", "INITIALIZING" ]
              },
              "status-counts" : {
                "type" : "object",
                "additionalProperties" : {
                  "type" : "integer"
                }
              },
              "taskmanager-id" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }

##### /jobs/:jobid/vertices/:vertexid/watermarks

Verb: `GET` | Response code: `200 OK`
Returns the watermarks for all subtasks of a task.
Path parameters

- `jobid` - 32-character hexadecimal string value that identifies a job.
- `vertexid` - 32-character hexadecimal string value that identifies a job vertex.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /overview

Verb: `GET` | Response code: `200 OK`
Returns an overview over the Flink cluster.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion",
      "properties" : {
        "flink-commit" : {
          "type" : "string"
        },
        "flink-version" : {
          "type" : "string"
        },
        "jobs-cancelled" : {
          "type" : "integer"
        },
        "jobs-failed" : {
          "type" : "integer"
        },
        "jobs-finished" : {
          "type" : "integer"
        },
        "jobs-running" : {
          "type" : "integer"
        },
        "slots-available" : {
          "type" : "integer"
        },
        "slots-free-and-blocked" : {
          "type" : "integer"
        },
        "slots-total" : {
          "type" : "integer"
        },
        "taskmanagers" : {
          "type" : "integer"
        },
        "taskmanagers-blocked" : {
          "type" : "integer"
        }
      }
    }

##### /savepoint-disposal

Verb: `POST` | Response code: `200 OK`
Triggers the desposal of a savepoint. This async operation would return a 'triggerid' for further query identifier.

Request

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointDisposalRequest",
      "properties" : {
        "savepoint-path" : {
          "type" : "string"
        }
      }
    }

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
      "properties" : {
        "request-id" : {
          "type" : "any"
        }
      }
    }

##### /savepoint-disposal/:triggerid

Verb: `GET` | Response code: `200 OK`
Returns the status of a savepoint disposal operation.
Path parameters

- `triggerid` - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
      "properties" : {
        "operation" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationInfo",
          "properties" : {
            "failure-cause" : {
              "type" : "any"
            }
          }
        },
        "status" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
          "properties" : {
            "id" : {
              "type" : "string",
              "required" : true,
              "enum" : [ "IN_PROGRESS", "COMPLETED" ]
            }
          }
        }
      }
    }

##### /taskmanagers

Verb: `GET` | Response code: `200 OK`
Returns an overview over all task managers.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
      "properties" : {
        "taskmanagers" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
            "properties" : {
              "blocked" : {
                "type" : "boolean"
              },
              "dataPort" : {
                "type" : "integer"
              },
              "freeResource" : {
                "type" : "object",
                "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
              },
              "freeSlots" : {
                "type" : "integer"
              },
              "hardware" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
                "properties" : {
                  "cpuCores" : {
                    "type" : "integer"
                  },
                  "freeMemory" : {
                    "type" : "integer"
                  },
                  "managedMemory" : {
                    "type" : "integer"
                  },
                  "physicalMemory" : {
                    "type" : "integer"
                  }
                }
              },
              "id" : {
                "type" : "any"
              },
              "jmxPort" : {
                "type" : "integer"
              },
              "memoryConfiguration" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:taskexecutor:TaskExecutorMemoryConfiguration",
                "properties" : {
                  "frameworkHeap" : {
                    "type" : "integer"
                  },
                  "frameworkOffHeap" : {
                    "type" : "integer"
                  },
                  "jvmMetaspace" : {
                    "type" : "integer"
                  },
                  "jvmOverhead" : {
                    "type" : "integer"
                  },
                  "managedMemory" : {
                    "type" : "integer"
                  },
                  "networkMemory" : {
                    "type" : "integer"
                  },
                  "taskHeap" : {
                    "type" : "integer"
                  },
                  "taskOffHeap" : {
                    "type" : "integer"
                  },
                  "totalFlinkMemory" : {
                    "type" : "integer"
                  },
                  "totalProcessMemory" : {
                    "type" : "integer"
                  }
                }
              },
              "path" : {
                "type" : "string"
              },
              "slotsNumber" : {
                "type" : "integer"
              },
              "timeSinceLastHeartbeat" : {
                "type" : "integer"
              },
              "totalResource" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo",
                "properties" : {
                  "cpuCores" : {
                    "type" : "number"
                  },
                  "extendedResources" : {
                    "type" : "object",
                    "additionalProperties" : {
                      "type" : "number"
                    }
                  },
                  "managedMemory" : {
                    "type" : "integer"
                  },
                  "networkMemory" : {
                    "type" : "integer"
                  },
                  "taskHeapMemory" : {
                    "type" : "integer"
                  },
                  "taskOffHeapMemory" : {
                    "type" : "integer"
                  }
                }
              }
            }
          }
        }
      }
    }

##### /taskmanagers/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to aggregated task manager metrics.
Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.
- `agg` (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg, skew".
- `taskmanagers` (optional): Comma-separated list of 32-character hexadecimal strings to select specific task managers.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /taskmanagers/:taskmanagerid

Verb: `GET` | Response code: `200 OK`
Returns details for a task manager.
Path parameters

- `taskmanagerid` - 32-character hexadecimal string that identifies a task manager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo",
      "properties" : {
        "allocatedSlots" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:SlotInfo",
            "properties" : {
              "jobId" : {
                "type" : "any"
              },
              "resource" : {
                "type" : "object",
                "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
              }
            }
          }
        },
        "blocked" : {
          "type" : "boolean"
        },
        "dataPort" : {
          "type" : "integer"
        },
        "freeResource" : {
          "type" : "object",
          "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
        },
        "freeSlots" : {
          "type" : "integer"
        },
        "hardware" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
          "properties" : {
            "cpuCores" : {
              "type" : "integer"
            },
            "freeMemory" : {
              "type" : "integer"
            },
            "managedMemory" : {
              "type" : "integer"
            },
            "physicalMemory" : {
              "type" : "integer"
            }
          }
        },
        "id" : {
          "type" : "any"
        },
        "jmxPort" : {
          "type" : "integer"
        },
        "memoryConfiguration" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:taskexecutor:TaskExecutorMemoryConfiguration",
          "properties" : {
            "frameworkHeap" : {
              "type" : "integer"
            },
            "frameworkOffHeap" : {
              "type" : "integer"
            },
            "jvmMetaspace" : {
              "type" : "integer"
            },
            "jvmOverhead" : {
              "type" : "integer"
            },
            "managedMemory" : {
              "type" : "integer"
            },
            "networkMemory" : {
              "type" : "integer"
            },
            "taskHeap" : {
              "type" : "integer"
            },
            "taskOffHeap" : {
              "type" : "integer"
            },
            "totalFlinkMemory" : {
              "type" : "integer"
            },
            "totalProcessMemory" : {
              "type" : "integer"
            }
          }
        },
        "metrics" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo",
          "properties" : {
            "directCount" : {
              "type" : "integer"
            },
            "directMax" : {
              "type" : "integer"
            },
            "directUsed" : {
              "type" : "integer"
            },
            "garbageCollectors" : {
              "type" : "array",
              "items" : {
                "type" : "object",
                "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo",
                "properties" : {
                  "count" : {
                    "type" : "integer"
                  },
                  "name" : {
                    "type" : "string"
                  },
                  "time" : {
                    "type" : "integer"
                  }
                }
              }
            },
            "heapCommitted" : {
              "type" : "integer"
            },
            "heapMax" : {
              "type" : "integer"
            },
            "heapUsed" : {
              "type" : "integer"
            },
            "mappedCount" : {
              "type" : "integer"
            },
            "mappedMax" : {
              "type" : "integer"
            },
            "mappedUsed" : {
              "type" : "integer"
            },
            "nettyShuffleMemoryAvailable" : {
              "type" : "integer"
            },
            "nettyShuffleMemorySegmentsAvailable" : {
              "type" : "integer"
            },
            "nettyShuffleMemorySegmentsTotal" : {
              "type" : "integer"
            },
            "nettyShuffleMemorySegmentsUsed" : {
              "type" : "integer"
            },
            "nettyShuffleMemoryTotal" : {
              "type" : "integer"
            },
            "nettyShuffleMemoryUsed" : {
              "type" : "integer"
            },
            "nonHeapCommitted" : {
              "type" : "integer"
            },
            "nonHeapMax" : {
              "type" : "integer"
            },
            "nonHeapUsed" : {
              "type" : "integer"
            }
          }
        },
        "path" : {
          "type" : "string"
        },
        "slotsNumber" : {
          "type" : "integer"
        },
        "timeSinceLastHeartbeat" : {
          "type" : "integer"
        },
        "totalResource" : {
          "type" : "object",
          "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo",
          "properties" : {
            "cpuCores" : {
              "type" : "number"
            },
            "extendedResources" : {
              "type" : "object",
              "additionalProperties" : {
                "type" : "number"
              }
            },
            "managedMemory" : {
              "type" : "integer"
            },
            "networkMemory" : {
              "type" : "integer"
            },
            "taskHeapMemory" : {
              "type" : "integer"
            },
            "taskOffHeapMemory" : {
              "type" : "integer"
            }
          }
        }
      }
    }

##### /taskmanagers/:taskmanagerid/logs

Verb: `GET` | Response code: `200 OK`
Returns the list of log files on a TaskManager.
Path parameters

- `taskmanagerid` - 32-character hexadecimal string that identifies a task manager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogListInfo",
      "properties" : {
        "logs" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:LogInfo",
            "properties" : {
              "mtime" : {
                "type" : "integer"
              },
              "name" : {
                "type" : "string"
              },
              "size" : {
                "type" : "integer"
              }
            }
          }
        }
      }
    }

##### /taskmanagers/:taskmanagerid/metrics

Verb: `GET` | Response code: `200 OK`
Provides access to task manager metrics.
Path parameters

- `taskmanagerid` - 32-character hexadecimal string that identifies a task manager.

Query parameters

- `get` (optional): Comma-separated list of string values to select specific metrics.

Request

    {}

Response

    {
      "type" : "any"
    }

##### /taskmanagers/:taskmanagerid/thread-dump

Verb: `GET` | Response code: `200 OK`
Returns the thread dump of the requested TaskManager.
Path parameters

- `taskmanagerid` - 32-character hexadecimal string that identifies a task manager.

Request

    {}

Response

    {
      "type" : "object",
      "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo",
      "properties" : {
        "threadInfos" : {
          "type" : "array",
          "items" : {
            "type" : "object",
            "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ThreadDumpInfo:ThreadInfo",
            "properties" : {
              "stringifiedThreadInfo" : {
                "type" : "string"
              },
              "threadName" : {
                "type" : "string"
              }
            }
          }
        }
      }
    }