Home
ProductsDownload Community Edition

Provisioning API Spec

Update Lenses connections state.

put

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

Query parameters
validateOnlyboolean · default: falseoptional

It will only validate the request, not applying any actual change to the system.

validateConnectivityboolean · default: trueoptional

It will try to connect to the configured service as part of the validation step.

Body
provisioningobjectoptional

Configuration in YAML format representing the connections state.

attachedFilestring · binaryoptional

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

Responses
curl -L \
  --request PUT \
  --url '/api/v1/state/connections' \
  --header 'Content-Type: multipart/form-data' \
  --form 'provisioning=[object Object]' \
  --form 'attachedFile=binary'
{
  "updated": [
    "text"
  ],
  "created": [
    "text"
  ],
  "deleted": [
    "text"
  ]
}

Successfully updated connection state

Retrieve system state

get
Responses
curl -L \
  --url '/api/v1/state'
{
  "license": {
    "maxBrokers": 1,
    "expiry": 1,
    "clientId": "text",
    "isRespected": true,
    "status": "Valid",
    "message": "text"
  },
  "connections": {
    "kafka": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "confluentSchemaRegistry": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "elasticSearch": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "pagerDuty": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "datadog": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "slack": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "alertManager": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "webhook": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "aws": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "connect": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "awsGlueSchemaRegistry": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "zookeeper": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "postgres": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "splunk": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ],
    "kerberos": [
      {
        "name": "text",
        "version": 1,
        "tags": [
          "text"
        ]
      }
    ]
  }
}

Successful retrieval of system state

Update the license data

put
Body
sourcestringoptional
clientIdstringoptional
detailsstringoptional
keystringoptional
Responses
curl -L \
  --request PUT \
  --url '/api/v1/state/license' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": "text",
    "clientId": "text",
    "details": "text",
    "key": "text"
  }'
{
  "maxBrokers": 1,
  "expiry": 1,
  "clientId": "text",
  "isRespected": true,
  "status": "Valid",
  "message": "text",
  "settings": {
    "security": {
      "root": {
        "enabled": true
      },
      "basic": {
        "enabled": true
      },
      "ldap": {
        "enabled": true
      },
      "kerberos": {
        "enabled": true
      },
      "custom": {
        "enabled": true
      },
      "sso": {
        "enabled": true
      },
      "serviceAccount": {
        "enabled": true,
        "restriction": {
          "name": "None"
        }
      }
    },
    "sql": {
      "streaming": {
        "enabled": true,
        "restriction": {
          "name": "None"
        }
      },
      "sql": {
        "enabled": true
      }
    },
    "kafkaSettings": {
      "acls": true,
      "quotas": true,
      "consumerOffsetManagement": true
    },
    "audit": {
      "enabled": true,
      "integration": true
    },
    "connections": {
      "enabled": true
    },
    "application": {
      "topology": true,
      "connectorsOnKubernetes": true
    },
    "approval": {
      "enabled": true
    },
    "alerts": {
      "enabled": true,
      "rules": {
        "name": "None"
      },
      "integration": {
        "enabled": true,
        "channels": [
          "text"
        ],
        "max": {
          "name": "None"
        }
      }
    },
    "data": {
      "masking": true,
      "customSerde": true,
      "sla": true,
      "namespace": {
        "enabled": true,
        "max": {
          "name": "None"
        }
      }
    },
    "backup": {
      "enabled": true
    }
  },
  "currentTime": 1
}

License successfully updated and current license info returned

PreviousWebsocket Spec

Last updated

Was this helpful?