Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Configuration Connections Batch

POST/api/v2/connectivity/connections/getConfigurationBatch

Returns a map of Connection RIDs to their corresponding configurations. Connections are filtered from the response if they don't exist or the requesting token lacks the required permissions.

The maximum batch size for this endpoint is 200.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-connection-read.

Request body

body
list<GetConfigurationConnectionsBatchRequestElement>
Hide child attributes

Hide child attributes

GetConfigurationConnectionsBatchRequestElement
object
Show child attributes

Show child attributes

Response body

GetConfigurationConnectionsBatchResponse
object
Hide child attributes

Hide child attributes

data
map<ConnectionRid, ConnectionConfiguration>
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/connectivity/connections/getConfigurationBatch" \ -d '[{"connectionRid":"ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"}]'

Response

Copied!
1 2 3 4 5 6 7 8 9 { "data": { "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b": { "type": "jdbc", "url": "jdbc:postgresql://localhost:5432/test", "driverClass": "org.postgresql.Driver" } } }