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.
Creates a new Connection with a direct connection runtime.
Any secrets specified in the request body are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. They will stay in plaintext in memory until the garbage collection process cleans up the memory. The secrets are always stored encrypted on our servers. By using this endpoint, you acknowledge and accept any potential risks associated with the temporary in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should use the Foundry UI instead.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-connection-write.
objectstringThe unique resource identifier (RID) of a Folder.
unionstringThe display name of the Connection. The display name must not be blank.
unionThe worker of a Connection, which defines where compute for capabilities are run.
objectThe created Connection
stringThe 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.
objectunionThe worker of a Connection, which defines where compute for capabilities are run.
union1
2
3
4
5
curl -X POST \
\t-H "Content-type: application/json" \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections?preview=true" \
-d '{"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"}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"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",
"exportSettings": {
"exportsEnabled": true,
"exportEnabledWithoutMarkingsValidation": false
},
"rid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b"
}| Error Name | ||
|---|---|---|
Connection | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified connection is not yet supported in the Platform API. | |
| Parameters | connectionType | |
Property | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The specified property cannot be blank. | |
| Parameters | propertyName | |
Parent | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The parent folder for the specified connection could not be found. | |
| Parameters | connectionRid | |
Unknown | Error Code | INVALID_ARGUMENT |
| Status Code | 400 | |
| Description | The UnknownWorker cannot be used for creating or updating connections. Please use the Foundry worker instead. | |
| Parameters | | |
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the Connection. | |
| Parameters | | |
Folder | Error Code | NOT_FOUND |
| Status Code | 404 | |
| Description | The given Folder could not be found. | |
| Parameters | folderRid | |
See Errors for a general overview of errors in the platform.