Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Connections

Update an existing project connection by name.

Performs a full replacement of the connection details. Any fields not included in the update request will be unset.

put/v1/projects/{projectId}/connections

Path parameters

projectIdstring required

The unique identifier of the project containing the connection to update.

Query parameters

connectionNamestring required

The name of the connection to update.

Request body

authType'GENERIC_SECRET' | 'CLOUD_PROVIDER_SECRET' | 'OAUTH_USER_TOKENS' | 'OAUTH_AUTHORIZATION_CODE' | 'OAUTH_CLIENT_CRED' | 'COMPOSITE_TOKEN' | 'OAUTH_1_0_X_ADS' required

The kind of secret being referenced. See the combinations table in the operation description for valid values per connection type.

platformConnectionType'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS' required

The different types of connection that can be created:

  • COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
  • CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, GCP) using cloud credentials stored in your secrets manager.

Example request

{
  "authType": "GENERIC_SECRET",
  "connectionDetails": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "platformConnectionType": "COMPONENT_BASIC"
}

Response

Successfully updated the project connection

authProviderstring

The authentication provider

authType'GENERIC_SECRET' | 'CLOUD_PROVIDER_SECRET' | 'OAUTH_USER_TOKENS' | 'OAUTH_AUTHORIZATION_CODE' | 'OAUTH_CLIENT_CRED' | 'COMPOSITE_TOKEN' | 'OAUTH_1_0_X_ADS'

The authentication type

createdBystring

The user who created the connection

createdDatestring date-time

The date and time when the connection was created

namestring

The name of the connection

platformConnectionType'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS'

The different types of connection that can be created:

  • COMPONENT_BASIC — connect a component to a data source, API, or SaaS application using a secret stored in your secrets manager.
  • CLOUD_PLATFORM_CREDENTIALS — give a project access to a cloud provider (AWS, Azure, GCP) using cloud credentials stored in your secrets manager.
projectIdstring uuid

The project ID this connection belongs to

Example response

{
  "authProvider": "salesforce",
  "authType": "GENERIC_SECRET",
  "connectionDetails": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "name": "my-secret",
  "platformConnectionType": "COMPONENT_BASIC"
}