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.
Retrieves the ConnectionConfiguration of the Connection itself.
This operation is intended for use when other Connection data is not required, providing a lighter-weight alternative to getConnection operation.
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).
unionobjectThe configuration needed to connect to an AWS S3 external system (or any other S3-like external systems that implement the s3a protocol).
objectThe configuration needed to connect to a REST external system.
objectThe configuration needed to connect to a Snowflake database.
objectThe configuration needed to connect to an external system using the JDBC protocol.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/getConfiguration?preview=true"1
2
3
4
5
{
"type": "jdbc",
"url": "jdbc:postgresql://localhost:5432/test",
"driverClass": "org.postgresql.Driver"
}| Error Name | ||
|---|---|---|
Connection | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified connection is not yet supported in the Platform API. | |
| Parameters | connectionType | |
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not getConfiguration the Connection. | |
| Parameters | connectionRid | |
See Errors for a general overview of errors in the platform.