Provisioning API

This page describes how to use the provisioning API

The Lenses Provisioning System allows you to manage Lenses connections declaratively through YAML manifests. It provides a GitOps-friendly approach to managing your Lenses infrastructure, enabling version control, automated deployments, and consistent configuration across environments.

Key Features

• Declarative Configuration: Define your entire Lenses infrastructure in YAML

• File Management: Upload and manage SSL certificates, keystores, and other binary files

• Validation: Comprehensive validation with detailed error messages

• Selective Updates: Update only specific connections without affecting others

• File Preservation: Existing files are preserved when not explicitly replaced

• Connectivity Testing: Optional connectivity validation for all connections

API Endpoints

File Upload

Files are uploaded as part of the multipart form data:

curl -X POST "https://lenses-server/api/v1/state/connections/upload" \
  -H "Authorization: Bearer your-token" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F "[email protected]"

File Preservation

When updating connections, existing files are preserved if not explicitly provided in the new request. This allows for selective updates without losing existing SSL certificates or other files.

file names must match the file names in the actual provisioning file

Upload Provisioning Manifest

Endpoint: POST /api/v1/state/connections/upload

Description: Uploads a complete provisioning manifest with files. This replaces the entire connection state.

Request: multipart/form-data

• provisioning: YAML manifest file

• Additional files: SSL certificates, keystores, etc.

Response: ProvisioningValidationResponse

POST /api/v1/state/connections/upload
Content-Type: multipart/form-data

--boundary
Content-Disposition: form-data; name="provisioning"; filename="provisioning.yaml"
Content-Type: text/plain

kafka:
  - name: my-kafka
    version: 1
    tags: ["production"]
    configuration:
      kafkaBootstrapServers:
        value: ["localhost:9092"]
      protocol:
        value: "PLAINTEXT"

--boundary
Content-Disposition: form-data; name="keystore.jks"; filename="keystore.jks"
Content-Type: application/octet-stream

[binary keystore content]
--boundary--

Validate Provisioning Manifest

Endpoint: POST /api/v1/state/connections/validate/upload

Description: Validates a provisioning manifest without applying changes (dry-run).

Request: Same as upload endpoint Response: ProvisioningValidationResponse

Get Current Provisioning State

Endpoint: GET /api/v1/state/connections

Description: Retrieves the current provisioning.yaml file contents.

Response: Raw YAML content