Test a connection profile without saving it
POST
/api/v1/clusters/test
const url = 'http://localhost:8080/api/v1/clusters/test';const options = { method: 'POST', headers: { cookie: 'brokerium_session=<brokerium_session>', 'X-Brokerium-Request': '1', 'Content-Type': 'application/json' }, body: '{"name":"example","provider":"external","flavor":"apache","bootstrapServers":["example"],"security":{"protocol":"PLAINTEXT","saslMechanism":"","username":"example","tlsServerName":"example","tlsInsecureSkipVerify":true,"tlsCaCertPem":"example","awsRegion":"example"},"secrets":{"password":"example","tlsClientCertPem":"example","tlsClientKeyPem":"example","awsAccessKeyId":"example","awsSecretAccessKey":"example","awsSessionToken":"example","oauthToken":"example"},"labels":{"additionalProperty":"example"},"settings":{},"skipTest":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8080/api/v1/clusters/test \ --header 'Content-Type: application/json' \ --header 'X-Brokerium-Request: 1' \ --cookie brokerium_session=<brokerium_session> \ --data '{ "name": "example", "provider": "external", "flavor": "apache", "bootstrapServers": [ "example" ], "security": { "protocol": "PLAINTEXT", "saslMechanism": "", "username": "example", "tlsServerName": "example", "tlsInsecureSkipVerify": true, "tlsCaCertPem": "example", "awsRegion": "example" }, "secrets": { "password": "example", "tlsClientCertPem": "example", "tlsClientKeyPem": "example", "awsAccessKeyId": "example", "awsSecretAccessKey": "example", "awsSessionToken": "example", "oauthToken": "example" }, "labels": { "additionalProperty": "example" }, "settings": {}, "skipTest": true }'Role: operator.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”X-Brokerium-Request
required
string
Required on every non-GET request.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
provider
string
flavor
string
bootstrapServers
Array<string>
security
object
protocol
required
string
saslMechanism
string
username
string
tlsServerName
string
tlsInsecureSkipVerify
boolean
tlsCaCertPem
string
awsRegion
string
secrets
Write-only; stored encrypted and never returned.
object
password
string format: password
tlsClientCertPem
string
tlsClientKeyPem
string
awsAccessKeyId
string
awsSecretAccessKey
string
awsSessionToken
string
oauthToken
string
labels
object
key
additional properties
string
settings
object
skipTest
boolean
Responses
Section titled “Responses”Test result (also for failed connections).
Media typeapplication/json
object
ok
required
boolean
clusterId
string
brokers
required
integer
error
string
Example generated
{ "ok": true, "clusterId": "example", "brokers": 1, "error": "example"}Apache®, Apache Kafka® and Kafka® are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries. Brokerium is not affiliated with, endorsed by, or sponsored by the Apache Software Foundation.