Provisioning API reference

This page describes the Provisioning API reference.

For the options for each connection see the Schema /Object of the PUT call.

Update Lenses connections state.

It will update the connections state and validate the configuration. If the validation fails, the state will not be updated.

PUT/api/v1/state/connections

Query parameters

Body

provisioningUpdateConnectionStateAPIRequest (object)

Configuration in YAML format representing the connections state.

attachedFilestring (binary)

Attached file(s) needed for establishing the connection. The name of each file part is used as a reference in the manifest.

Response

Successfully updated connection state

Body

updatedarray of Referenceable (string)

createdarray of Referenceable (string)

deletedarray of Referenceable (string)

Request

Response

Retrieve system state

GET/api/v1/state

Response

Successful retrieval of system state

Body

licenseLicenseState (object)

connectionsobject

Request

Response

Update the license data

PUT/api/v1/state/license

Body

sourcestring

clientIdstring

detailsstring

keystring

Response

License successfully updated and current license info returned

Body

maxBrokersnullable integer

expirynullable integer (int64)

clientIdnullable string

isRespectedboolean

statusLicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagenullable string

settingsLicenseSettings (object)

currentTimeinteger (int64)

Request

Response

PreviousJMX Metrics NextCLI Import & Export

Last updated 5 months ago

{ "license": { "maxBrokers": 0, "expiry": 0, "clientId": "text", "isRespected": false, "status": "Valid", "message": "text" }, "connections": { "kafka": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "confluentSchemaRegistry": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "elasticSearch": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "pagerDuty": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "datadog": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "slack": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "alertManager": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "webhook": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "aws": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "connect": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "awsGlueSchemaRegistry": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "zookeeper": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "postgres": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "splunk": [ { "name": "text", "version": 0, "tags": [ "text" ] } ], "kerberos": [ { "name": "text", "version": 0, "tags": [ "text" ] } ] } }