This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the Connection with the specified rid.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-connection-read.
stringThe Resource Identifier (RID) of a Connection (also known as a source).
objectstringThe Resource Identifier (RID) of a Connection (also known as a source).
stringThe unique resource identifier (RID) of a Folder.
stringThe display name of the Connection. The display name must not be blank.
union1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b?preview=true"1
2
3
4
5
6
7
8
9
10
{
"parentFolderRid": "ri.compass.main.folder.c410f510-2937-420e-8ea3-8c9bcb3c1791",
"configuration": {
"type": "jdbc",
"url": "jdbc:postgresql://localhost:5432/test",
"driverClass": "org.postgresql.Driver"
},
"displayName": "Connection to my external system",
"rid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"
}| Error Name | ||
|---|---|---|
Parent | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The parent folder for the specified connection could not be found. | |
| Parameters | connectionRid | |
Connection | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified connection is not yet supported in the Platform API. | |
| Parameters | connectionType | |
Connection | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Connection could not be found. | |
| Parameters | connectionRid | |
See Errors for a general overview of errors in the platform.