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"
  ]
}

Retrieve system state

GET/api/v1/state

Response

200

Successful retrieval of system state

Body

application/json

licenseLicenseState (object)

connectionsobject

Request

JavaScriptCurlPython

const response = await fetch('/api/v1/state', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update the license data

PUT/api/v1/state/license

Body

application/json

sourcestring

clientIdstring

detailsstring

keystring

Response

200400

License successfully updated and current license info returned

Body

application/json

maxBrokersnullable integer

expirynullable integer (int64)

clientIdnullable string

isRespectedboolean

statusLicenseStatusSummary (enum)

ValidExpiredBrokersExceededNoLicense

messagenullable string

settingsLicenseSettings (object)

currentTimeinteger (int64)

Request

JavaScriptCurlPython

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

Response

200400

{
  "clientId": "text",
  "isRespected": false,
  "status": "Valid",
  "message": "text",
  "settings": {
    "security": {
      "root": {
        "enabled": false
      },
      "basic": {
        "enabled": false
      },
      "ldap": {
        "enabled": false
      },
      "kerberos": {
        "enabled": false
      },
      "custom": {
        "enabled": false
      },
      "sso": {
        "enabled": false
      },
      "serviceAccount": {
        "enabled": false,
        "restriction": {
          "name": "None"
        }
      }
    },
    "sql": {
      "streaming": {
        "enabled": false,
        "restriction": {
          "name": "None"
        }
      },
      "sql": {
        "enabled": false
      }
    },
    "kafkaSettings": {
      "acls": false,
      "quotas": false,
      "consumerOffsetManagement": false
    },
    "audit": {
      "enabled": false,
      "integration": false
    },
    "connections": {
      "enabled": false
    },
    "application": {
      "topology": false,
      "connectorsOnKubernetes": false
    },
    "approval": {
      "enabled": false
    },
    "alerts": {
      "enabled": false,
      "rules": {
        "name": "None"
      },
      "integration": {
        "enabled": false,
        "channels": [
          "text"
        ],
        "max": {
          "name": "None"
        }
      }
    },
    "data": {
      "masking": false,
      "customSerde": false,
      "sla": false,
      "namespace": {
        "enabled": false,
        "max": {
          "name": "None"
        }
      }
    },
    "backup": {
      "enabled": false
    }
  }
}