v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB

Connections

Create an environment connection override

Creates a new environment-specific override for an existing project connection. If the override already exists, a 409 Conflict is returned. Use the PUT endpoint to update an existing override. The override's connection type is determined by the parent project connection.

post/v1/projects/{projectId}/connections/environment-overrides

Path parameters

projectIdstring required

The unique identifier of the project containing the connection

Request body

The kind of secret being referenced. Must match the parent project connection's authType. See the combinations table on POST /v1/projects/{projectId}/connections for valid values per connection type.

connectionNamestring required

The name of the connection to override

environmentNamestring required

The name of the environment to apply the override in

Example request

{
  "authType": "OAUTH_CLIENT_CRED",
  "connectionName": "Salesforce",
  "connectionOverrides": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "environmentName": "PROD"
}

Response

Environment connection override created successfully

authProviderstring

The authentication provider

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

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'DWH' | 'COMPONENT_BASIC' | 'CLOUD_PLATFORM_CREDENTIALS'

The platform connection type

projectIdstring uuid

The project ID this connection belongs to

Example response

{
  "authProvider": "NONE",
  "authType": "GENERIC_SECRET",
  "connectionOverrides": {
    "connectionProperties": {
      "credentialSecretName": "aws-platform-credentials"
    }
  },
  "name": "my-jira-connection",
  "platformConnectionType": "COMPONENT_BASIC"
}