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

cURL

CLOUD_PLATFORM_CREDENTIALS Environment Override

curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/projects/{projectId}/connections/environment-overrides \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environmentName": "PROD",
  "connectionName": "my-aws-connection",
  "authType": "CLOUD_PROVIDER_SECRET",
  "connectionOverrides": {
    "secretsLocation": {
      "type": "AWS_SECRET_MANAGER",
      "region": "us-east-1"
    },
    "connectionProperties": {
      "credentialSecretName": "prod-aws-platform-credentials"
    }
  }
}
'

201

CLOUD_PLATFORM_CREDENTIALS Environment Override Response

{
  "name": "my-aws-connection",
  "platformConnectionType": "CLOUD_PLATFORM_CREDENTIALS",
  "authProvider": "aws",
  "authType": "CLOUD_PROVIDER_SECRET",
  "createdBy": "550e8400-e29b-41d4-a716-446655440001",
  "createdDate": "2024-01-15T10:30:00.123Z",
  "projectId": "550e8400-e29b-41d4-a716-446655440002",
  "connectionOverrides": {
    "secretsLocation": {
      "type": "AWS_SECRET_MANAGER",
      "region": "us-east-1"
    },
    "connectionProperties": {
      "credentialSecretName": "prod-aws-platform-credentials"
    }
  }
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

projectId · string · required

The unique identifier of the project containing the connection

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

Create a new environment connection override. Returns 409 Conflict if the override already exists — use the PUT endpoint to update.

Provide environmentName and connectionName to identify the override, plus the type-specific fields inside connectionOverrides. The combinations of platformConnectionType, authProvider and authType follow the same rules as the main create-connection request — see the combinations table on POST /v1/projects/{projectId}/connections.

The environment override request containing all necessary details

authType · enum<string> · required

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.

Available options: GENERIC_SECRET, CLOUD_PROVIDER_SECRET, OAUTH_USER_TOKENS, OAUTH_AUTHORIZATION_CODE, OAUTH_CLIENT_CRED, COMPOSITE_TOKEN, OAUTH_1_0_X_ADS

Example:

"OAUTH_CLIENT_CRED"

connectionName · string · required

The name of the connection to override

Minimum string length: 1

Example:

"Salesforce"

environmentName · string · required

The name of the environment to apply the override in

Minimum string length: 1

Example:

"PROD"

connectionOverrides · object

Connection override configuration

Show child attributes

Response

201

application/json

Environment connection override created successfully

authProvider · string

The authentication provider

Example:

"NONE"

authType · enum<string>

The authentication type

Available options: GENERIC_SECRET, CLOUD_PROVIDER_SECRET, OAUTH_USER_TOKENS, OAUTH_AUTHORIZATION_CODE, OAUTH_CLIENT_CRED

Example:

"GENERIC_SECRET"

connectionOverrides · object

Connection override configuration

Show child attributes

createdBy · string

The user who created the connection

createdDate · string<date-time>

The date and time when the connection was created

name · string

The name of the connection

Example:

"my-jira-connection"

platformConnectionType · enum<string>

The platform connection type

Available options: DWH, COMPONENT_BASIC, CLOUD_PLATFORM_CREDENTIALS

Example:

"COMPONENT_BASIC"

projectId · string<uuid>

The project ID this connection belongs to