REST APIs for Confluent Manager for Apache Flink

You can use the Confluent REST API to manage these resources for Confluent Manager for Apache Flink® (CMF):

  • Environments
  • Applications

In addition to the REST API, you can manage the above resources by using these Confluent tools:

Prerequisites

The REST API requires networked access to CMF.

As part of the installation process, a Kubernetes service is created that exposes CMF behind an outward-facing endpoint. By default, the service exposes CMF on port 8080.

If you have configured authentication and/or authorization, each API request must be authenticated and you need permissions on the respective resource.

For more information, see:

Endpoints (v1)

All endpoints are served under /cmf/api/v1.

Identifiers

All resources are identified by name. Each name must be unique in its scope and follow the following restrictions:

  • Minimum length: 4
  • Maximum length: 253
  • Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$

API reference

This section contains the REST API reference for Confluent Manager for Apache Flink®.

POST /environments

Create or update an Environment

Status Codes:
GET /environments

Retrieve a paginated list of all environments.

Query Parameters:
 
  • page (integer) – Zero-based page index (0..N)
  • size (integer) – The size of the page to be returned
  • sort (array) – Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Status Codes:
Response Headers:
 
  • ETag – An ID for this version of the response.
GET /environments/{envName}

Get/Describe an environment with the given name.

Parameters:
  • envName (string) – Name of the Environment to be retrieved.
Status Codes:
DELETE /environments/{envName}
Parameters:
  • envName (string) – Name of the Environment to be deleted.
Status Codes:
POST /environments/{envName}/applications

Creates a new Flink Application or updates an existing one in the given Environment.

Parameters:
  • envName (string) – Name of the Environment
Status Codes:
GET /environments/{envName}/applications

Retrieve a paginated list of all applications in the given Environment.

Parameters:
  • envName (string) – Name of the Environment
Query Parameters:
 
  • page (integer) – Zero-based page index (0..N)
  • size (integer) – The size of the page to be returned
  • sort (array) – Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Status Codes:
Response Headers:
 
  • ETag – An ID for this version of the response.
GET /environments/{envName}/applications/{appName}

Retrieve an Application of the given name in the given Environment.

Parameters:
  • envName (string) – Name of the Environment
  • appName (string) – Name of the Application
Status Codes:
Response Headers:
 
  • ETag – An ID for this version of the response.
DELETE /environments/{envName}/applications/{appName}

Deletes an Application of the given name in the given Environment.

Parameters:
  • envName (string) – Name of the Environment
  • appName (string) – Name of the Application
Status Codes:
POST /environments/{envName}/applications/{appName}/start

Starts an earlier submitted Flink Application

Parameters:
  • envName (string) – Name of the Environment
  • appName (string) – Name of the Application
Status Codes:
POST /environments/{envName}/applications/{appName}/suspend

Suspends an earlier started Flink Application

Parameters:
  • envName (string) – Name of the Environment
  • appName (string) – Name of the Application
Status Codes:

Related content