Skip to main content

List Connections

GET /public/v1/connections​

Returns the connections the API key may see. Use the id of a connection wherever another request refers to a connection, for example when you create a pipe.

Secrets such as passwords, keystores and credentials are never part of the response.


Request​

The request has no parameters.

Example Request​

curl --location 'https://your-instance.com/public/v1/connections' \
--header 'Authorization: Bearer <your-api-key>'

Response​

HTTP Status Code: 200 OK
Response Body: an array of connections.

FieldTypeDescription
idintegerID of the connection
namestringDisplay name
typestringKAFKA or KINESIS
addressstringBootstrap servers of a Kafka connection. Empty for other connection types.
enabledbooleanWhether the connection can be used with the current license
[
{
"id": 1,
"name": "production",
"type": "KAFKA",
"address": "broker-1.example.com:9092,broker-2.example.com:9092",
"enabled": true
},
{
"id": 2,
"name": "staging",
"type": "KAFKA",
"address": "staging-broker.example.com:9092",
"enabled": true
}
]

Possible Errors​

Status CodeDescriptionSolution
401UnauthorizedCheck your API key

Best Practices​

  • A key only lists the connections its roles give access to. An empty array means the key is valid but has no access to any connection.
  • Match connections by their address, not by their name: names can be changed in the Kadeck UI.