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

multipart/form-data

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

200400

Successfully updated connection state

Body

application/json

updatedarray of Referenceable (string)

createdarray of Referenceable (string)

deletedarray of Referenceable (string)

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/state/connections', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "updated": [
    "text"
  ],
  "created": [
    "text"
  ],
  "deleted": [
    "text"
  ]
}