Ververica DocsVerverica Docs

Ververica Unified Streaming Data Platform API

The REST interface for the Ververica Unified Streaming Data Platform that lets you provision, operate, and observe Apache Flink workloads at scale.

  • POST /api/v1/auth/tokens — Generate user access token
  • POST /api/v1/auth/passwordChangeRequests — Change user password
  • POST /api/v1/auth/passwordResetRequests — Reset password
  • POST /api/v1/auth/passwordSetRequests — Set password within sign up and forget password flows
  • GET /api/v1/workspaces — Get user workspaces
  • POST /api/v1/workspaces — Create user workspace
  • GET /api/v1/workspaces/{workspace} — Get single user workspace
  • DELETE /api/v1/workspaces/{workspace} — Delete user workspace
  • PATCH /api/v1/workspaces/{workspace} — Update existing user workspace
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployments/{deploymentId}/events — listEvents
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployment-targets — List all deployment targets
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployment-targets — Create a deployment target
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployment-targets/{name} — Get a deployment target by name
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployment-targets/{name} — Delete a deployment target
  • PATCH /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployment-targets/{name} — Update a deployment target
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters — List all session clusters
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters — Create a session cluster
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters/{name} — Get a session cluster by name
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters/{name} — Delete a session cluster
  • PATCH /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters/{name} — Update a session cluster
  • POST /api/v2/workspaces/{workspace}/namespaces/{namespace}/deployments — Create a deployment
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/deployments/ids — List deployment ids
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/deployments/{deploymentId} — Get a deployment by id
  • PUT /api/v2/workspaces/{workspace}/namespaces/{namespace}/deployments/{deploymentId} — Update a deployment
  • DELETE /api/v2/workspaces/{workspace}/namespaces/{namespace}/deployments/{deploymentId} — Delete a deployment
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/jobs — List jobs
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/jobs/{job} — Get a job by id
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/savepoints — List savepoints. Can be filtered by deploymentId, jobId and restoreStrategy.
  • POST /api/v2/workspaces/{workspace}/namespaces/{namespace}/savepoints — Create a new savepoint
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/savepoints/{savepoint} — Get a savepoint by id
  • DELETE /api/v2/workspaces/{workspace}/namespaces/{namespace}/savepoints/{savepoint} — Delete a savepoint by id
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:delete — Delete artifact
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:download — Download artifact
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:getMetadata — Get artifact metadata
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:list — List artifacts
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:saveMetadata — Save artifact metadata
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/artifacts:signature — Get signature to upload artifact
  • POST /api/v1/users — User sign up
  • GET /api/v1/users/{user} — Get user profile info
  • DELETE /api/v1/users/{user} — Delete a user profile
  • PATCH /api/v1/users/{user} — Update user profile info
  • POST /api/v2/workspaces/{workspace}/namespaces/{namespace}/jobs:start — Create and start a job with multiple start parameters
  • POST /api/v2/workspaces/{workspace}/namespaces/{namespace}/jobs/{job}:stop — Stop a job
  • GET /api/v2/workspaces/{workspace}/flink/engine-version-meta.json — List all engine versions
  • GET /api/v1/clusters — Get clusters for given user
  • POST /api/v1/clusters — Create cluster
  • GET /api/v1/clusters/{cluster} — Get cluster details
  • DELETE /api/v1/clusters/{cluster} — Delete a cluster
  • PATCH /api/v1/clusters/{cluster} — Partially update cluster
  • GET /api/v1/workspaces/billingPlans — Get available billing plans
  • GET /api/v1/workspaces/regions — Get available regions