Provisioning API reference
This page describes the Provisioning API reference.
It will update the connections state and validate the configuration. If the validation fails, the state will not be updated.
Query parameters
validateOnlybooleanOptionalDefault:
It will only validate the request, not applying any actual change to the system.
falsevalidateConnectivitybooleanOptionalDefault:
It will try to connect to the configured service as part of the validation step.
trueBody
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
400
Bad request
application/json
put
PUT /api/v1/state/connections HTTP/1.1
Host:
Content-Type: multipart/form-data
Accept: */*
Content-Length: 4971
{
"provisioning": {
"kafka": [
{
"name": "kafka",
"version": 1,
"tags": [
"text"
],
"configuration": {
"protocol": {
"value": "PLAINTEXT"
},
"sslKeystore": {
"file": "text"
},
"sslKeystorePassword": {
"value": "text"
},
"sslKeyPassword": {
"value": "text"
},
"sslTruststorePassword": {
"value": "text"
},
"sslTruststore": {
"file": "text"
},
"saslJaasConfig": {
"value": "text"
},
"keytab": {
"file": "text"
},
"kafkaBootstrapServers": {
"value": [
"text"
]
},
"saslMechanism": {
"value": "text"
},
"metricsPort": {
"value": 1
},
"metricsUsername": {
"value": "text"
},
"metricsPassword": {
"value": "text"
},
"metricsSsl": {
"value": true
},
"metricsHttpSuffix": {
"value": "text"
},
"metricsHttpTimeout": {
"value": 1
},
"metricsType": {
"value": "AWS"
},
"additionalProperties": {
"value": {}
},
"metricsCustomUrlMappings": {
"value": {}
},
"metricsCustomPortMappings": {
"value": {}
}
}
}
],
"confluentSchemaRegistry": [
{
"name": "schema-registry",
"version": 1,
"tags": [
"text"
],
"configuration": {
"sslKeystore": {
"file": "text"
},
"sslKeystorePassword": {
"value": "password"
},
"sslKeyPassword": {
"value": "password"
},
"sslTruststorePassword": {
"value": "password"
},
"sslTruststore": {
"file": "text"
},
"schemaRegistryUrls": {
"value": [
"text"
]
},
"basicAuthCredentialsSource": {
"value": "password"
},
"basicAuthUserInfo": {
"value": "password"
},
"metricsType": {
"value": "JMX"
},
"metricsSsl": {
"value": true
},
"metricsUsername": {
"value": "text"
},
"metricsPassword": {
"value": "password"
},
"metricsPort": {
"value": 1
},
"additionalProperties": {
"value": {}
},
"metricsCustomUrlMappings": {
"value": {}
},
"metricsCustomPortMappings": {
"value": {}
},
"metricsHttpSuffix": {
"value": "text"
},
"metricsHttpTimeout": {
"value": 1
},
"username": {
"value": "text"
},
"password": {
"value": "password"
},
"hardDelete": {
"value": true
}
}
}
],
"elasticSearch": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"user": {
"value": "text"
},
"password": {
"value": "password"
},
"nodes": {
"value": [
"text"
]
}
}
}
],
"pagerDuty": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"integrationKey": {
"value": "text"
}
}
}
],
"datadog": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"site": {
"value": "EU"
},
"apiKey": {
"value": "text"
},
"applicationKey": {
"value": "text"
}
}
}
],
"slack": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"webhookUrl": {
"value": "text"
}
}
}
],
"alertManager": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"endpoints": {
"value": [
"text"
]
}
}
}
],
"webhook": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"host": {
"value": "text"
},
"port": {
"value": 1
},
"useHttps": {
"value": true
},
"creds": {
"value": [
"text"
]
}
}
}
],
"aws": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"authMode": {
"value": "Credentials Chain"
},
"accessKeyId": {
"value": "text"
},
"secretAccessKey": {
"value": "text"
},
"region": {
"value": "text"
},
"sessionToken": {
"value": "text"
}
}
}
],
"connect": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"workers": {
"value": [
"text"
]
},
"username": {
"value": "text"
},
"password": {
"value": "text"
},
"metricsSsl": {
"value": true
},
"metricsUsername": {
"value": "text"
},
"metricsPassword": {
"value": "text"
},
"metricsType": {
"value": "JMX"
},
"metricsPort": {
"value": 1
},
"aes256Key": {
"value": "text"
},
"sslAlgorithm": {
"value": "text"
},
"sslKeystore": {
"file": "text"
},
"sslKeystorePassword": {
"value": "text"
},
"sslKeyPassword": {
"value": "text"
},
"sslTruststorePassword": {
"value": "text"
},
"sslTruststore": {
"file": "text"
},
"metricsCustomUrlMappings": {
"value": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
},
"metricsCustomPortMappings": {
"value": {
"ANY_ADDITIONAL_PROPERTY": 1
}
},
"metricsHttpSuffix": {
"value": "text"
},
"metricsHttpTimeout": {
"value": 1
}
}
}
],
"awsGlueSchemaRegistry": [
{
"name": "schema-registry",
"version": 1,
"tags": [
"text"
],
"configuration": {
"authMode": {
"reference": "text"
},
"accessKeyId": {
"reference": "text"
},
"secretAccessKey": {
"reference": "text"
},
"sessionToken": {
"value": "text"
},
"glueRegistryArn": {
"value": "text"
},
"glueRegistryCacheTtl": {
"value": 1
},
"glueRegistryCacheSize": {
"value": 1
},
"schemaRegistryFlavour": {
"value": "text"
},
"glueRegistryDefaultCompatibility": {
"value": "BACKWARD"
}
}
}
],
"zookeeper": [
{
"name": "zookeeper",
"version": 1,
"tags": [
"text"
],
"configuration": {
"zookeeperUrls": {
"value": [
"text"
]
},
"zookeeperChrootPath": {
"value": "text"
},
"zookeeperSessionTimeout": {
"value": 1
},
"zookeeperConnectionTimeout": {
"value": 1
},
"metricsType": {
"value": "JMX"
},
"metricsPort": {
"value": 1
},
"metricsUsername": {
"value": "text"
},
"metricsPassword": {
"value": "text"
},
"metricsSsl": {
"value": true
},
"metricsHttpSuffix": {
"value": "text"
},
"metricsHttpTimeout": {
"value": 1
},
"metricsCustomUrlMappings": {
"value": {}
},
"metricsCustomPortMappings": {
"value": {}
}
}
}
],
"postgres": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"host": {
"value": "text"
},
"port": {
"value": 1
},
"database": {
"value": "text"
},
"username": {
"value": "text"
},
"password": {
"value": "text"
},
"sslMode": {
"value": "allow"
}
}
}
],
"splunk": [
{
"name": "text",
"version": 1,
"tags": [
"text"
],
"configuration": {
"host": {
"value": "text"
},
"port": {
"value": 1
},
"useHttps": {
"value": true
},
"insecure": {
"value": true
},
"token": {
"value": "text"
}
}
}
],
"kerberos": [
{
"name": "kerberos",
"version": 1,
"tags": [
"text"
],
"configuration": {
"kerberosKrb5": {
"file": "text"
}
}
}
]
},
"attachedFile": "binary"
}{
"updated": [
"text"
],
"created": [
"text"
],
"deleted": [
"text"
]
}Responses
200
Successful retrieval of system state
application/json
get
GET /api/v1/state HTTP/1.1
Host:
Accept: */*
200
Successful retrieval of system 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"
]
}
]
}
}Body
sourcestringOptional
clientIdstringOptional
detailsstringOptional
keystringOptional
Responses
200
License successfully updated and current license info returned
application/json
400
Bad request
application/json
put
PUT /api/v1/state/license HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"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
}Last updated
Was this helpful?