Ververica DocsVerverica Docs

Ververica Platform API

The Ververica Platform API

  • 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}/pod-scheduling — Get app-agent pod scheduling of a workspace
  • PUT /api/v1/workspaces/{workspace}/pod-scheduling — Replace app-agent pod scheduling of a workspace
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/deployments/{deploymentId}/events — listEvents
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/resource-queues/{resourceQueueName} — Get resource queue by name
  • PUT /api/v1/workspaces/{workspace}/namespaces/{namespace}/resource-queues/{resourceQueueName} — Update a resource queue
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/resource-queues/{resourceQueueName} — Delete a resource queue
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/resource-queues — List resource queues
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/resource-queues — Create resource queue
  • 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
  • PUT /api/v1/workspaces/{workspace}/namespaces/{namespace}/sessionclusters/{name} — Replace the session cluster
  • 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-versions — List engine versions of this workspace
  • GET /api/v2/workspaces/{workspace}/namespaces/{namespace}/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
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions — createWorkflowDefinition
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId} — Retrieves a workflow definition by its identifier within the given workspace and namespace. If `versionNumber` is provided, the specified version is returned; otherwise the service returns the default (typically the currently active) version.
  • PUT /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId} — Updates an existing workflow definition identified by `workflowDefinitionId`. The request body provides the updated workflow definition data, and the response returns the workflow definition as stored by the service after modification.
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId} — Deletes the workflow definition identified by `workflowDefinitionId` within the given workspace and namespace.
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/versions — Lists available versions for the specified workflow definition. The response provides version information for each available workflow definition version.
  • DELETE /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/versions/{versionNumber} — Deletes a specific version of a workflow definition. The `versionNumber` path parameter selects which version to remove.
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances — Lists workflow instances associated with the specified workflow definition.
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances/{workflowInstanceId} — Retrieves a single workflow instance by its identifier for the specified workflow definition. The response returns the workflow instance resource and its current state as tracked.
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances/{workflowInstanceId}/node-instances
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances/{workflowInstanceId}/node-instances/{nodeInstanceId}/log — Retrieves log output for a specific node instance within a workflow instance. Log retrieval is paginated using `limit` (maximum number of lines to return) and `skipLineNum` (number of lines to skip from the beginning of the log stream).
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances/{workflowInstanceId}/node-instances/{nodeInstanceId}:execute — Executes (or re-executes) a specific node instance within a workflow instance.
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}/workflow-instances:batchExecute — Executes workflow instances in batch for the specified workflow definition.
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}:release — Releaser or unreleases the specified workflow definition. Only in released state will the workflow will be scheduled to run. The `releaseState` query parameter indicates the target state to apply, and the response returns the workflow definition as stored by the service after the state change.
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}:switchVersion — Switches the workflow definition to use the specified version number. The `versionNumber` query parameter selects which version should be made effective.
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/{workflowDefinitionId}:trigger — Triggers manual execution of the specified workflow definition.
  • POST /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/generate-node-definition-id
  • GET /api/v1/workspaces/{workspace}/namespaces/{namespace}/workflow-definitions/light — Returns a lightweight list of workflow definitions for the specified namespace. This endpoint is intended for listing and discovery use-cases and may return a reduced representation compared to the full workflow definition resource.
  • POST /api/v1/organizations
  • GET /api/v1/organizations/all
  • GET /api/v1/organizations/domain-availability
  • POST /api/v1/organizations/sso/generate-properties — Generate SSO properties for an organization that has not been persisted yet. Validates the requested name and slug do not collide with an existing organization. Nothing is persisted.
  • GET /api/v1/organizations/{organizationId}
  • PUT /api/v1/organizations/{organizationId}
  • GET /api/v1/organizations/{organizationId}/audit — Get the audit log status for an organization
  • POST /api/v1/organizations/{organizationId}/audit/backfill — Stream a bounded backfill of audit log events for an organization
  • POST /api/v1/organizations/{organizationId}/audit/disable — Disable audit logging for an organization
  • POST /api/v1/organizations/{organizationId}/audit/enable — Enable audit logging for an organization
  • GET /api/v1/organizations/{organizationId}/audit/key — Get the audit log encryption public key for an organization
  • POST /api/v1/organizations/{organizationId}/audit/key — Register or update the audit log encryption public key for an organization
  • DELETE /api/v1/organizations/{organizationId}/audit/key — Delete the audit log encryption public key for an organization
  • GET /api/v1/organizations/{organizationId}/audit/live — Stream live audit log events for an organization
  • GET /api/v1/organizations/{organizationId}/billing/billing-plans — List billing plans available to the organization
  • GET /api/v1/organizations/{organizationId}/billing/payment-system-info — Get organization payment system info
  • GET /api/v1/organizations/{organizationId}/domains
  • POST /api/v1/organizations/{organizationId}/domains
  • GET /api/v1/organizations/{organizationId}/domains/{domainId}
  • DELETE /api/v1/organizations/{organizationId}/domains/{domainId}
  • POST /api/v1/organizations/{organizationId}/domains/{domainId}/regenerate-token
  • GET /api/v1/organizations/{organizationId}/guests
  • DELETE /api/v1/organizations/{organizationId}/guests
  • GET /api/v1/organizations/{organizationId}/logo
  • POST /api/v1/organizations/{organizationId}/logo
  • GET /api/v1/organizations/{organizationId}/logo/url
  • GET /api/v1/organizations/{organizationId}/organization-teams
  • GET /api/v1/organizations/{organizationId}/setup-status — Aggregated onboarding setup status for the organisation: domain verification and SSO configuration/verification.
  • GET /api/v1/organizations/{organizationId}/sso — Get SSO Configurations belonging to an Organization
  • POST /api/v1/organizations/{organizationId}/sso/generate-properties — Generate SSO properties (ssoId, callbackUrl, and spEntityId for SAML) for the customer to register in their IdP. Nothing is persisted.
  • POST /api/v1/organizations/{organizationId}/sso/verify — Verify every not-yet-VERIFIED SSO config in the organisation (NONE and STALE configs). OIDC configs are checked by fetching their discovery document and asserting that required endpoints are present; SAML configs are checked by parsing the IdP metadata XML and asserting that a SingleSignOnService Location and at least one parseable X509 certificate are present. Configs that pass are persisted as VERIFIED and become eligible for SSO login; configs that fail keep their current state (NONE/STALE), and the failure reason is included in the response so the admin can fix the misconfiguration. Already-VERIFIED configs are skipped — the call is idempotent.
  • PUT /api/v1/organizations/{organizationId}/sso/{ssoId}/oidc
  • POST /api/v1/organizations/{organizationId}/sso/{ssoId}/oidc
  • DELETE /api/v1/organizations/{organizationId}/sso/{ssoId}/oidc
  • PUT /api/v1/organizations/{organizationId}/sso/{ssoId}/saml — Endpoint to update SAML SSO config
  • POST /api/v1/organizations/{organizationId}/sso/{ssoId}/saml — Create SAML SSO config
  • DELETE /api/v1/organizations/{organizationId}/sso/{ssoId}/saml — Delete a SAML SSO config
  • POST /api/v1/organizations/{organizationId}/sso/{ssoId}/saml/certificate — Setup SAML SSO config certificate
  • GET /api/v1/organizations/{organizationId}/teams
  • POST /api/v1/organizations/{organizationId}/teams
  • GET /api/v1/organizations/{organizationId}/teams/{teamId}
  • PUT /api/v1/organizations/{organizationId}/teams/{teamId}
  • DELETE /api/v1/organizations/{organizationId}/teams/{teamId}
  • GET /api/v1/organizations/{organizationId}/workspace-teams
  • GET /api/v1/organizations/{organizationId}/workspaces/{workspaceId}/team-access
  • POST /api/v1/organizations/{organizationId}/workspaces/{workspaceId}/team-access
  • DELETE /api/v1/organizations/{organizationId}/workspaces/{workspaceId}/team-access/{roleBindingId}
  • PATCH /api/v1/organizations/{organizationId}/workspaces/{workspaceId}/team-access/{roleBindingId}
  • GET /apitokens/v1/organizations/{organizationId}/apitokens
  • POST /apitokens/v1/organizations/{organizationId}/apitokens
  • DELETE /apitokens/v1/organizations/{organizationId}/apitokens/{tokenName}
  • GET /apitokens/v1/users/{userId}/apitokens
  • POST /apitokens/v1/users/{userId}/apitokens
  • DELETE /apitokens/v1/users/{userId}/apitokens/{tokenName}