Quick Start

Ververica's API is a REST interface that lets you provision, operate, and observe Apache Flink workloads at scale. This API specification defines standardized, machine-readable interfaces for key platform operations. It enables:

• Integration with CI/CD pipelines, observability tools, and external orchestration systems
• Automated tooling and SDK generation to accelerate developer onboarding
• Consistent interaction patterns across environments, improving reliability and maintainability

Use this reference documentation to understand the available endpoints, how to authenticate, and how to automate key actions across your Ververica environment. It's your go-to resource for integrating with and extending the Ververica Unified Streaming Data Platform via API.

Supported Deployment Options

Use this table to check whether the Ververica Unified Streaming Data Platform REST API applies to your deployment setup.

Notes:

• The REST endpoints described in the tutorial and in the OpenAPI files (/api/v1/… and /api/v2/…) are supported only for the two Ververica Unified Streaming Data Platform deployment models marked with a ✅ in the table above.
• For Ververica Platform: Self-Managed deployments, refer to the separate API guide.

Get Started

It only takes a few steps to start using the Ververica REST API: create an account, generate an access token, and authenticate your API requests. Let's get started.

1. Create a Ververica Unified Streaming Data Platform account. Go to https://app.ververica.cloud/ and complete the sign-up process.
2. Generate an access token. Use the endpoint: POST /api/v1/auth/tokens. Provide your credentials, social-login, or refresh token flow.
3. Authenticate your API requests. Pass the token as Authorization: Bearer <accessToken> in the Authorization header of every API call.