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.

put

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

Query parameters
validateOnlybooleanOptional

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

Default: false
validateConnectivitybooleanOptional

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

Default: true
Body
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
200

Successfully updated connection state

application/json
put
/api/v1/state/connections

Retrieve system state

get
Responses
200

Successful retrieval of system state

application/json
get
/api/v1/state
200

Successful retrieval of system state

Update the license data

put
Body
sourcestringOptional
clientIdstringOptional
detailsstringOptional
keystringOptional
Responses
200

License successfully updated and current license info returned

application/json
put
/api/v1/state/license

Last updated

Was this helpful?