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.
Updates the secrets on the connection to the specified secret values. Secrets that are currently configured on the connection but are omitted in the request will remain unchanged.
Secrets 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.
stringThe Resource Identifier (RID) of a Connection (also known as a source).
objectmap<SecretName, PlaintextValue>The secrets to be updated. The specified secret names must already be configured on the connection.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/updateSecrets?preview=true" \
-d '{"secrets":{"Password":"MySecretPassword"}}'| Error Name | ||
|---|---|---|
Update | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not updateSecrets the Connection. | |
| Parameters | connectionRid | |
See Errors for a general overview of errors in the platform.